Home Page > Integration > REST API > Sizes

Sizes

Sizes - /REST/1/Sizes/:id

 

This endpoint is used for manipulating Size resources within the system. Objects are always returned in a JSON format within an array. Empty results return an empty array.

 

Object

The Size resource is represented with the following JSON object:

[
    { 
      "alive" : "<bool>",
      "always_create" : "<bool>",
      "colourspace" : "<enum>",
      "crop_to_fit" : "<bool>",
      "description" : "<text>",
      "display_order" : "<int>",
      "file_format" : "<enum>",
      "height" : "<int>",
      "id" : "<int>",
      "name" : "<string>",
      "original" : "<bool>",
      "postfix" : "<string>",
      "protected" : "<bool>",
      "quality" : "<int>",
      "size_protected" : "<int>",
      "use_for_contact_sheet" : "<bool>",
      "use_for_power_point" : "<bool>",
      "use_for_zip" : "<bool>",
      "width" : "<int>",
      "x_resolution" : "<int>",
      "y_resolution" : "<int>"
   }
]

 

GET

As with other resources, this resource is subject to the global parameters mentioned in the REST Overview.

 

PUT

 

POST

The following JSON parameters are required when creating a resource:

 

JSON Parameter Allowed value
postfix string
file_format enum (see above)
colourspace enum (see above)
width int
height int
always_create bool

 

DELETE

The resource can be deleted using this verb and including the id in the endpoint URL.

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.