GET /raw-files/{id}

1 min

GET

https://api.cmp.optimizely.com/v3/raw-files/{id}

Get a raw file

Path Parameters

idstringrequired
Example
5d7f910551b00a722e0418830cee6634
Description
Unique identifier of the raw file

Responses

200Fetched raw file

LibraryRawFile
- idstringrequired
  Example
  5d7f910551b00a722e0418830cee6634
  Description
  Unique identifier of the raw file
- titlestringrequired
  Example
  documents.zip
  Description
  Title of the raw file
- descriptionstringrequired
  Example
  Very important file
  Description
  Description of the raw file
- mime_typestringrequired
  Example
  application/zip
  Description
  MIME type of the raw file
- file_extensionstringrequired
  Example
  zip
  Description
  File extension 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
- folder_idstringrequired
  Example
  6bb8db20a5b611ebae319b7c541b1a5a
  Description
  ID of the folder containing the raw file in the library
- file_locationstringrequired
  Example
  /all files/
  Description
  Location of the folder containing the raw file in the library
- is_archivedbooleanrequired
  Description
  Whether the raw file is archived or not
- is_publicbooleanrequired
  Example
  true
  Description
  Whether the raw file URL is public or not
- allow_se_indexingbooleanrequired
  Example
  true
  Description
  Whether the raw file is allowed to be indexed by search engines
- 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
- owner_organization_idstringrequired
  Example
  5108c3a9becac35915111191
  Description
  ID of owner organization of the raw file
- expires_atstring<date-time>required
  Example
  2019-10-07T13:15:30Z
  Description
  Date and time for the expiration of the raw file, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- thumbnail_urlstringrequired
  Example
  http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==
  Description
  URL of the thumbnail of the raw file
- version_numberintegerrequired
  Example
  2
  Description
  Version number of raw file
- version_idstringrequired
  Example
  5d7f910551b00a722e0418830cee6631
  Description
  Version id of raw file
- tagsTag[]required
  Description
  Tags for the raw file
  - guidstringrequired
    Example
    5d7f910551b00a722e0418830cee6633
    Description
    Unique identifier of the tag
  - namestringrequired
    Example
    Sample Tag
    Description
    Name of the tag
- attribution_textstringrequired
  Example
  Text
  Description
  Attribution of raw file
- owner_idstringrequired
  Example
  5108c3a9becac35915111191
  Description
  ID of the raw file owner

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/raw-files/{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/raw-files/{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/raw-files/{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/raw-files/{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",
  "description": "Very important file",
  "mime_type": "application/zip",
  "file_extension": "zip",
  "created_at": "2019-10-06T13:15:30Z",
  "modified_at": "2019-10-07T13:15:30Z",
  "file_size": 11244,
  "folder_id": "6bb8db20a5b611ebae319b7c541b1a5a",
  "file_location": "/all files/",
  "is_archived": false,
  "is_public": true,
  "allow_se_indexing": true,
  "url": "https://files.cmp.optimizely.com/171451644651701b96f1122009f026bc",
  "labels": [
    {
      "group": {
        "id": "2467e583a60e23fda2b89db81a453cd2",
        "name": "Content Format"
      },
      "values": [
        {
          "id": "71c378f3fee3d822759d1bdc2aab628c",
          "name": "Photos"
        }
      ]
    }
  ],
  "owner_organization_id": "5108c3a9becac35915111191",
  "expires_at": "2019-10-07T13:15:30Z",
  "thumbnail_url": "http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==",
  "version_number": 2,
  "version_id": "5d7f910551b00a722e0418830cee6631",
  "tags": [
    {
      "guid": "5d7f910551b00a722e0418830cee6633",
      "name": "Sample Tag"
    }
  ],
  "attribution_text": "Text",
  "owner_id": "5108c3a9becac35915111191"
}

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