v1
latestOpenAPI 3.0.02026-07-2417611.8 MBRetrieve all assets.
Use this endpoint to retrieve all assets from the database.<br />User roles: admin, manager, editor, viewer
Query parameters
Set the limit for the maximum number of assets to return in a single result. Set to 50 by default.
Use the offset parameter to specify the number of assets to skip from the beginning of the list and return the rest.
Only the asset fields that are specified here are returned for each result. Any asset field is a valid value and these can be specified in a comma-separated list. For example, to list the asset fields name and ID, provide the value ID, and name. All asset fields are returned by default.
Optional: Parameters used to include additional fields inside each returned asset. Use "links" to include the links section, which contains URLs for actions that can be performed on the asset. Use "metadata" to include additional fields for each of the items referenced by the asset You can specify multiple fields as a comma-separated value. For example, "include=links,metadata".
Response
Successfully lists a paged result view of all the asset in the database.
Example response
{
"limit": 50,
"href": "/asset?offset=50&limit=50",
"next": "/asset?offset=100&limit=50",
"previous": "/asset?offset=0&limit=50",
"items": [
{
"id": "0a800487f06d71eaf4cffdfde1ab28bc",
"rev": "2-c839bbb8844549c2e298275c4b2adcb8",
"description": "This is an image of a person.",
"creatorId": "e98c185a-cafb-4c32-ad94-dd4ffaa28a7e",
"lastModifierId": "e98c185a-cafb-4c32-ad94-dd4ffaa28a7e",
"fileName": "hub.png",
"fileSize": 123125,
"mediaType": "image/png",
"tags": {
"values": [
"faces:Lebron James",
"sports",
"basketball"
]
},
"resource": "67c621ed48921b7338b84b4f415cba6b",
"digest": "9jwWuI3TN+PhGfHcrSJHcQ==",
"path": "/sales/images/hub.png",
"categoryIds": [],
"profiles": [
"8b4698e3-6283-4bc5-9e1e-fff69c2b48be"
],
"profileRenditions": [
{
"profileId": "a35f02ce-9f31-4832-8ed5-2b6d9c8b8d86",
"profileName": "Profile E",
"key": "renditionF",
"label": "Rendition F",
"transform": {
"scale": 0.0862,
"crop": {
"x": 0,
"y": 0,
"width": 10,
"height": 10
}
},
"uri": "/authoring/v1/resources/e17b2c51-a74e-4332-80df-0f6d9340426c?resize=10px:10px&crop=10:10;0,0",
"width": 10,
"height": 10
},
{
"profileId": "a35f02ce-9f31-4832-8ed5-2b6d9c8b8d86",
"profileName": "Profile E",
"key": "renditionG",
"label": "Rendition G",
"transform": {
"scale": 0.17241,
"crop": {
"x": 0,
"y": 0,
"width": 20,
"height": 20
}
},
"uri": "/authoring/v1/resources/e17b2c51-a74e-4332-80df-0f6d9340426c?resize=20px:20px&crop=20:20;0,0",
"width": 20,
"height": 20
}
],
"links": {
"self": {
"href": "/authoring/v1/assets/1e5fecbb-04aa-4ed2-a014-8e544ad97597:draft"
},
"media": {
"href": "/authoring/v1/resource/myResource.jpeg"
},
"thumbnail": {
"href": "/authoring/v1/resource/myResource.jpeg?fit=around|220:145&crop=220:145;*,*"
},
"ready": {
"href": "/authoring/v1/changes/asset/1e5fecbb-04aa-4ed2-a014-8e544ad97597:draft/status/ready"
},
"retire": {
"href": "/authoring/v1/changes/asset/1e5fecbb-04aa-4ed2-a014-8e544ad97597:draft/status/retire"
},
"linkedDoc": {
"href": "/authoring/v1/assets/1e5fecbb-04aa-4ed2-a014-8e544ad97597"
}
},
"usageRights": {
"categories": [
{
"id": "00000000-0000-0000-0000-021000c8e20",
"path": "Usage rights/Rights managed/Usage realm/Advertising"
}
],
"expiration": "2017-08-28T14:00:00Z"
},
"review": {
"id": "3356c048-96d0-4d8d-9afe-5e7ae47b127a",
"name": "my review",
"started": "2017-07-10T03:20:10Z",
"ends": "2017-07-10T03:20:10Z",
"ended": "2017-07-12T19:40:10Z"
},
"metadata": {
"width": 1000,
"height": 1000,
"camera": {
"make": "NIKON CORPORATION",
"model": "NIKON D90",
"focalLength": 35,
"shutterSpeed": "1/200",
"iso": 100,
"aperture": 8
},
"coverage": "1972-",
"creator": "Acoustic",
"Date": "2017-10-23T01:23:57Z",
"description": "The Acoustic logo.",
"publisher": "Acoustic",
"rights": "Acoustic",
"source": "Acoustic",
"title": "Acoustic Logo",
"headline": "The Acoustic logo."
},
"cognitive": {
"faces": [
{
"name": "Brad Pitt",
"gender": "Male",
"age": {
"minimum": 35,
"maximum": 44
}
}
],
"colors": {
"vibrant": "#c78061",
"muted": "#ae7157",
"darkVibrant": "#4c2c1c",
"darkMuted": "#50453f",
"lightVibrant": "#d4a185",
"lightMuted": "#d4bcac"
},
"entities": "people"
},
"altText": "This is an image of the Acoustic logo.",
"caption": "Acoustic",
"linkedDocId": "b289c02e-2c61-4643-aba6-e6b4e94c76e3",
"categories": [
"banner"
]
}
]
}