Subscription

A SubscriptionEntity represents a set of users or groups and a set of places to which those users should follow in an activity stream. SubscriptionEntities are always contained within the "subscribers" attribute of a Publication. When subscriptions are updated, the SubscriptionEntity should include the id to avoid unnecessarily deleting and recreating Subscription objects; however, this has no actual effect on the streams generated from the publication definition.

Fields

FieldTypeMode Description
associationsString[]optional

An array of URIs for the places that this subscription references.

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.

nameStringread-only

Name of this subscription. This is automatically generated based on the names of the subscribers.

publishedISO 8601 Dateread-only

Date and time this subscription was originally created.

resourcesObjectread-only

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

subscriberCountIntegerread-only

Subscriber count of this subscription. This is the cardinality of the deduplicated set of all users in all subscribers for this publication.

subscribersString[]optional

An array of URIs for the users and security groups that this subscription references.

typeStringread-only

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

updatedISO 8601 Dateread-only

Date and time this subscription configuration was most recently updated.

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