osapi.jive.corev3.contents.Photo

Properties

Property	Type	Mode †	Description
`abuseCount`	`Integer`	read-only	↑ Number of abuse reports associated with this content object.
`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.
`banner`	`ContentBanner`	optional	↑
`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.
`contentID`	`String`	read-only	↑ Internal Jive ID associated with the content.
`contentImages`	`Image[]`	read-only	↑ A list of Image objects providing metadata about images embedded within this content.
`contentType`	`String`	read-only	↑ The MIME type of this file. Since: 3.1
`contentVideos`	`ContentVideo[]`	read-only	↑ A list of ContentVideo objects providing metadata about videos embedded within this content.
`editingBy`	`Person`	read-only	↑ The person currently editing this document, meaning that it's locked. If not present, nobody is editing.
`exif`	`Object`	read-only	↑
`extendedAuthors`	`Person[]`	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.
`favoriteCount`	`Integer`	read-only	↑ Number of people who have bookmarked this object. Availability: Will be present only for object types that support being bookmarked. Since: 3.11
`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.
`iconCss`	`String`	read-only	↑ CSS Style to locate icon within sprite.
`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.
`isFollowed`	`Boolean`	read-only	↑ Whether the current user is following this object. Availability: Will be present only for object types that support being followed.
`isPromotedResult`	`Boolean`	read-only	↑ A boolean determining whether this search result is a promoted result Availability: Will be present in search results only.
`lastActivityDate`	`ISO 8601 Date`	read-only	↑ Date and time when this had its last activity. Since: 3.12
`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 filename of this file. Since: 3.1
`onBehalfOf`	`OnBehalfOf`	optional	↑ 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
`outcomeCounts`	`Object`	read-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
`outcomeTypeNames`	`String[]`	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
`outcomeTypes`	`OutcomeType[]`	optional	↑ A list of valid outcome types that can be set on this piece of content
`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.
`parentContentVisible`	`Boolean`	read-only	↑ Flag indicating that the content parent's contents are visible to the viewer.
`parentPlace`	`Summary`	read-only	↑ Summary information about the place that contains this object. Availability: Will be present in search results only.
`parentVisible`	`Boolean`	read-only	↑ Flag indicating that the content parent is visible to the viewer.
`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.
`restrictComments`	`Boolean`	optional	↑ 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
`searchRankings`	`Object`	read-only	↑ A map of search result scores including social signals. Availability: Will be present in search results only.
`size`	`Integer`	read-only	↑ The size (in bytes) of this file. Since: 3.1
`status`	`String`	read-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
`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 ("photo"). This field is required when creating new content.
`typeCode`	`Integer`	read-only	↑
`updated`	`ISO 8601 Date`	read-only	↑ Date and time this content object was most recently updated.
`updatedOnBehalfOf`	`OnBehalfOf`	optional	↑ 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
`updater`	`Person`	read-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
`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.
`version`	`Integer`	read-only	↑ The 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.
`via`	`Via`	optional	↑ Information that is available when the content was posted via an external system. Since: 3.12
`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.

Methods

↑

createComment(comment,options)
POST /contents/1234/comments

Retrieves

Comment

Description

Add a comment about this content object.

The minimum JSON object needed to create a comment is:

     {
         "content": {"type": "text/html", "text": "<body><p>This is a new comment</p></body>"},
     }

Takes:

Comment describing the new comment

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Comment representing the recorded comment

↑

createExtProps(uriinfo,options)
POST /contents/1234/extprops

Retrieves

ExtProps[]

Description

Creates extended properties for content.

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

Availability:

Content should be editable to caller.

Options:

Name	Type	Required	Description
fields	String	false	Names of the fields to be returned

Retrieves:

ExtProps[]

↑

createOutcome(outcome,options)
POST /contents/1234/outcomes

Retrieves

Outcome

Description

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:

Outcome the outcome to be created.

Options:

Name	Type	Required	Description
fields	String	false	Names of the fields to be returned.

Retrieves:

Outcome Representation of the newly created outcome

↑

deleteExtProps()
DELETE /contents/1234/extprops

Retrieves

--

Description

Deletes all extended properties for content.

Availability:

Content should be editable to caller.

↑

destroy(options)
DELETE /contents/1234

Retrieves

--

Description

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

↑

get(options)
GET /contents/1234

Retrieves

Photo

Description

Return an updated version of this content object.

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Content describing this content object

↑

getChildOutcomeTypes(options)
GET /contents/1234/childOutcomeTypes

Retrieves

