ExternalStreamDefinition

An External Stream Definition is a prototype for a source of activity stream entries provided by a Client Application. Each data push will cause a new activity stream entry to be added to the activity stream for a place.
 {
    "id":"1006",
    "name":"UPS tracking activity",
    "state":"published",
    "client_id":"4bca2e5c-e537-4484-b4e6-9614dcf44991",
    "displayName":"UPS tracking",
    "register":"http://myjiveservice.com/register",
    "type":"extStreamDefinition",
    "categories":[
      {
        // Integration Tile Category JSON
      },
      ...
    ],
    "published":"2013-01-17T00:16:28.352+0000",
    "updated":"2013-01-17T00:16:28.352+0000",
    "resources":{
       "self":{
          "allowed":[
             "GET"
          ],
          "ref":"http://example.jiveon.com/api/core/v3/extstreams/definitions/1006"
       }
    },
    "icons":{
       "16":"http://example.jiveon.com/api/core/v3/images/1016",
       "48":"http://example.jiveon.com/api/core/v3/images/1017",
       "128":"http://example.jiveon.com/api/core/v3/images/1018"
    }
 }

Fields

FieldTypeMode Description
actionStringoptional

URL that provides the processing logic for handling clicks on actions in the presentation of data from this Tile

addOnAddOnread-only
categoriesTileCategory[]optional
client_idStringoptional
configStringoptional

URL of an HTML file used for powering a custom view (like a lightweight app) to configure the tile

defaultConfigSharedStringoptional
deprecationDeprecationread-only

Information describing the deprecation status of this object

descriptionStringoptional
descriptionLocalizedStringread-only
displayNameStringrequired
displayNameLocalizedStringread-only
iconsObjectoptional
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.

isDeletableBooleanread-only
nameStringrequired
productNameStringoptional
publishedISO 8601 Dateread-only
registerStringoptional
resourcesObjectread-only

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

sampleDataObjectoptional

Sample of the data that can be pushed to instances of this definition. Possible values are: Configuration of this instance in JSON format.

Retrieves:
  • the JSON sample data
  • stateStringoptional

    State of this definition. Possible values are:

    • published - Definition is available to be used
    • archived - Definition is no longer available
    • disabled - Definition is disabled because features it rely on are not available in this system
    • locked - Custom definition is used by one user and is locked
    • unlocked - Custom definition created by one user and is unlocked
    • global_locked - Custom definition can be used by one user and is locked
    • global_unlocked - Custom definition can be used by any user

    unregisterStringoptional
    updatedISO 8601 Dateread-only
    usesOAuth2Booleanoptional
    followedBooleanread-only

    Whether the current user is following this object.

    Availability:

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

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

    Resources

    ResourceMethodDescription
    selfGET

    Return an updated version of this external stream definition.