Update
A status update for a Jive user or place. In order to update the status of a Person you will have to first get the Person, update the status field and then update the person with the updated JSON.
Examples:
Example JSON
JSON including important fields and an Update's resources. See the tables below for a list of all fields and resources.
{ "type" : "update", "status" : "published", "subject" : "My new status", "parent" : "https://example.jiveon.com/api/core/v3/people/1", "content" : { "type" : "text/html", "text" : "<span>My new status</span>" }, "contentImages" : [ { "id" : "1055", "contentType" : "image/jpeg", "name" : "pic.jpeg", "ref" : "http://example.jiveon.com/api/core/v3/attachments/file/1055/data", "size" : 5953, "width" : 251, "height" : 201, "type" : "image" } ], "author" : { "name" : { "formatted" : "Administrator" }, "type" : "person", "displayName" : "Administrator", "id" : "1" }, "parentPlace" : { "name" : "Administrator", "id" : "1", "type" : "person", "uri" : "https://example.jiveon.com/api/core/v3/people/1", "html" : "https://example.jiveon.com/people/admin" }, "visibleToExternalContributors" : false, "highlightBody" : "My new <em class=\"jive-hilite\">status</em>", "highlightSubject" : "My new <em class=\"jive-hilite\">status</em>", "viewCount" : 0, "replyCount" : 0, "followerCount" : 1, "likeCount" : 0, "published" : "2012-07-13T23:26:49.669+0000", "updated" : "2012-07-13T23:26:49.669+0000", "tags" : [ ], "id" : "1012", "resources" : { "externalURLs" : { "allowed" : [ "GET" ], "ref" : "https://example.jiveon.com/api/core/v3/urls/contents/1051" }, "likes" : { "ref" : "https://example.jiveon.com/api/core/v3/contents/1251/likes", "allowed" : [ "GET" ] }, "self" : { "ref" : "https://example.jiveon.com/api/core/v3/contents/1251", "allowed" : [ "GET", "DELETE", "PUT" ] }, "html" : { "ref" : "https://example.jiveon.com/people/admin/status/1012", "allowed" : [ "GET" ] }, "followingIn" : { "ref" : "https://example.jiveon.com/api/core/v3/contents/1251/followingIn", "allowed" : [ "GET" ] }, "comments" : { "ref" : "https://example.jiveon.com/api/core/v3/contents/1251/comments", "allowed" : [ "GET", "POST" ] } } }
Creating a Status Update in a Place
POST to /contents creates a new status update. The minimum set of fields you must include are:
{ "content": { "type": "text/html", "text": "<body><p>Some interesting text</p></body>" }, "type": "update", "visibility": "place", "parent": "https://example.jiveon.com/api/core/v3/places/1234" }
Creating a Repost of a Status Update
POST to /contents creates a new status update. The minimum set of fields you must include for a repost are:
{ "content": { "type": "text/html", "text": "<body><p>Some interesting text of a repost</p></body>" }, "type": "update", "repost": "https://example.jiveon.com/api/core/v3/contents/1157" }
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 |
latitude | Number | read-only | If available, the latitude of the location from which this update was made. |
likeCount | Integer | read-only | Number of people who have liked this object. Availability:Will be present only for object types that support being liked. |
longitude | Number | read-only | If available, the longitude of the location from which this update was made. |
parent | String | read-only | URI of the person whose status is being updated. |
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. |
repost | Update | read-only | If this update is a repost, the |
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 | read-only | 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 of this object ("update"). 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 |
---|---|---|
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: |
externalURLs | GET | Return metadata about the external URLs attached to this status update. Retrieves: |
images | GET | Return metadata about the images attached to this status update. 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: |
followers | GET | Return a paginated list of the people following this content. Retrieves:Since: 3.5 |
followingIn | GET | Return the list of custom streams in which the requesting person is following this update (if any). Retrieves: |
html | GET | Return the HTML representation of this content object. |
likes | POST | Register that the requesting person likes this update. Availability:Must be authenticated, must not be your own update, and must not have liked this update already |
likes | GET | Return a paginated list of people who like this update. Retrieves: |
read | POST | Mark this update as having been read. Since: 3.2 |
read | DELETE | Mark this update as having not been read. Since: 3.2 |
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 content object. Retrieves: |
self | PUT | Update the information about this content object. Retrieves: |
self | DELETE | Delete this content object and any related comments and other related information. |
likes | DELETE | Delete the like of this update by the requesting person. Availability:Must be authenticated, and must have liked this update already |