Collaboration

A collaboration among a defined set of participants. A Collaboration has only a mutable subject and no body content. Corresponds to creating a "Message" from the Create menu in Jive if RTC is turned on. See the /collaborations service.

Example:
Example JSON

JSON including important fields and a Collaboration's resources. See the tables below for a list of all fields and resources.

{
  "type" : "collaboration",
  "status" : "published",
  "subject" : "Collaboration around the important project",
  "parent" : "https://example.jiveon.com/api/core/v3/people/2001",
  "author" : {
    "name" : {
      "givenName" : "Vicky",
      "familyName" : "Employee",
      "formatted" : "Vicky Employee"
    },
    "type" : "person",
    "displayName" : "Vicky Employee",
    "id" : "2001"
  },
  "participants" : [ {
    "name" : {
      "formatted" : "Bob Goodwin"
    },
    "type" : "person",
    "displayName" : "Bob Goodwin",
    "id" : "1"
  } ],
  "id" : "1004",
  "resources" : {
    "self" : {
      "ref" : "https://example.jiveon.com/api/core/v3/collaboration/1004",
      "allowed" : [ "DELETE", "GET" ]
    },
    "html" : {
      "ref" : "https://example.jiveon.com/inbox/dm/1004",
      "allowed" : [ "GET" ]
    },
    "interactions" : {
      "ref" : "https://example.jiveon.com/api/core/v3/collaboration/1004/interactions",
      "allowed" : [ "POST", "GET" ]
    }
  }
}

Fields

FieldTypeMode Description
abuseCountIntegerread-only

Number of abuse reports associated with this content object.

authorPersonread-only

Author of this content object.

collaborationSourceStringread-only

The source of collaboration. Valid values are UNKNOWN, RTC, MOBILE, WEBUI.

Retrieves:
  • The source of collaboration.
  • collaborationTypeStringread-only

    The type of collaboration this is. Valid values are INDIVIDUAL and GROUP.

    Retrieves:
  • The type of collaboration this is. Valid values are INDIVIDUAL and GROUP.
  • contentContentBodyrequired

    Content of this content object.

    contentIDStringread-only

    Internal Jive ID associated with the content.

    contentImagesImage[]read-only

    A list of Image objects providing metadata about images embedded within this content.

    contentVideosContentVideo[]read-only

    A list of ContentVideo objects providing metadata about videos embedded within this content.

    externalIDStringread-only

    External Id of this content object.

    externalPublishedISO 8601 Dateread-only

    External timestamp of this content object.

    favoriteCountIntegerread-only

    Number of people who have bookmarked this object.

    Availability:

    Will be present only for object types that support being bookmarked.

    Since: 3.11
    followerCountIntegerread-only

    Number of people following this object.

    Availability:

    Will be present only for object types that support being followed.

    highlightBodyStringread-only

    Highlight snippet of a search match in the body or description.

    Availability:

    Will be present in search results only.

    highlightSubjectStringread-only

    Highlight snippet of a search match in the subject or name.

    Availability:

    Will be present in search results only.

    highlightTagsStringread-only

    Highlight snippet of a search match in tags.

    Availability:

    Will be present in search results only.

    iconCssStringread-only

    CSS Style to locate icon within sprite.

    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.

    lastActivityDateISO 8601 Dateread-only

    Date and time when this had its last activity.

    Since: 3.12
    likeCountIntegerread-only

    Number of people who have liked this object.

    Availability:

    Will be present only for object types that support being liked.

    parentStringread-only

    URI of the person who sent the collaboration.

    parentContentSummaryread-only

    Summary information about the content object that is the parent of this object.

    Availability:

    Will be present in search results only.

    parentContentVisibleBooleanread-only

    Flag indicating that the content parent's contents are visible to the viewer.

    parentPlaceSummaryread-only

    Summary information about the place that contains this object.

    Availability:

    Will be present in search results only.

    parentVisibleBooleanread-only

    Flag indicating that the content parent is visible to the viewer.

    participantsPerson[]read-only

    The people to whom this collaboration was sent.

    publishedISO 8601 Dateread-only

    Date and time when this content object was originally created.

    replyCountIntegerread-only

    Number of replies to this object.

    Availability:

    Will be present only for object types that support replies.

    resourcesObjectread-only

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

    searchRankingsObjectread-only

    A map of search result scores including social signals.

    Availability:

    Will be present in search results only.

    statusStringread-only

    Published status of this content object.

    • incomplete - Content object is in draft mode
    • 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
    subjectStringread-only

    Subject of this content object.

    tagsString[]optional

    Tags associated with this object.

    Availability:

    Will be present only for object types that support tags

    typeStringread-only

    The object type of this object ("dm").

    typeActualStringread-only

    The object type of this object ("dm").

    updatedISO 8601 Dateread-only

    Date and time this content object was most recently updated.

    viewCountIntegerread-only

    Number of times this content object has been viewed.

    Availability:

    Will be present only for objects that support view counts

    visibleToExternalContributorsBooleanread-only

    Flag indicating that this content object is potentially visible to external contributors.

    followedBooleanread-only

    Whether the current user is following this object.

    Availability:

    Will be present only for object types that support being followed.

    promotedResultBooleanread-only

    A boolean determining whether this search result is a promoted result

    Availability:

    Will be present in search results only.

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

    Resources

    ResourceMethodDescription
    participantsPOST
    Add a new participant to this Collaboration.
    childOutcomeTypesGET

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

    Retrieves:
  • OutcomeType[]
  • commentsPOST

    Add a comment about this content object.

    The minimum JSON object needed to create a comment is:

         {
             "content": {"type": "text/html", "text": "

    This is a new comment

    "}, }
    Takes:
    Retrieves:
  • Comment representing the recorded comment
  • commentsGET

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

    Retrieves:
  • Comment[]
  • extpropsDELETE

    Deletes all extended properties for content.

    Availability:

    Content should be editable to caller.

    extpropsGET

    Returns extended properties for content.

    Availability:

    Content should be visible to caller.

    Retrieves:
  • ExtProps[]
  • extpropsPOST

    Creates extended properties for content.

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

    Content should be editable to caller.

    Retrieves:
  • ExtProps[]
  • htmlGET

    Return the HTML representation of this collaboration.

    interactionsPOST

    Create a new interaction on this collaboration, and return a Interaction representing the new object.

    Takes:
    Retrieves:
  • Interaction describing the newly created interaction
  • interactionsGET
    Returns interactions for this collaboration
    outcomesPOST

    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:
  • Outcome Representation of the newly created outcome
  • outcomesGET

    Return a paginated list of outcomes on the content.

    Retrieves:
  • Outcome[]
  • outcomeTypesGET

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

    Retrieves:
  • OutcomeType[]
  • selfGET

    Return an updated version of this collaboration.

    Retrieves:
  • Collaboration representing the updated collaboration
  • selfPUT
    selfDELETE

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

    subjectPOST

    Sets the subject of this Collaboration.

    Takes:
    • Collaboration fields (or just the subject field) with the modified subject
    Retrieves:
  • Collaboration representing the updated collaboration