File

An entity representing a file in Jive.

Example:
Example JSON

JSON including important fields and a File's resources. See the tables below for a list of all fields and resources.

{
  "type" : "file",
  "status" : "published",
  "subject" : "Social File",
  "content" : {
    "type" : "text/html",
    "text" : "<body><p>Look at this Excel doc. Let me know what you think.</p></body>"
  },
  "contentType" : "text/html",
  "name" : "file-name",
  "size" : "307284",
  "authorship" : "author",
  "authors" : [ {
    "name" : {
      "formatted" : "Administrator"
    },
    "type" : "person",
    "displayName" : "Administrator",
    "id" : "1"
  } ],
  "author" : {
    "name" : {
      "formatted" : "Administrator"
    },
    "type" : "person",
    "displayName" : "Administrator",
    "id" : "1"
  },
  "visibility" : "all",
  "visibleToExternalContributors" : false,
  "binaryURL" : "https://example.jiveon.com/servlet/JiveServlet/downloadBody/1431-102-1-1185/SimpleExcel.xlsx",
  "viewCount" : 1,
  "replyCount" : 0,
  "followerCount" : 0,
  "likeCount" : 0,
  "published" : "2012-07-12T21:26:05.532+0000",
  "updated" : "2012-07-12T21:26:05.915+0000",
  "tags" : [ "finance" ],
  "id" : "1431",
  "resources" : {
    "versions" : {
      "ref" : "https://example.jiveon.com/api/core/v3/versions/1246",
      "allowed" : [ "GET" ]
    },
    "likes" : {
      "ref" : "https://example.jiveon.com/api/core/v3/contents/1246/likes",
      "allowed" : [ "GET" ]
    },
    "self" : {
      "ref" : "https://example.jiveon.com/api/core/v3/contents/1246",
      "allowed" : [ "DELETE", "GET", "PUT" ]
    },
    "html" : {
      "ref" : "https://example.jiveon.com/docs/DOC-1431",
      "allowed" : [ "GET" ]
    },
    "followingIn" : {
      "ref" : "https://example.jiveon.com/api/core/v3/contents/1246/followingIn",
      "allowed" : [ "GET" ]
    },
    "comments" : {
      "ref" : "https://example.jiveon.com/api/core/v3/contents/1246/comments",
      "allowed" : [ "GET", "POST" ]
    }
  }
}

Fields

FieldTypeMode †Description
abuseCountIntegerread-only

Number of abuse reports associated with this content object.

authorPersonread-only

Author of this content object.

authorsPerson[]optional

List of people who are authors on this content. Authors are allowed to edit the content. This value is used only when authorship is limited.

authorshipStringoptionalThe authorship policy for this content.
  • open - anyone with appropriate permissions can edit the content. Default when visibility is place.
  • author - only the author can edit the content. Default when visibility is hidden or all.
  • limited - only those users specified by authors can edit the content. If authors was not specified then users will be used instead when visibility is people. Default when visibility is people.
binaryURLStringread-only

URL to retrieve the binary content of this file.

categoriesString[]optional

Categories associated with this object. Places define the list of possible categories.

contentContentBodyrequired

Content of this content object.

contentIDStringread-only

Internal Jive ID associated with the content.

contentImagesImage[]read-only

A list of Image objects providing metadata about images embedded within this content.

contentTypeStringread-only

The MIME type of this file.

Since: 3.1
contentVideosContentVideo[]read-only

A list of ContentVideo objects providing metadata about videos embedded within this content.

editingByPersonread-only

The person currently editing this document, meaning that it's locked. If not present, nobody is editing.

extendedAuthorsPerson[]optional

List of people who have been granted authorship on this content, who would normally not have access to it. Extended authors are allowed to edit the content. This value is used only when authorship is limited.

favoriteCountIntegerread-only

Number of people who have bookmarked this object.

Availability:

Will be present only for object types that support being bookmarked.

Since: 3.11
followerCountIntegerread-only

Number of people following this object.

Availability:

Will be present only for object types that support being followed.

highlightBodyStringread-only

Highlight snippet of a search match in the body or description.

Availability:

Will be present in search results only.

highlightSubjectStringread-only

Highlight snippet of a search match in the subject or name.

Availability:

Will be present in search results only.

highlightTagsStringread-only

Highlight snippet of a search match in tags.

Availability:

Will be present in search results only.

iconCssStringread-only

CSS Style to locate icon within sprite.

idStringread-only

Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive and should not be confused with contentID or placeID used in URIs.

lastActivityDateISO 8601 Dateread-only

Date and time when this had its last activity.

Since: 3.12
likeCountIntegerread-only

Number of people who have liked this object.

Availability:

Will be present only for object types that support being liked.

nameStringread-only

The filename of this file.

Since: 3.1
onBehalfOfOnBehalfOfoptional

Information that is available when the content was posted by the author on behalf of another person. This person may be an anonymous user, an unknown user with just an email address or another user of Jive.

Since: 3.12
outcomeCountsObjectread-only

Map of structured outcome type names that have been assigned to this content object, and a count of how many times they appear. For top level content objects like Discussion, Document, File, and Post, outcomes assigned to child comments and messages will also be included.

Availability:

Only available for content object types that support structured outcomes

Since: 3.3
outcomeTypeNamesString[]read-only

List of structured outcome type names that have been assigned to this content object. For top level content objects like Discussion, File, and Document, outcomes assigned to child comments and messages will also be included.

Availability:

Only available for content object types that support structured outcomes

Since: 3.3
outcomeTypesOutcomeType[]optional

A list of valid outcome types that can be set on this piece of content

parentStringoptional

URI of the parent place of this content object. When visibility is place then the URI points to a place (and is required on create). Otherwise, this field is not part of the returned JSON (and must not be included on create).

parentContentSummaryread-only

Summary information about the content object that is the parent of this object.

Availability:

Will be present in search results only.

parentContentVisibleBooleanread-only

Flag indicating that the content parent's contents are visible to the viewer.

parentPlaceSummaryread-only

Summary information about the place that contains this object.

Availability:

Will be present in search results only.

parentVisibleBooleanread-only

Flag indicating that the content parent is visible to the viewer.

publishedISO 8601 Dateread-only

Date and time when this content object was originally created.

replyCountIntegerread-only

Number of replies to this object.

Availability:

Will be present only for object types that support replies.

resourcesObjectread-only

Resource links (and related permissions for the requesting person) relevant to this object.

restrictCommentsBooleanoptional

Flag indicating that old comments will be visible but new comments are not allowed. If not restricted then anyone with appropriate permissions can comment on the content.

Since: 3.3
searchRankingsObjectread-only

A map of search result scores including social signals.

Availability:

Will be present in search results only.

sizeIntegerread-only

The size (in bytes) of this file.

Since: 3.1
statusStringread-only

The published status of this file.

  • incomplete - File is in draft mode
  • pending_approval - File is waiting for approval
  • rejected - File has been rejected for publication by an approver
  • published - File has been published
subjectStringoptional

Subject of this content object. If no subject is specified during creation then subject will default to the name of the file.

tagsString[]optional

Tags associated with this object.

Availability:

Will be present only for object types that support tags

typeStringrequired

The object type of this object ("file"). This field is required when creating new content.

updatedISO 8601 Dateread-only

Date and time this content object was most recently updated.

updatedOnBehalfOfOnBehalfOfoptional

Information that is available when the content was updated by the author on behalf of another person. This person may be an anonymous user, an unknown user with just an email address or another user of Jive.

Since: 3.12
updaterPersonread-only

The last person that updated this file. If not present, the last person to update this file was the person referenced in the author field.

