ExternalStreamDefinition

ExternalStreamDefinition Service

Web service endpoints for retrieving external stream definitions.

Get Definition

GET /extstreamDefs/{extStreamDefID}

Return the specified external stream definition with the specified fields.

Path Parameters:
NameTypeRequiredDescription
extStreamDefIDStringtrueID of the external stream definition to be returned
Query Parameters:
NameTypeRequiredDescription
fieldsStringfalseFields to be returned
Retrieves:
  • ExternalStreamDefinition containing the specified external stream definition
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    404 (Not Found)The specified external stream definition does not exist

    Get I18n Resource

    GET /extstreamDefs/{extStreamDefID}/i18n

    Retrieves the current i18n resource bundle for the default locale.

    Path Parameters:
    NameTypeRequiredDescription
    extStreamDefIDStringtrueID of the tile to obtain the i18n resource
    Retrieves:
  • A Java properties file format, encoded ISO-8859-1
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    404 (Not Found)The request resource does not exist
    400 (Bad Request)An input field is malformed

    Get I18n Resource

    GET /extstreamDefs/{extStreamDefID}/i18n/{lang}

    Retrieves the current i18n resource bundle for a language.

    Ensure that the language code specified is two characters, lower case and complies with ISO-639-1.

    Path Parameters:
    NameTypeRequiredDescription
    extStreamDefIDStringtrueID of the tile to obtain the i18n resource
    langStringtrueThe ISO-639-1 language code
    Retrieves:
  • A Java properties file format, encoded ISO-8859-1
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    404 (Not Found)The request resource does not exist
    400 (Bad Request)An input field is malformed

    Get I18n Resource

    GET /extstreamDefs/{extStreamDefID}/i18n/{lang}/{country}

    Retrieves the current i18n resource bundle for a language and country.

    Ensure that the language code specified is two characters, lower case and complies with ISO-639-1.

    Ensure that the country code specified is two characters, upper case and complies with ISO-3166-1 alpha-2.

    Path Parameters:
    NameTypeRequiredDescription
    extStreamDefIDStringtrueID of the tile to obtain the i18n resource
    langStringtrueThe ISO-639-1 language code
    countryStringtrueThe ISO-3166-1 alpha-2 country code
    Retrieves:
  • A Java properties file format, encoded ISO-8859-1
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    404 (Not Found)The request resource does not exist
    400 (Bad Request)An input field is malformed

    Get Instances

    GET /extstreamDefs

    Return a paginated list of existing external stream definitions in the system.

    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
    name name of the external stream definition ?filter=name(current-issues-tile)
    addonUUID UUID of the add-on from which the external stream definitions are supplied ?filter=addonUUID(b382192e-d292-4f21-b793-5664625b0212)
    state one of the following states
    State Description
    PUBLISHED The external stream definition is available to be used for adding tile instances to template instances
    ARCHIVED This external stream definition is no longer available for adding tile instances to template instances
    DISABLED This external stream definition is disabled because features it rely on are not available in this system
    LOCKED This is a custom external stream used by one user and locked. This tile is also PUBLISHED
    UNLOCKED This is a custom external stream created by one user and unlocked. This tile is also PUBLISHED
    GLOBAL_LOCKED This is a custom external stream and can be used by one user and is locked. This tile is also PUBLISHED
    GLOBAL_UNLOCKED This is a custom external stream and can be used by any user. This tile is also PUBLISHED
    		?filter=state(PUBLISHED)
    Query Parameters:
    NameTypeRequiredDescription
    startIndexIntegerfalseThe zero-relative index of the first matching content to be returned
    countIntegerfalseThe maximum number of contents to be returned
    fieldsStringfalseThe fields to be returned on each content
    Retrieves:
  • ExternalStreamDefinition[] of the matched external stream definitions
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed

    Get Prototype

    GET /extstreamDefs/{extStreamDefID}/prototype

    Return a new external stream instance, that is not persistent, based on the specified external stream definition.

    Path Parameters:
    NameTypeRequiredDescription
    extStreamDefIDStringtrueID of the external stream to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned
    Retrieves:
  • ExternalStreamDefinition containing the specified external stream
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    404 (Not Found)The specified external stream definition does not exist

    Get Tile Category

    GET /extstreamDefs/category/{tileCategoryID}

    Return the specified tile category with the specified fields.

    Path Parameters:
    NameTypeRequiredDescription
    tileCategoryIDStringtrueID of the tile category to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned
    Retrieves:
  • TileCategory containing the specified tile category
    • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access the specified tile category
    404 (Not Found)The specified tile category does not exist