OutcomeType[]

Description

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

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of outcome types to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

OutcomeType[]

↑

getComments(options)
GET /contents/1234/comments

Retrieves

Comment[]

Description

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

Options:

Name	Type	Required	Description
outcomeType	String	false	The type name of outcomes to filter by.
count	Integer	false	The maximum number of comments to be returned (default is 25)
anchor	String	false	optional URI for a comment to anchor at. Specifying a anchor will try to return the page containing the anchor. If the anchor could not be found then the first page of comments will be returned.
excludeReplies	Boolean	false	Flag indicating that replies to the direct comments about this direct message should be excluded (default is false)
fields	String	false	The names of the fields to be returned
hierarchical	Boolean	false	Flag indicating that comments should be returned in hierarchical order instead of chronological order (default is true)
startIndex	Integer	false	Zero-relative index of the first comment to be returned (default is zero)

Retrieves:

Comment[]

↑

getExtProps(options)
GET /contents/1234/extprops

Retrieves

ExtProps

Description

Returns extended properties for content.

Availability:

Content should be visible to caller.

Options:

Name	Type	Required	Description
fields	String	false	Names of the fields to be returned

Retrieves:

ExtProps[]

↑

getFollowers(options)
GET /contents/1234/followers

Retrieves

Person[]

Description

Return a paginated list of the people following this content.

Options:

Name	Type	Required	Description
count	Integer	false	Number of followers to be returned (default is 25)
fields	String	false	Names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first follower to be returned

Retrieves:

Person[]

Since: 3.5

↑

getFollowingIn(options)
GET /contents/1234/followingIn

Retrieves

Stream[]

Description

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

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Stream[]

↑

getLikes(options)
GET /contents/1234/likes

Retrieves

Person[]

Description

Return a paginated list of people who like this file.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of people to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

Person[]

↑

getOutcomes(options)
GET /contents/1234/outcomes

Retrieves

Outcome[]

Description

Return a paginated list of outcomes on the content.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of outcomes to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

Outcome[]

↑

getOutcomeTypes(options)
GET /contents/1234/outcomeTypes

Retrieves

OutcomeType[]

Description

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

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of outcome types to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

OutcomeType[]

↑

getVersions(options)
GET /versions/1234

Retrieves

ContentVersion[]

Description

Return a paginated list of versions of this file.

Options:

Name	Type	Required	Description
count	Integer	false	The maximum number of people to return (default is 25)
fields	String	false	The names of the fields to be returned
startIndex	Integer	false	Zero-relative index of the first person to return (default is 0)

Retrieves:

ContentVersion

↑

like()
POST /contents/1234/likes

Retrieves

--

Description

Availability:

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

↑

markRead()
POST /contents/1234/read

Retrieves

--

Description

Mark this file as having been read.

Since: 3.2

↑

markUnread()
DELETE /contents/1234/read

Retrieves

--

Description

Mark this file as having not been read.

Since: 3.2

↑

toURI()

Retrieves

String

Description

Retrieves:

A URI representing this entity, or undefined if no such URI exists.

↑

unlike()
DELETE /contents/1234/likes

Retrieves

--

Description

Delete the like of this file by the requesting person.

Availability:

Must be authenticated, and must have liked this file already

↑

update(multipartbody,options)
PUT /contents/1234

Retrieves

Content

Description

Update the information about this content object.

Options:

Name	Type	Required	Description
fields	String	false	The names of the fields to be returned

Retrieves:

Content representing the updated content object

Resources

Resource	Method	Returns	Description
`html`	`GET`	`Object`	↑ Return the HTML representation of this content object.

osapi.jive.corev3.contents.Photo

Properties

Methods

Resources

Properties

Since: 3.1

Availability:

Since: 3.11

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Since: 3.12

Availability:

Since: 3.1

Since: 3.12

Availability:

Since: 3.3

Availability:

Since: 3.3

Availability:

Availability:

Availability:

Since: 3.3

Availability:

Since: 3.1

Availability:

Since: 3.12

Since: 3.12

Retrieves:

Since: 3.12

Availability:

Methods

Retrieves

Description

Takes:

Options:

Retrieves:

Retrieves

Description

Availability:

Options:

Retrieves:

Retrieves

Description

Availability:

Takes:

Options:

Retrieves:

Retrieves

Description

Availability:

Retrieves

Description

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Retrieves

Description

Availability:

Options:

Retrieves:

Retrieves

Description

Options:

Retrieves:

Since: 3.5

Retrieves

Description