Since: 3.12
usersPerson[]optionalThe list of users that can see the content. On create or update, provide a list of Person URIs or Person entities. On get, returns a list of Person entities. This value is used only when visibility is people.
versionIntegerread-onlyThe version of the document entity. Documents can have multiple versions and each time a document is updated the version field is incremented. This is not necessarily how many versions exist of a document but the specific version of the document which this entity represents.
Retrieves:
  • the version of the returned document entity. This is not necessarily how many versions exist of a document but the specific version of the document which this entity represents.
    • viaViaoptional

    Information that is available when the content was posted via an external system.

    Since: 3.12
    viewCountIntegerread-only

    Number of times this content object has been viewed.

    Availability:

    Will be present only for objects that support view counts

    visibilityStringoptional

    The visibility policy for this content object. Valid values are:

    • all - anyone with appropriate permissions can see the content. Default when visibility, parent and users were not specified.
    • hidden - only the author can see the content.
    • people - only those users specified by users can see the content. Default when visibility and parent were not specified but users was specified.
    • place - place permissions specify which users can see the content. Default when visibility was not specified but parent was specified.
    visibleToExternalContributorsBooleanread-only

    Flag indicating that this content object is potentially visible to external contributors.

    followedBooleanread-only

    Whether the current user is following this object.

    Availability:

    Will be present only for object types that support being followed.

    promotedResultBooleanread-only

    A boolean determining whether this search result is a promoted result

    Availability:

    Will be present in search results only.

    †
    → Fields used by update and create operations
    → Fields used only by create operations
    → Fields not used by update or create operations

    Resources

    ResourceMethodDescription
    childOutcomeTypesGET

    Return a paginated list of possible outcomes types on the content object's children.

    Retrieves:
  • OutcomeType[]
    • commentsPOST

    Add a comment about this content object.

    The minimum JSON object needed to create a comment is:

         {
         "content": {"type": "text/html", "text": "
    This is a new comment
    "},
     }
    Takes:
    Retrieves:
  • Comment representing the recorded comment
    • commentsGET

    Return a paginated list of the comments about this content object.

    Retrieves:
  • Comment[]
    • extpropsDELETE

    Deletes all extended properties for content.

    Availability:

    Content should be editable to caller.

    extpropsGET

    Returns extended properties for content.

    Availability:

    Content should be visible to caller.

    Retrieves:
  • ExtProps[]
    • extpropsPOST

    Creates extended properties for content.

     {
  "any prop name": "any val",
  "any prop2 name": "any val"
 }
    Availability:

    Content should be editable to caller.

    Retrieves:
  • ExtProps[]
    • followersGET

    Return a paginated list of the people following this content.

    Retrieves:
  • Person[]
    • Since: 3.5
    followingInGET

    Return the list of custom streams in which the requesting person is following this file (if any).

    Retrieves:
  • Stream[]
    • htmlGET

    Return the HTML representation of this content object.

    likesPOST

    Register that the requesting person likes this file.

    Availability:

    Must be authenticated, must not be your own file, and must not have liked this file already

    likesGET

    Return a paginated list of people who like this file.

    Retrieves:
  • Person[]
    • readPOST

    Mark this file as having been read.

    Since: 3.2
    readDELETE

    Mark this file as having not been read.

    Since: 3.2
    outcomesPOST

    Register that the requesting person created the outcome.

    Here is an example of a JSON with the minimum set of fields you must include: 

    {
  "outcomeType":
      {
          "id": 1
      }
}

    Availability:

    Must be authenticated, must not be able to read the content, and must not have the same outcome type on this comment already

    Takes:
    Retrieves:
  • Outcome Representation of the newly created outcome
    • outcomesGET

    Return a paginated list of outcomes on the content.

    Retrieves:
  • Outcome[]
    • outcomeTypesGET

    Return a paginated list of possible outcomes types on the content.

    Retrieves:
  • OutcomeType[]
    • selfGET

    Return an updated version of this content object.

    Retrieves:
  • Content describing this content object
    • selfPUT

    Update the information about this content object.

    Retrieves:
  • Content representing the updated content object
    • selfDELETE

    Delete this content object and any related comments and other related information.

    likesDELETE

    Delete the like of this file by the requesting person.

    Availability:

    Must be authenticated, and must have liked this file already

    versionsGET

    Return a paginated list of versions of this file.

    Retrieves:
  • ContentVersion