PlaceTemplate

PlaceTemplate Service

Web service endpoints for managing page templates.
Since: 3.9

Create Place Template

POST /placeTemplates

Create a new place template with the specified characteristics.

Query Parameters:
NameTypeRequiredDescription
fieldsStringfalseFields to include in the returned PlaceTemplate
Takes:
  • PlaceTemplate describing the place template to be created
    • Retrieves:
  • PlaceTemplate
    • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)The new entity would conflict with system restrictions
    403 (Forbidden)You are not allowed to create place templates

    Destroy Place Template

    DELETE /placeTemplates/{placeTemplateID}

    Delete the specified place template.

    Path Parameters:
    NameTypeRequiredDescription
    placeTemplateIDStringtrueID of the place template to be deleted
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field is missing or malformed
    403 (Forbidden)You are not allowed to delete the specified place template
    404 (Not Found)The specified place template cannot be found

    Get Place Template

    GET /placeTemplates/{placeTemplateID}

    Retrieve and return the specified place template.

    Path Parameters:
    NameTypeRequiredDescription
    placeTemplateIDStringtrueID of the place template to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned
    Retrieves:
  • PlaceTemplate
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)If an input field is missing or malformed
    404 (Not Found)If the specified place template cannot be found

    Get Place Templates

    GET /placeTemplates

    Return a paginated list of place templates 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
    author one person URI ?filter=author(http://domain/api/core/v3/people/12)
    name place template name ?filter=name(bestPracticesSharing)
    displayName display name of the tile definition. This filter must be used together with the author filter ?filter=displayName(template.bestPracticesSharing.name)&author(http://domain/api/core/v3/people/12)
    global boolean value. ?filter=global(true)
    state filter by state of the place templates ?filter=state(published)

    This service supports the following sort types.

    Sort Description
    dateCreatedAsc Sort by the date this place template was created, in ascending order
    dateCreatedDesc Sort by the date this place template 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 place template to be returned
    countIntegerfalseThe maximum number of place templates to be returned
    fieldsStringfalseThe fields to be returned on each place template
    filterObject[]falseThe filter criteria used to select place templates
    Retrieves:
  • PlaceTemplate[] of the matched place templates
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed

    Update Place Template

    PUT /placeTemplates/{placeTemplateID}

    Update the specified place template with the specified characteristics.

    Path Parameters:
    NameTypeRequiredDescription
    placeTemplateIDStringtrueID of the place template to be updated
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in the returned entity
    Takes:
  • PlaceTemplate representing the updated place template
    • Retrieves:
  • An PlaceTemplate representing the updated place template
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    403 (Forbidden)You are not allowed to access the specified place template
    404 (Not Found)The specified place template cannot be found
    409 (Conflict)The updated entity would conflict with system restrictions