ExternalStreamInstance

ExternalStreamInstance Service

Web service endpoints for External Stream instances.

To create activity for an External Stream instance you should use the jivelinks version of this service.

Create Extended Properties

POST /extstreams/{externalStreamInstanceID}/extprops

Save a new set of extended properties for a external stream instance with specified name/value pairs, and return an entity representing the newly created extended properties. Any previous extended properties for this external stream instance will be completely replaced.

This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties being stored on the target external stream instance will be also associated with the consumer of the oAuth token.

Path Parameters:
NameTypeRequiredDescription
externalStreamInstanceIDStringtrueID of the external stream instance for which to create a extended properties
Takes:
  • ExtProps describing the extended properties to be saved
    • Retrieves:
  • ExtProps representing the newly created extended props
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    401 (Unauthorized)Authentication credentials were not provided or are incorrect
    410 (Gone)Instance is no longer available
    404 (Not Found)The specified instance cannot be found
    400 (Bad Request)An input field is malformed or max number of extended properties has been reached
    403 (Forbidden)You are not allowed to manage ext properties for external stream instance

    Create Extended Properties For Addon

    POST /extstreams/{externalStreamInstanceID}/extprops/addOn/{addonUUID}

    Save a new set of extended properties for a external stream instance with specified characteristics, and return an entity representing the newly created extended properties. Any previous extended properties for this external stream instance will be completely replaced.

    This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, this service will validate that the consumer of the oAuth token can access the specified add-on.

    Path Parameters:
    NameTypeRequiredDescription
    externalStreamInstanceIDStringtrueID of the external stream instance for which to create a extended properties
    addonUUIDStringtrueUUID of the addon for which the properties are created.
    Takes:
  • ExtProps describing the extended properties to be saved
    • Retrieves:
  • ExtProps representing the newly created extended props
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    401 (Unauthorized)Authentication credentials were not provided or are incorrect
    410 (Gone)Instance is no longer available
    404 (Not Found)The specified instance cannot be found
    400 (Bad Request)An input field is malformed or max number of extended properties has been reached
    403 (Forbidden)You are not allowed to manage ext properties for external stream instance
    Since: 3.9

    Create Private Properties

    POST /extstreams/{externalStreamInstanceID}/privateprops

    Save a new set of private properties for a external stream instance with specified name/value pairs, and return an entity representing the newly created private properties. Private properties are scoped to the viewer and are not visible to nor do they overlap with any other user. Any previous private properties for this external stream instance will be completely replaced.

    This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties being created on the target external stream instance will be those associated with the consumer of the oAuth token.

    Path Parameters:
    NameTypeRequiredDescription
    externalStreamInstanceIDStringtrueID of the external stream instance for which to create a private properties
    Takes:
  • PrivateProps describing the private properties to be saved
    • Retrieves:
  • PrivateProps representing the newly created private props
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    401 (Unauthorized)Authentication credentials were not provided or are incorrect
    410 (Gone)Instance is no longer available
    404 (Not Found)The specified external stream instance cannot be found
    400 (Bad Request)An input field is malformed or max number of private properties has been reached
    403 (Forbidden)You are not allowed to manage ext properties for external stream instance
    Since: 3.10

    Destroy Extended Properties

    DELETE /extstreams/{externalStreamInstanceID}/extprops

    Delete the existing extended properties for the specified external stream instance.

    This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties being deleted from the target external stream instance will be also associated with the consumer of the oAuth token.

    Path Parameters:
    NameTypeRequiredDescription
    externalStreamInstanceIDStringtrueID of the external stream instance for which the extended properties are to be deleted
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    401 (Unauthorized)Authentication credentials were not provided or are incorrect
    410 (Gone)Instance is no longer available
    404 (Not Found)The specified external stream instance does not exist
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to delete properties

    Destroy Extended Properties For Addon

    DELETE /extstreams/{externalStreamInstanceID}/extprops/addOn/{addonUUID}

    Delete the existing extended properties for the specified external stream instance.

    This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, this service will validate that the consumer of the oAuth token can access the specified add-on.

    Path Parameters:
    NameTypeRequiredDescription
    externalStreamInstanceIDStringtrueID of the external stream instance for which the extended properties are to be deleted
    addonUUIDStringtrueUUID of the addon for which the properties are deleted.
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    401 (Unauthorized)Authentication credentials were not provided or are incorrect
    410 (Gone)Instance is no longer available
    404 (Not Found)The specified external stream instance does not exist
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to delete properties
    Since: 3.9

    Destroy Private Properties

    DELETE /extstreams/{externalStreamInstanceID}/privateprops

    Delete the existing private properties for the specified external stream instance.

    This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties being deleted from the target external stream instance will be those associated with the consumer of the oAuth token.

    Path Parameters:
    NameTypeRequiredDescription
    externalStreamInstanceIDStringtrueID of the external stream instance for which to create a private properties
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    401 (Unauthorized)Authentication credentials were not provided or are incorrect
    410 (Gone)Instance is no longer available
    404 (Not Found)The specified external stream instance does not exist
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to delete properties
    Since: 3.10

    Get Extended Properties

    GET /extstreams/{externalStreamInstanceID}/extprops

    Return the specified extended properties for the specified external stream instance.

    This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties being deleted from the target external stream instance will be also associated with the consumer of the oAuth token.

    Path Parameters:
    NameTypeRequiredDescription
    externalStreamInstanceIDStringtrueID of the external stream instance that is associated to the extended properties
    Retrieves:
  • ExtProps containing the specified extended properties
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    401 (Unauthorized)Authentication credentials were not provided or are incorrect
    410 (Gone)Instance is no longer available
    404 (Not Found)If the specified external stream instance does not exist
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to retrieve these properties

    Get Extended Properties For Addon

    GET /extstreams/{externalStreamInstanceID}/extprops/addOn/{addonUUID}

    Return the specified extended properties for the specified external stream instance.

    This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, this service will validate that the consumer of the oAuth token can access the specified add-on.

    Path Parameters:
    NameTypeRequiredDescription
    externalStreamInstanceIDStringtrueID of the external stream instance that is associated to the extended properties
    addonUUIDStringtrueUUID of the addon for which the properties are fetched.
    Retrieves:
  • ExtProps containing the specified extended properties
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    401 (Unauthorized)Authentication credentials were not provided or are incorrect
    410 (Gone)Instance is no longer available
    404 (Not Found)If the specified external stream instance does not exist
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to retrieve these properties
    Since: 3.9

    Get Instance

    GET /extstreams/{externalStreamInstanceID}

    Return the specified external stream instance with the specified fields.

    Path Parameters:
    NameTypeRequiredDescription
    externalStreamInstanceIDStringtrueID of the external stream instance to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned (default is "@all")
    Retrieves:
  • ExternalStreamInstance containing the specified instance
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access the specified external stream instance
    404 (Not Found)The specified external stream instance does not exist

    Get Instances

    GET /extstreams

    Return a paginated list of external stream instances that match the specified filter criteria.

    This service supports the following filters. Parameters, when used, should be wrapped in parentheses, and multiple values separated by commas. See the examples for clarification.

    Filter Params Example
    tilePage one Page URI ?filter=author(http://domain/api/core/v3/pages/1234)

    This service supports the following sort types.

    Sort Description
    dateCreatedAsc Sort by the date this instance was created, in ascending order
    dateCreatedDesc Sort by the date this instance was created, in descending order. Default if none was specified.
    Query Parameters:
    NameTypeRequiredDescription
    sortStringfalseThe requested sort order
    startIndexIntegerfalseThe zero-relative index of the first matching instance to be returned
    countIntegerfalseThe maximum number of instances to be returned
    fieldsStringfalseThe fields to be returned on each instance
    Takes:
  • filters
    • Retrieves:
  • ExternalStreamInstance[] of the matched external stream instances
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed

    Get Private Properties

    GET /extstreams/{externalStreamInstanceID}/privateprops

    Return the private properties for the specified external stream instance. Private properties are scoped to the viewer and are not visible to nor do they overlap with any other user.

    This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties being created on the target external stream instance will be those associated with the consumer of the oAuth token.

    Path Parameters:
    NameTypeRequiredDescription
    externalStreamInstanceIDStringtrueID of the external stream instance for which to create a private properties
    Takes:
  • PrivateProps describing the private properties to be saved
    • Retrieves:
  • PrivateProps containing the specified private properties
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    401 (Unauthorized)Authentication credentials were not provided or are incorrect
    410 (Gone)Instance is no longer available
    404 (Not Found)If the specified external stream instance does not exist
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to retrieve these properties
    Since: 3.10