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

Field	Type	Mode †	Description
`author`	`Person`	read-only	Author of this content object.
`authors`	`Person[]`	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.
`authorship`	`String`	optional	The 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.
`binaryURL`	`String`	read-only	URL to retrieve the binary content of this file.
`categories`	`String[]`	optional	Categories associated with this object. Places define the list of possible categories.
`content`	`ContentBody`	required	Content of this content object.
`contentType`	`String`	read-only	The mime type of this file. Since: 3.1
`followerCount`	`Integer`	read-only	Number of people following this object. Availability: Will be present only for object types that support being followed.
`highlightBody`	`String`	read-only	Highlight snippet of a search match in the body or description. Availability: Will be present in search results only.
`highlightSubject`	`String`	read-only	Highlight snippet of a search match in the subject or name. Availability: Will be present in search results only.
`highlightTags`	`String`	read-only	Highlight snippet of a search match in tags. Availability: Will be present in search results only.
`id`	`String`	read-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.
`likeCount`	`Integer`	read-only	Number of people who have liked this object. Availability: Will be present only for object types that support being liked.
`name`	`String`	read-only	The name of this file. Since: 3.1
`parent`	`String`	optional	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).
`parentContent`	`Summary`	read-only	Summary information about the content object that is the parent of this object. Availability: Will be present in search results only.
`parentPlace`	`Summary`	read-only	Summary information about the place that contains this object. Availability: Will be present in search results only.
`published`	`ISO 8601 Date`	read-only	Date and time when this content object was originally created.
`replyCount`	`Integer`	read-only	Number of replies to this object. Availability: Will be present only for object types that support replies.
`resources`	`Object`	read-only	Resource links (and related permissions for the requesting person) relevant to this object.
`size`	`Integer`	read-only	The size of this file Since: 3.1
`status`	`String`	read-only	State 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
`subject`	`String`	optional	Subject of this content object. If no subject is specified during creation then subject will default to the name of the file.
`tags`	`String[]`	optional	Tags associated with this object. Availability: Will be present only for object types that support tags
`type`	`String`	required	The object type of this object ("file"). This field is required when creating new content.
`updated`	`ISO 8601 Date`	read-only	Date and time this content object was most recently updated.
`users`	`Person[]`	optional	The 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.
`viewCount`	`Integer`	read-only	Number of times this content object has been viewed. Availability: Will be present only for objects that support view counts
`visibility`	`String`	optional	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.
`visibleToExternalContributors`	`Boolean`	read-only	Flag indicating that this content object is potentially visible to external contributors.

Resources

Resource	Method	Description
`comments`	`POST`	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: Comment describing the new comment Retrieves: Comment representing the recorded comment
`comments`	`GET`	Return a paginated list of the comments about this content object. Retrieves: Comment[]
`followers`	`GET`	Return a paginated list of the people following this content. Retrieves: Person[] Since: 3.5
`followingIn`	`GET`	Return the list of custom streams in which the requesting person is following this file (if any). Retrieves: Stream[]
`html`	`GET`	Return the HTML representation of this content object.
`likes`	`POST`	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
`likes`	`GET`	Return a paginated list of people who like this file. Retrieves: Person[]
`read`	`POST`	Mark this file as having been read. Since: 3.2
`read`	`DELETE`	Mark this file as having not been read. Since: 3.2
`self`	`GET`	Return an updated version of this content object. Retrieves: Content describing this content object
`self`	`PUT`	Update the information about this content object. Retrieves: Content representing the updated content object
`self`	`DELETE`	Delete this content object and any related comments and other related information.
`likes`	`DELETE`	Delete the like of this file by the requesting person. Availability: Must be authenticated, and must have liked this file already
`versions`	`GET`	Return a paginated list of versions of this file. Retrieves: ContentVersion

File

Example:

Example JSON

Fields

Since: 3.1

Availability:

Availability:

Availability:

Availability:

Availability:

Since: 3.1

Availability:

Availability:

Availability:

Since: 3.1

Availability:

Availability:

Resources

Takes:

Retrieves:

Retrieves:

Retrieves:

Since: 3.5

Retrieves:

Availability:

Retrieves:

Since: 3.2

Since: 3.2

Retrieves:

Retrieves:

Availability:

Retrieves: