DATA Services
- Joël DRIGO
Overview
These services are of the same type as DAM services (they work exactly the same way) but are configured by explicit configurations (in Json). The configuration of the properties can be generated automatically by the same system as for the DAM services, by assigning the value true to the auto property.
End points
The general form of end points for resources in this category is as follows:
api/rest/data/{resource{/<optional URI extension>}
End point to retrieve a list
GET api/rest/data/{resource}
This end point allows you to list, search (fulltext or queries), or get suggestions (autocompletion), or get tree structures (see fast tree service).
You get a limited list of resource instances and a token that allows you to get the continuation, still limited, with its token that allows you to get the continuation and so on.
To get several resources, use comma-separated list. By example, GET api/rest/data/asset,legacy.
You can find more details on how to use this end point here.
End point to retrieve a paginated list
GET api/rest/data/{resource}/list
This service does the same thing as the service described above, but in the form of a so-called paginated list: an index of the first instance of the desired resource and of the last instance is specified. We can thus obtain an interval of instances called page.
You can find more details on how to use this end point here
End point to retrieve a given asset
GET api/rest/data/{resource}/{id}
End point to retrieve aggregates
GET api/rest/data/{resource}/aggs
End point to create a workcopy
GET api/rest/data/{resource}/{id}/workcopy
End point to get binary
GET api/rest/data/{resource}/{id}/$binary
End point to get binary variation
GET api/rest/data/{resource}/{id}/$variation
End point to get binary player
GET api/rest/data/{resource}/{id}/$player
End point to get binary preview (thumbnail)
GET api/rest/data/{resource}/{id}/$preview
End point to assign a collection item
POST api/rest/data/{resource}/{id}/{collectionProperty}
End point to create a resource
POST api/rest/data/{resource}
End points to update a resource
PUT api/rest/data/{resource}/{id}
PATCH api/rest/data/{resource}/{id}
POST api/rest/data/{resource}/{id}/put
POST api/rest/data/{resource}/{id}/patch
POST api/rest/data/{resource}
End point to delete a resource
DELETE api/rest/data/{resource}/{id}
End point to update several resources
PUT api/rest/data/{resource}/{id}
PATCH api/rest/data/{resource}/{id*}
POST api/rest/data/{resource}/{id*}/put
POST api/rest/data/{resource}/{id*}/patch
End point to delete several resources
DELETE api/rest/data/{resource}{/id*}
End point to lock a resource
POST api/rest/data/{resource}/{id}/lock
End point to unlock a resource
POST api/rest/data/{resource}/{id}/unlock
End point to change workflow state of a resource
POST api/rest/data/{resource}/{id}/workflow
End point to change workflow state of several resources
POST api/rest/data/{resource}/{id*}/workflow
End point to retrieve workflow actions
GET api/rest/data/{resource}/workflow
End point to retrieve workflow actions possible on a resource
GET api/rest/data/{resource}/{id}/workflow
In addition
headers
The headers are the description of the properties of the resource: type of data, possibility of modification, information for the display in a GUI, etc.
GET api/rest/data/{resource}/headers
Catalogs
Catalogs provide a list of existing resources and their descriptions
GET api/rest/data
Â