Stream

Stream Service

REST endpoint for interacting with custom streams associated with a Jive user.

Create Associations

POST /streams/{streamID}/associations

Add associations between the specified custom stream and the list of specified Jive objects. This is an all or nothing operation; if any individual attempt to associate fails, all previously successful attempts will be rolled back.

Path Parameters:

Name	Type	Required	Description
streamID	String	true	ID of the stream to be associated with

Takes:

Array of URIs of the objects to be associated

Return Status:

HTTP Status Code	Description
204 (No Content)	Request was successful
400 (Bad Request)	The syntax of the stream ID or one of the object URIs is invalid
409 (Conflict)	Requesting to create an association that already exists
403 (Forbidden)	The requester is not allowed to manage associations for this custom stream (i.e. not stream owner or a Jive admin)
404 (Not Found)	The specified stream or one of the specified objects is not found

Destroy Stream

DELETE /streams/{streamID}

Delete an existing custom stream.

Path Parameters:

Name	Type	Required	Description
streamID	String	true	ID of the stream to be deleted

Return Status:

HTTP Status Code	Description
204 (No Content)	Request was successful
409 (Conflict)	The requester attempts to delete a non-custom stream
403 (Forbidden)	The requester is not allowed to manage custom streams for the owning user (i.e. not the owning user or a Jive admin)
404 (Not Found)	The specified stream cannot be found

Get Activity

GET /streams/{streamID}/activities

Return the specified activities for the specified stream.

Path Parameters:

Name	Type	Required	Description
streamID	String	true	ID of the stream for which to return activities

Query Parameters:

Name	Type	Required	Description
after	String	false	Date and time representing the minimum "last activity in a collection" timestamp for selecting activities (cannot specify both after and before)
before	String	false	Date and time representing the maxium "last activity in a collection" timestamp for selecting activities (cannot specify both after and before)
count	Integer	false	Maximum number of activities to return in this request (you may get more activities than this in order to get all of the activities in the last collection)
fields	String	false	Fields to be included in the returned activities

Retrieves:

Activity[]

Return Status:

HTTP Status Code	Description
200 (OK)	Request was successful
400 (Bad Request)	The specified stream ID is missing or malformed
403 (Forbidden)	The requesting user is not allowed to retrieve activities for the specified stream
404 (Not Found)	The activities or the specified stream is not found

Get Activity Count

GET /streams/{streamID}/activities/count

Return count of new activities for the given user since the provided time.

Path Parameters:

Name	Type	Required	Description
streamID	String	true	ID of the stream for which to return activities

Query Parameters:

Name	Type	Required	Description
after	String	false	Date and time in ISO-8601 format representing last refresh time.
max	Integer	false	The maximum number of new activity counts to return. Default is 50.
exclude	Boolean	false	Flag indicating whether activity performed by the user should be omitted. Default is false.

Retrieves:

count of new activities for the given user since the provided time

Return Status:

HTTP Status Code	Description
400 (Bad Request)	An input field is missing or malformed

Since: 3.5

Get Association

GET /streams/{streamID}/associations/{objectType}/{objectID}

Return an Object for the specified associated object with the specified stream (if any).

Path Parameters:

Name	Type	Required	Description
streamID	String	true	ID of the stream to be disassociated from
objectType	String	true	Object type of the object to be removed
objectID	String	true	Object ID of the object to be removed

Query Parameters:

Name	Type	Required	Description
fields	String	false	Fields to be returned (default is @all)

Retrieves:

Object describing the associated object

Return Status:

HTTP Status Code	Description
200 (OK)	Request was successful
400 (Bad Request)	The syntax of the stream ID, object type, or object ID is invalid
409 (Conflict)	Requesting to remove an association that does not already exist
403 (Forbidden)	The requester is not allowed to manage associations for this custom stream (i.e. not stream owner or a Jive admin)
404 (Not Found)	The specified stream or the specified object is not found, or there is no such association

Get Associations

GET /streams/{streamID}/associations

Return a paginated list of s for Jive objects that are associated with the specified stream, and match the optionally specified filters.

The following filter expressions are supported by this service:

type(xxx) - Filter by object type(s), where xxx is a comma delimited list of the object types you want returned (document, group, etc.)

Path Parameters:

Name	Type	Required	Description
streamID	String	true	ID of the stream whose associations are requested

