osapi.jive.corev3.contents.Outcome

An entity representing an outcome. Outcomes are applied to the content objects.

Examples:
Example JSON

JSON with the most important data for an Outcome. See the table below for a list of all fields.

 {
  "id" : "1001",
      "resources" : {
          "self" : {
              "allowed" : [ "GET", "DELETE" ],
              "ref" : "http://localhost:50001/api/core/v3/outcomes/1001"
              }
          },
      "root" : "http://localhost:50001/api/core/v3/contents/1050",
      "parent" : "http://localhost:50001/api/core/v3/comments/1001",
      "outcomeType" : {
         "id" : "1",
 "name" : "DECISION"
 },
 "user" : {
 "id" : "1",
 "resources" : {
 "reports" : {
 "allowed" : [ "GET" ],
 "ref" : "http://localhost:50001/api/core/v3/people/1/@reports"
 },
 "manager" : {
 "allowed" : [ "GET" ],
 "ref" : "http://localhost:50001/api/core/v3/people/1/@manager"
 },
 "self" : {
 "allowed" : [ "GET", "PUT", "DELETE" ],
 "ref" : "http://localhost:50001/api/core/v3/people/1"
 },
 "tasks" : {
 "allowed" : [ "POST", "GET" ],
 "ref" : "http://localhost:50001/api/core/v3/people/1/tasks"
 },
 "avatar" : {
 "allowed" : [ "GET" ],
 "ref" : "http://localhost:50001/api/core/v3/people/1/avatar"
 },
 "colleagues" : {
 "allowed" : [ "GET" ],
 "ref" : "http://localhost:50001/api/core/v3/people/1/@colleagues"
 },
 "followers" : {
 "allowed" : [ "GET" ],
 "ref" : "http:* localhost:50001/api/core/v3/people/1/@followers"
 },
 "following" : {
 "allowed" : [ "GET" ],
 "ref" : "http://localhost:50001/api/core/v3/people/1/@following"
 },
 "images" : {
 "allowed" : [ "POST", "GET" ],
 "ref" : "http://localhost:50001/api/core/v3/people/1/images"
 },
 "html" : {
 "allowed" : [ "GET" ],
 "ref" : "http://localhost:50001/people/admin"
 },
 "streams" : {
 "allowed" : [ "POST", "GET" ],
 "ref" : "http://localhost:50001/api/core/v3/people/1/streams"
 },
 "followingIn" : {
 "allowed" : [ "GET" ],
 "ref" : "http://localhost:50001/api/core/v3/people/1/followingIn"
 },
 "activity" : {
 "allowed" : [ "GET" ],
 "ref" : "http://localhost:50001/api/core/v3/people/1/activities"
 },
 "members" : {
 "allowed" : [ "GET" ],
 "ref" : "http://localhost:50001/api/core/v3/members/people/1"
 }
 },
 "followerCount" : 0,
 "published" : "2013-01-18T00:35:10.908+0000",
 "updated" : "2013-01-18T00:35:10.908+0000",
 "displayName" : "Administrator",
 "emails" : [ {
 "jive_label" : "Email",
 "primary" : true,
 "type" : "work",
 "value" : "admin@example.com"
 } ],
 "followingCount" : 0,
 "jive" : {
 "enabled" : true,
 "external" : false,
 "federated" : false,
 "level" : {
 "name" : "Newbie",
 "points" : 0
 },
 "locale" : "en_US",
 "externalContributor" : false,
 "timeZone" : "America/Los_Angeles",
 "username" : "admin",
 "visible" : true
 },
 "name" : {
 "formatted" : "Administrator"
 },
 "thumbnailId" : "-1",
 "thumbnailUrl" : "http:* localhost:50001/api/core/v3/people/1/avatar",
 "type" : "person"
 },
 "creationDate" : "2013-01-18T00:40:43.843+0000",
 "type" : "outcome"
 }
Create An Outcome on a Document

Read createOutcome() to learn how to create a new personal task.

Create Document Outcome

Read creatOutcome() to learn how to create an outcome on a document

Properties

PropertyTypeMode Description
creationDateISO 8601 Dateread-only

The creation date of the outcome.

idStringread-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.

noteStringread-only
outcomeTypeOutcomeTyperequired

Flag indicating whether objects of this type can be associated to (followed in) an activity stream. Present on Jive core object types only.

parentStringread-only

The owner of outcome which is the content object the outcome was made on

predecessorOutcomeStringread-only

The parent outcome of the given outcome if one exists

propertiesObjectoptional

The properties of the outcome

Retrieves:
  • map of properties for current outcome
  • resourcesObjectread-only

    Resource links (and related permissions for the requesting person) relevant to this object.

    rootStringread-only

    The root owner of outcome which is the parent of the content object the outcome was made on

    statusStringread-only

    Published status of this content object.

    • incomplete - Content object is in draft mode
    • pending_approval - Content object is waiting for approval
    • awaiting moderation - Content object is waiting for moderation by an approver
    • rejected - Content object has been rejected for publication by an approver
    • published - Content object has been published
    successorOutcomeTypesOutcomeType[]read-only
    typeStringread-only
    typeCodeIntegerread-only
    updatedISO 8601 Dateread-only

    The modification date of the outcome.

    userPersonread-only

    The user assigned to the outcome.

    → Fields used by update and create operations
    → Fields used only by create operations
    → Fields not used by update or create operations

    Methods

    createOutcome(comment,options)
    POST /outcomes/1234/outcomes

    Retrieves

    Comment

    Description

    Add a child outcome to this outcome.

    Takes:
    • Outcome describing the new outcomes
    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Comment representing the recorded outcome
  • destroy()
    DELETE /outcomes/1234

    Retrieves

    --

    Description

    Delete this outcome.

    getHistory(options)
    GET /outcomes/1234/history

    Retrieves

    Outcome[]

    Description

    Get history of this outcome.

    Takes:
    • Outcome describing the new outcomes
    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Comment representing the recorded outcome
  • toURI()

    Retrieves

    String

    Description

    Retrieves:
  • A URI representing this entity, or undefined if no such URI exists.
  • update(options)
    PUT /outcomes/1234

    Retrieves

    Outcome

    Description

    Update the information about this outcome.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Outcome representing the updated content object