GET /rendition-configs/{id}

1 min

GET

https://api.cmp.optimizely.com/v3/rendition-configs/{id}

Experimental Get a rendition configuration of an organization given its id.

Path Parameters

idstringrequired
Example
5d7f910551b00a722e0418830cee6631
Description
Unique identifier of the rendition configuration

Responses

200Data of a rendition configuration

RenditionConfigResponse
- idstringrequired
  Example
  5d7f910551b00a722e0418830cee6631
  Description
  Unique identifier of the rendition config
- namestringrequired
  Example
  Facebook
  Description
  Name of the rendition config
- asset_typestringrequired
  Example
  image
  Description
  The asset type this config applies to
- widthintegerrequired
  Example
  600
  Description
  The expected width (in pixels) of the renditions generated using this config
- heightintegerrequired
  Example
  400
  Description
  The expected height (in pixels) of the renditions generated using this config
- input_formatstringrequired
  Example
  JPG
  Description
  The file format of the target asset
- output_formatstringrequired
  Example
  PNG
  Description
  The file format of the generated rendition
- qualitynumberrequired
  Example
  80
  Description
  The quality (percent) of the renditions generated using this config

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/rendition-configs/{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/rendition-configs/{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/rendition-configs/{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/rendition-configs/{id}"

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

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

print(response.text)

200

// Data of a rendition configuration
{
  "id": "5d7f910551b00a722e0418830cee6631",
  "name": "Facebook",
  "asset_type": "image",
  "width": 600,
  "height": 400,
  "input_format": "JPG",
  "output_format": "PNG",
  "quality": 80
}

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