Home Page > Integration > REST API > Albums > Files

Files

Albums/:id/Files

This endpoint is used for manipulating Files attached to an Album Object. Objects are always returned in a JSON format within an array. Empty results return an empty array.

 

Object

The Album nested File object takes on the following JSON object:

[
    {
        "display_order": "<int>",
        "id": "<int>"
    }
]

 

GET

This verb is used for retrieving resources, it is subject to the parameters mentioned in the overview and all fields mentioned above are searchable.

 

PUT

This verb is used to modify the File objects attached to this Object. It takes the above format, but display_order is optional.

 

POST

This verb is used for adding File's to an Album, it is syntactical sugar. Below is a curl example which :

curl -u admin:admin http://my.openasset/REST/1/Albums/1/Files/145 -X POST

 

DELETE

This verb is used for removing a File from an Album. It follows the same syntax as the POST example, except the verb changes.

Last modified
07:16, 20 Mar 2015

Tags

This page has no custom tags.

Classifications

This page has no classifications.