Query Parameters:

Name	Type	Required	Description
startIndex	Integer	false	Zero-relative index of the first associated object to return
count	Integer	false	Maximum number of associated objects to return
fields	String	false	Fields to return in the associated objects
filter	Object[]	false	Optional set of filter expressions to select the returned objects

Retrieves:

Entity[]

Return Status:

HTTP Status Code	Description
200 (OK)	Request was successful
400 (Bad Request)	An input value is missing or malformed
403 (Forbidden)	The requester is not allowed to view custom streams for the owning user
404 (Not Found)	The specified stream cannot be found

Get Connections Activity

GET /streams/connections/activities

Return the specified activities for the connections stream (activity of people and places you are following) for the requesting person.

Query Parameters:

Name	Type	Required	Description
after	String	false	Date and time representing the minimum "last activity in a collection" timestamp for selecting inbox entries (cannot specify both after and before)
before	String	false	Date and time representing the maxium "last activity in a collection" timestamp for selecting inbox entries (cannot specify both after and before)
count	Integer	false	Maximum number of activities to return in this request (you may get more activities than this in order to get all of the activities in the last collection)
fields	String	false	Fields to be included in the returned activities

Return Status:

HTTP Status Code	Description
200 (OK)	Request was successful
400 (Bad Request)	The specified stream ID is missing or malformed
403 (Forbidden)	The requesting user is not allowed to retrieve activities for the specified stream
404 (Not Found)	The activities or the specified stream is not found

Get Stream

GET /streams/{streamID}

Return a Stream representation of the specified stream.

Path Parameters:

Name	Type	Required	Description
streamID	String	true	ID of the stream to be returned

Query Parameters:

Name	Type	Required	Description
fields	String	false	Fields to be returned (default is "@all")

Retrieves:

Stream representation of the specified stream

Return Status:

HTTP Status Code	Description
200 (OK)	Request was successful
403 (Forbidden)	The requester is not allowed to view custom streams for the owning user
404 (Not Found)	The specified stream cannot be found

Destroy Association

DELETE /streams/{streamID}/associations/{objectType}/{objectID}

Remove an association between the specified custom stream and the specified Jive object.

Path Parameters:

Name	Type	Required	Description
streamID	String	true	ID of the stream to be disassociated from
objectType	String	true	Object type of the object to be removed
objectID	String	true	Object ID of the object to be removed

Return Status:

HTTP Status Code	Description
204 (No Content)	Request was successful
400 (Bad Request)	The syntax of the stream ID, object type, or object ID is invalid
409 (Conflict)	Requesting to remove an association that does not already exist
403 (Forbidden)	The requester is not allowed to manage associations for this custom stream (i.e. not stream owner or a Jive admin)
404 (Not Found)	The specified stream or the specified object is not found

Update Stream

PUT /streams/{streamID}

Update an existing custom stream, based on the information in the specified Stream. Then,return a Stream reflecting the updated stream configuration.

The following fields are processed from the incoming Stream:

name - the name of the new stream (must be unique per user)
receiveEmails - flag indicating whether the user wants to receive email from this stream

Path Parameters:

Name	Type	Required	Description
streamID	String	true	ID of the stream to be updated

Query Parameters:

Name	Type	Required	Description
fields	String	false	Fields to be included in the response (default is @all)

Takes:

Stream containing the configuration information to construct the new stream

Retrieves:

A Stream reflecting the updated stream configuration

Return Status:

HTTP Status Code	Description
200 (OK)	Request was successful
400 (Bad Request)	An input value is missing or malformed
409 (Conflict)	Requesting to create a custom stream with a name that already exists
403 (Forbidden)	The requester is not allowed to manage custom streams for the specified user (i.e. not the specified user or a Jive admin)
404 (Not Found)	The specified user cannot be found

Stream

Stream Service

Jump to

Create Associations

Path Parameters:

Takes:

Return Status:

Destroy Stream

Path Parameters:

Return Status:

Get Activity

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Get Activity Count

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Since: 3.5

Get Association

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Get Associations

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Get Connections Activity

Query Parameters:

Return Status:

Get Stream

Path Parameters:

Query Parameters:

Retrieves:

Return Status:

Destroy Association

Path Parameters:

Return Status:

Update Stream

Path Parameters:

Query Parameters:

Takes:

Retrieves:

Return Status: