1. REST API for Sites Management
  2. Tasks
  3. Templates

List the Images of a Template

get

/sites/management/api/v1/templates/{id}/images

COLLECTION

List thumbnail and preview images associated with template. Template images include a mandatory thumbnail image and an optional set of additional preview images. These images can be used when showing lists of templates for a user to select, giving them a indication of what the site will look like. The default sort order is to list images by creation date in ascending order; oldest first.

Path Alternative Identifiers

The default identifier for a Template resource is the Template Identifier. The Template resource supports alternative identifiers.

nameTemplate Name

Instead of the template identifier, the template name can be used to uniquely identify a template in the resource path. The default resource path parameter for a template is the template identifier, but when working with templates the human-readable template name is sometimes easier.

http://api.example.com/sites/management/api/v1/templates/name:CafeSupremo/images

Introduced in release 19.4.1.

Successful Response Examples

This operation responds with the following success (2xx) responses. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

200OK - List the Template Images

A template has one primary thumbnail image, and up to three preview thumbnail images. Links are not included in the response.

Request

GET https://api.example.com/sites/management/api/v1/templates/{id}/images?links=none

Response Body

{
  "hasMore": false,
  "items": [
      {
        "url": "https://marketing.service.com/documents/web?IdcService=GET_RENDITION&suppressHttpErrorCodes=1&item=fFolderGUID:F1E9A5A8892B83A63740A47F160AFA532D71F588036A&AuxRenditionType=FolderIcon&noSaveAs=1&ts=1559543593693",
        "imageType": "thumbnail"
      },
      {
        "url": "https://marketing.service.com/documents/web?IdcService=GET_THUMBNAIL&item=fFileGUID:F53C0F71A6486C299A98F57C9AF14F3D4CB1C0F3C73F&dRevLabel=3&noSaveAs=1",
        "imageType": "preview"
      },
      {
        "url": "https://marketing.service.com/documents/web?IdcService=GET_THUMBNAIL&item=fFileGUID:F6A7AB65AF31C573457EA63F4E5FCE0654CE4B094E00&dRevLabel=3&noSaveAs=1",
        "imageType": "preview"
      },
      {
        "url": "https://marketing.service.com/documents/web?IdcService=GET_THUMBNAIL&item=fFileGUID:FCF4875E7D15182738AD4EF4818C818AFA91FD27F465&dRevLabel=3&noSaveAs=1",
        "imageType": "preview"
      }
  ]
}

Client Error Response Examples

This operation responds with following client error (4xx) responses with exception details in the response body. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

404Not Found - Template Not Found

The site template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.

Error Code

OCE-SITEMGMT-009000

Resolution - Check Identifier

Check that the template identifier is valid.

Resolution - Check Membership

Check that the authenticated user is a member of the template or a site administrator.

Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
templateTemplate that does not exist or is not visible to the authenticated user.

For detailed information about this exception detail type, consult the TemplateNotFoundExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Not Found",
  "status": "404",
  "detail": "Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
  "o:errorCode": "OCE-SITEMGMT-009000",
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  }
}

Request

