Activity

An Activity represents an event that has occurred within a Jive instance. Activities are presented in the format defined by the OpenSocial Specification, which in turn extends the Activity Streams 1.0 specification. Activities are used for several different purposes within the Core API, which are described in more detail in Activity Use Cases.

Note that activities are not first-class objects and do not have URIs, so instead the URL of the object of the activity is given. In the following example, the "object" field is a document that was created.

Examples:
Example JSON
{
   "url":"http://company.jive.com/docs/DOC-2131",
   "title":"A test document",
   "verb":"jive:created",
   "updated":"2012-09-28T15:35:20.761+0000",
   "content":"<a href=\"http://company.jive.com/people/fred\">Fred Flintstone</a> created <a href=\"http://company.jive.com/docs/DOC-2131\">A test document</a>",
   "object":{
     "displayName":"A test document",
     "objectType":"jive:document",
     "url":"http://company.jive.com/docs/DOC-2131",
     "summary":"Test document text",
   },
   "actor":{
      "displayName":"Fred Flintstone",
      "objectType":"jive:person",
      "url":"http://company.jive.com/people/fred"
   }
}
Create Activity

POST to /api/core/v3/activities to generate a new activity. See the activities service for more information. The minimum set of fields you must include are:

 {
  "title": "Simple activity title",
  "content": "See this activity!"
 }

Fields

FieldTypeMode Description
actorPersonActivityObjectread-only

The person (or other object) that created this activity.

contentStringrequired

Text (or possibly HTML) content describing this activity.

generatorActivityObjectread-only

The application used to generate this activity.

iconMediaLinkoptional

An icon associated with this activity.

idStringread-only

Internal identifier for this activity.

jiveJiveExtensionoptional

Jive extensions to the standard Activity Streams format.

objectActivityObjectoptional

The object that was affected by this activity.

openSocialOpenSocialoptional

OpenSocial extensions to the standard Activity Streams format.

previewImageMediaLinkread-only

An icon associated with this activity.

providerActivityObjectread-only

The service instance at which this activity was generated.

publishedISO 8601 Dateread-only

The date and time at which this activity was generated.

targetActivityObjectoptional

The object representing the "context" or "target" of this activity.

titleStringrequired

The title of this activity.

typeStringread-onlyThe object type ("activity").
updatedISO 8601 Dateread-only

The date and time at which this activity was most recently updated.

urlStringoptional

A URL pointing at more detailed information related to this activity.

verbStringoptionalThe verb describing the category of activity that took place. Verbs for Jive standard actions are prefixed with jive: and are for internal use by Jive. Possible values include:
  • jive:applied - used when content is shared, tagged, and for other general purpose activity
  • jive:commented - added a comment
  • jive:correct_answer_set - answer marked as correct answer
  • jive:created - created something
  • jive:helped - something marked as helpful
  • jive:liked - something was liked
  • jive:outcome_set - an outcome was applied
  • jive:replied - replied to a discussion
  • jive:voted - voted in a poll
→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations