List assets

1 min

GET

https://api.cms.optimizely.com/v1/content/{key}/assets

List the assets that belongs to a content instance.

Path Parameters

keystringrequired
Description
The key of the content to retrieve assets for.

Query Parameters

contentTypesstring[]
Description
Indicates which content types or base types to include in the list.
pageIndexinteger<int32>
Description
Zero based index of the page that should be retrieved.
Format
int32
Minimum
0
Maximum
10000
pageSizeinteger<int32>
Description
The maximum items per page that should be retrieved.
Format
int32
Minimum
1
Maximum
10000

Responses

200OK

ContentNodePage
Description
A single page of items in a paged collection, including paging metadata such as the current page index, page size, and an estimated total item count.
- itemsContentNode[]
  Description
  The items in this paged collection.
  - keystring
    Description
    The unique identifier (key) of the resource.
  - containerstring
    Description
    The content item that contains this item in the hierarchy.
  - ownerstring
    Description
    The content item that owns this item. Content that is owned by another content is also known as an asset. Cannot be combined with container.
  - contentTypestring
    Description
    The content type that defines the structure and available properties for this item.
  - primaryLocalestring
    Description
    The locale for which this content was originally created. This locale will include properties that are shared across all locales.
  - localesstring[]
    Description
    The complete list of locales for which this content has been created for.
  - lastModifiedstring<date-time>
    Description
    The date and time when this content was last modified.
    Format
    date-time
  - lastModifiedBystring
    Description
    The username of the user that last modified this content.
  - createdstring<date-time>
    Description
    The date and time when this content was first created.
    Format
    date-time
  - createdBystring
    Description
    The username of the user who created this content.
  - deletedstring<date-time>
    Description
    If populated, the date and time when this content was deleted.
    Format
    date-time
  - deletedBystring
    Description
    The username of the user who deleted this content. Only populated if the content is deleted.
- pageIndexinteger<int32>
  Description
  The zero-based index of the current page.
  Format
  int32
- pageSizeinteger<int32>
  Description
  The number of items in each page. Not necessarily the same as the number of items in this page.
  Format
  int32
- totalCountinteger<int32>
  Description
  The estimated total number of items in the collection. May be omitted if the total count is unknown.
  Format
  int32

401Unauthorized

403Forbidden

404Not Found

429Too Many Requests

ProblemDetails
- typestring<uri>
  Description
  A URI reference that identifies the problem type.
  Format
  uri
- titlestring
  Description
  A short, human-readable summary of the problem type.
- statusinteger<int32>
  Description
  The HTTP status code generated by the origin server for this occurrence of the problem.
  Format
  int32
  Minimum
  100
  Maximum
  599
- detailstring
  Description
  A human-readable explanation specific to this occurrence of the problem.
- instancestring<uri>
  Description
  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
  Format
  uri
- codestring
  Description
  Error code that identifies the problem type.
- errorsobject[]
  Description
  An array of error details with more detailed information about the problem.
  - detailstring
    Description
    A granular explanation of one specific error related to a field, header or query parameter.
  - fieldstring
    Example
    properties.header.displayName
    Description
    A string that may provide a hint to which field that was the source of the error.

Response Headers

Retry-Afternumber
Description
Indicates how long the client should wait before making a new request.

500Internal Server Error

curl

curl --request GET \
     --url https://api.cms.optimizely.com/v1/content/{key}/assets \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.cms.optimizely.com/v1/content/{key}/assets", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cms.optimizely.com/v1/content/{key}/assets")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cms.optimizely.com/v1/content/{key}/assets"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "items": [
    {
      "key": "",
      "container": "",
      "owner": "",
      "contentType": "",
      "primaryLocale": "",
      "locales": [
        ""
      ],
      "lastModified": "",
      "lastModifiedBy": "",
      "created": "",
      "createdBy": "",
      "deleted": "",
      "deletedBy": ""
    }
  ],
  "pageIndex": "",
  "pageSize": "",
  "totalCount": ""
}

401

// Unauthorized

403

// Forbidden

404

// Not Found

429

// Too Many Requests
{
  "type": "",
  "title": "",
  "status": "",
  "detail": "",
  "instance": "",
  "code": "",
  "errors": [
    {
      "detail": "",
      "field": "properties.header.displayName"
    }
  ]
}

500

// Internal Server Error