Path Parameters
Query Parameters

  • Comma-delimited string of field names that you do not want in the response. Nested fields can be identified using a dot to separate the field names. Field names are case-sensitive. Field names are ignored if the field does not exist. To reference the fields of the collection the field name can be prepended with the @ character (for example, @hasMore).

  • Comma-separated list of link relation names to exclude from the response.

  • Comma-delimited string of field names that you want in the response. Nested properties can be identified using a dot to separate the field names. Field names are case-sensitive. Field names are ignored if the field does not exist. To reference the fields of the collection the field name can be prepended with the @ character (for example, @hasMore).

  • Comma-separated list of link relation names to include in the response. By default, all links are returned.

    The following links are provided by this resource:

    Link RelationshipDescription
    parentDescribes where the parent resource can be read. Equivalent to an up link, this link provides the link to the parent resource, such as the collection resource that contains a singular resource.
    selfDescribes the current returned representation of the resource. Used for links that represent the resource itself. For example, if a resource is returned as part of a collection, the self link will provide the URL path for the individual resource.
    canonicalDescribes the preferred representation of the requested resource. Used for links that represent the canonical form of the resource. For example, if a resource is returned as part of a collection, the canonical link will provide the URL path for the canonical form of the individual resource.
    childDescribes where a related or child resource can be read. Child links are returned in expandable properties and provide the location where unexpanded relationship details can be read.
    describedByDescribes the schema resource providing metadata information about the resource. Used on collection, singular and relation resources to indicate where the schema resource is that describes the resource.

  • Specify the resource representation that should be used to control the response fields and links. If no representation is specified, the client-defined representation is returned, based on the values of the fields, excludeFields, links, excludeLinks and expand query parameters.

    The following representations are supported with the return query parameter:

    RepresentationDescription
    representationFull resource representation includes all properties and links and expands most relationships.
    defaultDefault resource representation includes most properties and links.
    basicBasic resource representation includes some properties and some links.
    minimalMinimal resource representation, includes essential properties and no links.
Back to Top

Response

Supported Media Types

200 Response

OK
Headers
Body ()
Root Schema : schema
Type: object
Show Source
Match All
Show Source
  • CollectionResource

    All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

Nested Schema : items
Type: array

Collection of Image elements.

Show Source
Nested Schema : CollectionResource

All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

Match All
Show Source
Nested Schema : SingularResource
Type: object

All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

Show Source
  • links
Nested Schema : CollectionResource-allOf[1]
Type: object
Show Source

  • Total number of resources in the response.

  • Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.

  • Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.

  • Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.

  • Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the totalResults parameter is supported and is set to true by the client.

Nested Schema : items
Match All
Show Source
  • Image

    Site and site template thumbnail or preview image details.

Nested Schema : Image

Site and site template thumbnail or preview image details.

Match All
Show Source
  • SingularResource

    All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

  • Image-allOf[1]
Nested Schema : Image-allOf[1]
Type: object
Show Source
Example Response (List the Template Images)
{
    "hasMore":false,
    "items":[
        {
            "url":"https://marketing.service.com/documents/web?IdcService=GET_RENDITION&suppressHttpErrorCodes=1&item=fFolderGUID:F1E9A5A8892B83A63740A47F160AFA532D71F588036A&AuxRenditionType=FolderIcon&noSaveAs=1&ts=1559543593693",
            "imageType":"thumbnail"
        },
        {
            "url":"https://marketing.service.com/documents/web?IdcService=GET_THUMBNAIL&item=fFileGUID:F53C0F71A6486C299A98F57C9AF14F3D4CB1C0F3C73F&dRevLabel=3&noSaveAs=1",
            "imageType":"preview"
        },
        {
            "url":"https://marketing.service.com/documents/web?IdcService=GET_THUMBNAIL&item=fFileGUID:F6A7AB65AF31C573457EA63F4E5FCE0654CE4B094E00&dRevLabel=3&noSaveAs=1",
            "imageType":"preview"
        },
        {
            "url":"https://marketing.service.com/documents/web?IdcService=GET_THUMBNAIL&item=fFileGUID:FCF4875E7D15182738AD4EF4818C818AFA91FD27F465&dRevLabel=3&noSaveAs=1",
            "imageType":"preview"
        }
    ]
}

400 Response

Bad Request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found
Headers
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : TemplateNotFoundExceptionDetail
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : TemplateNotFoundExceptionDetail-allOf[1]
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Template Not Found)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Not Found",
    "status":"404",
    "detail":"Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
    "o:errorCode":"OCE-SITEMGMT-009000",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}

406 Response

Not Acceptable

416 Response

Range Not Satisfiable

429 Response

Too Many Requests

500 Response

Internal Server Error

501 Response

Not Implemented

502 Response

Bad Gateway

503 Response

Service Unavailable

504 Response

Gateway Timeout
Back to Top