GET /tasks/{task_id}/assets/{asset_id}/drafts

1 min

GET

https://api.cmp.optimizely.com/v3/tasks/{task_id}/assets/{asset_id}/drafts

Experimental Get the list of drafts on an asset of a task.

Path Parameters

task_idstringrequired
Example
5f857f30e1c4a2038d6179e9
Description
Unique identifier of the task
asset_idstringrequired
Example
5d7f910551b00a722e0418830cee6631
Description
Unique identifier of the asset

Responses

200List of fetched drafts

object
- dataTaskAssetDraftListResponseItem[]required
  Description
  List of drafts
  - idstringrequired
    Example
    5d7f910551b00a722e0418830cee6631
    Description
    Unique identifier of the draft
  - draft_numberintegerrequired
    Example
    2
    Description
    The serial number of the draft
  - titlestringrequired
    Example
    sample_image.png
    Description
    Title of the draft
  - typestring<image | video | raw_file>required
    Example
    image
    Description
    Type of the draft
    Allowed
    imagevideoraw_file
  - mime_typestringrequired
    Example
    image/png
    Description
    MIME type of the draft
  - created_atstring<date-time>required
    Example
    2019-10-06T13:15:30Z
    Description
    Date and time on which the draft was created, in ISO 8601 UTC format (2020-02-10T10:40
    )
    Format
    date-time
  - contentobjectrequired
    Description
    Content of the draft
    - typestring<url>required
      Example
      url
      Description
      Type of the content
      Allowed
      url
    - valuestringrequired
      Example
      http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==S
      Description
      Content of the draft; download URL for image, raw file, and video
  - linksobjectrequired
    Description
    Meta links
    - assetstringrequired
      Example
      https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/images/5d7f910551b00a722e0418830cee6631
      Description
      URL of the asset that the draft is associated with
    - taskstringrequired
      Example
      https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9
      Description
      URL of the task that the asset is associated with
- paginationobjectrequired
  - Pagination
    - nextstringrequired
      Example
      https://api.cmp.optimizely.com/<some-path-to-next-page>?offset=10&page_size=10
      Description
      URL to the next page
    - previousstringrequired
      Description
      URL to the previous page
  - object
    - nextstring
      Example
      https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets/5d7f910551b00a722e0418830cee6631/drafts?offset=10&page_size=10

400Client error

Error
Example
```
{
  "message": "Unsupported arguments: a,b,c"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

404Not found error

Error
Example
```
{
  "message": "Resource not found"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request GET \
     --url https://api.cmp.optimizely.com/v3/tasks/{task_id}/assets/{asset_id}/drafts \
     --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.cmp.optimizely.com/v3/tasks/{task_id}/assets/{asset_id}/drafts", 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.cmp.optimizely.com/v3/tasks/{task_id}/assets/{asset_id}/drafts")

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.cmp.optimizely.com/v3/tasks/{task_id}/assets/{asset_id}/drafts"

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

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

print(response.text)

200

// List of fetched drafts
{
  "data": [
    {
      "id": "5d7f910551b00a722e0418830cee6631",
      "draft_number": 2,
      "title": "sample_image.png",
      "type": "image",
      "mime_type": "image/png",
      "created_at": "2019-10-06T13:15:30Z",
      "content": {
        "type": "url",
        "value": "http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==S"
      },
      "links": {
        "asset": "https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/images/5d7f910551b00a722e0418830cee6631",
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9"
      }
    }
  ],
  "pagination": {}
}

400

// Client error
{
  "message": "Not found",
  "errors": ""
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}

404

// Not found error
{
  "message": "Not found",
  "errors": ""
}