static osapi.jive.corev3.collaborations

Methods

↑
addParticipants(collaboration,options)
POST /collaborations/{uri}/participants

Retrieves

Object

Description

↑
create(collaboration,options)
POST /collaborations

Retrieves

Object

Description

Create a new collaboration, and return a Collaboration representing the new object. You must submit a JSON object that contains the following fields:

     {
         "content" : {
             "type" : "text/html",
             "text" : "{text}"
         },
         "participants" : [
             "{participantURI}", ...
         ]
     }

where:

  • {text} - Text of the collaboration.
  • {participantURI} - Absolute or partial (/people/####) URI for a Jive person that this message will be sent to.
Takes:
Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • Collaboration describing the newly created collaboration
    • ↑
    get(options)
    GET /collaborations/{uri}

    Retrieves

    Object

    Description

    Return the specified collaboration by its URI.

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the requested collaboration
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Collaboration describing the specified collaboration
    • ↑
    getExternal(options)
    GET /collaborations/ext/{uri}

    Retrieves

    Object

    Description

    ↑
    getInteractionsByCollaboration(options)
    GET /collaborations/{uri}/interactions

    Retrieves

    Object

    Description

    ↑
    getInteractionsWithOptionalContext(options)
    GET /collaborations/{uri}/interactions/{interactionID}

    Retrieves

    Object

    Description

    ↑
    getParticipants(options)
    GET /collaborations/{uri}/participants

    Retrieves

    Object

    Description

    ↑
    removeParticipants(collaboration)
    DELETE /collaborations/{uri}/participants/{userID}

    Retrieves

    --

    Description