Interaction
Fields
Field | Type | Mode † | Description |
---|---|---|---|
abuseCount | Integer | read-only | Number of abuse reports associated with this content object. |
| Person | read-only | Author of this content object. |
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. |
contentVideos | ContentVideo[] | read-only | A list of ContentVideo objects providing metadata about videos embedded within this content. |
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. |
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. |
parent | String | required | URI of the parent place (or person, for personal content) of this content object. |
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. |
publishedCalendarDate | String | read-only | |
publishedTime | String | read-only | |
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. |
searchRankings | Object | read-only | A map of search result scores including social signals. Availability:Will be present in search results only. |
status | String | read-only | Published status of this content object.
|
subject | String | required | Subject of this content object. |
| String[] | optional | Tags associated with this object. Availability:Will be present only for object types that support tags |
type | String | required | The object type for this object ("comment"). This field is required when creating new content. |
updated | ISO 8601 Date | read-only | Date and time this content object was most recently updated. |
viewCount | Integer | read-only | Number of times this content object has been viewed. Availability:Will be present only for objects that support view counts |
visibleToExternalContributors | Boolean | read-only | Flag indicating that this content object is potentially visible to external contributors. |
followed | Boolean | read-only | Whether the current user is following this object. Availability:Will be present only for object types that support being followed. |
promotedResult | Boolean | read-only | A boolean determining whether this search result is a promoted result Availability:Will be present in search results only. |
Resources
Resource | Method | Description |
---|---|---|
participants | POST | Add a new participant to this Collaboration. |
childOutcomeTypes | GET | Return a paginated list of possible outcomes types on the content object's children. Retrieves: |
comments | POST | Add a comment about this content object. The minimum JSON object needed to create a comment is: { "content": {"type": "text/html", "text": " Takes:
Retrieves: |
comments | GET | Return a paginated list of the comments about this content object. Retrieves: |
extprops | DELETE | Deletes all extended properties for content. Availability:Content should be editable to caller. |
extprops | GET | Returns extended properties for content. Availability:Content should be visible to caller. Retrieves: |
extprops | POST | Creates extended properties for content. { "any prop name": "any val", "any prop2 name": "any val" } Availability:Content should be editable to caller. Retrieves: |
html | GET | Return the HTML representation of this collaboration. |
interactions | POST | Create a new interaction on this collaboration, and return a Interaction representing the new object. Takes:
Retrieves: |
interactions | GET | Returns interactions for this collaboration |
outcomes | POST | 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: |
outcomes | GET | Return a paginated list of outcomes on the content. Retrieves: |
outcomeTypes | GET | Return a paginated list of possible outcomes types on the content. Retrieves: |
self | GET | Return an updated version of this collaboration. Retrieves: |
self | PUT | |
self | DELETE | Delete this content object and any related comments and other related information. |
subject | POST | Sets the subject of this Collaboration. Takes:
Retrieves: |