GET /tasks/{task_id}/raw-files/{raw_file_id}

1 min

GET

https://api.cmp.optimizely.com/v3/tasks/{task_id}/raw-files/{raw_file_id}

Get a raw file associated with the task identified by task_id.

Path Parameters

task_idstringrequired
Example
5f857f30e1c4a2038d6179e9
Description
Unique identifier of the task
raw_file_idstringrequired
Example
5d7f910551b00a722e0418830cee6634
Description
Unique identifier of the raw file associated with the task

Responses

200Fetched raw file

TaskRawFile
- idstringrequired
  Example
  5d7f910551b00a722e0418830cee6634
  Description
  Unique identifier of the raw file
- titlestringrequired
  Example
  documents.zip
  Description
  Title of the raw file
- mime_typestringrequired
  Example
  application/zip
  Description
  MIME type of the raw file
- created_atstring<date-time>required
  Example
  2019-10-06T13:15:30Z
  Description
  Date and time on which the raw file was created, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- modified_atstring<date-time>required
  Example
  2019-10-07T13:15:30Z
  Description
  Date and time of the most recent modification of the raw file, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- file_sizeintegerrequired
  Example
  11244
  Description
  Size of the raw file in bytes
- urlstringrequired
  Example
  https://files.cmp.optimizely.com/171451644651701b96f1122009f026bc
  Description
  Download the URL of the raw file
- labelsResourceLabelResponse[]required
  Description
  Labels associated to the raw file
  - groupobjectrequired
    Description
    Label group
    - idstringrequired
      Example
      2467e583a60e23fda2b89db81a453cd2
      Description
      Identifier of the label group
    - namestringrequired
      Example
      Content Format
      Description
      Name of the label group
  - valuesobject[]required
    Description
    List of values of the label
    - idstringrequired
      Example
      71c378f3fee3d822759d1bdc2aab628c
      Description
      Identifier of the label value
    - namestringrequired
      Example
      Photos
      Description
      Name of the label value
- library_asset_idstring
  Example
  6a8b2c3d4e5f6071829a3b4c
  Description
  Unique identifier of the corresponding library asset — the library asset this task asset was forked from, or the one it was released to.
- linksobjectrequired
  Description
  Meta links
  - selfstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/raw-files/5d7f910551b00a722e0418830cee6634
    Description
    URL of the raw file
  - taskstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9
    Description
    URL of the task that the raw file is associated with
  - draftsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets/5d7f910551b00a722e0418830cee6634/drafts
    Description
    URL to POST draft to the raw file
  - web_urlsobjectrequired
    Description
    Web URLs
    - selfstringrequired
      Example
      https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9?contentTabGuid=5d7f910551b00a722e0418830cee6634
      Description
      Web URL of the raw file
    - taskstringrequired
      Example
      https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9
      Description
      Web URL of the task that the raw file is associated with
    - draftsstringrequired
      Example
      https://cmp.optimizely.com/cloud/task/5f857f30e1c4a2038d6179e9/raw_file/5d7f910551b00a722e0418830cee6634
      Description
      Web URL of the drafts of the raw file

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}/raw-files/{raw_file_id} \
     --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}/raw-files/{raw_file_id}", 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}/raw-files/{raw_file_id}")

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}/raw-files/{raw_file_id}"

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

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

print(response.text)

200

// Fetched raw file
{
  "id": "5d7f910551b00a722e0418830cee6634",
  "title": "documents.zip",
  "mime_type": "application/zip",
  "created_at": "2019-10-06T13:15:30Z",
  "modified_at": "2019-10-07T13:15:30Z",
  "file_size": 11244,
  "url": "https://files.cmp.optimizely.com/171451644651701b96f1122009f026bc",
  "labels": [
    {
      "group": {
        "id": "2467e583a60e23fda2b89db81a453cd2",
        "name": "Content Format"
      },
      "values": [
        {
          "id": "71c378f3fee3d822759d1bdc2aab628c",
          "name": "Photos"
        }
      ]
    }
  ],
  "library_asset_id": "6a8b2c3d4e5f6071829a3b4c",
  "links": {
    "self": "https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/raw-files/5d7f910551b00a722e0418830cee6634",
    "task": "https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9",
    "drafts": "https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets/5d7f910551b00a722e0418830cee6634/drafts",
    "web_urls": {
      "self": "https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9?contentTabGuid=5d7f910551b00a722e0418830cee6634",
      "task": "https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9",
      "drafts": "https://cmp.optimizely.com/cloud/task/5f857f30e1c4a2038d6179e9/raw_file/5d7f910551b00a722e0418830cee6634"
    }
  }
}

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": ""
}