Skip to Content
Chameleon Docs

List assets

The manual's asset index, each picture's link and how each asset stands. The index is the saved one as the saved labels place it: every asset in the labels' order, with the name, label type, count, link, parent and groups the labels give its region, so a new order or a new name shows here once the labels are saved, with no job. What was made of each asset is as the last build left it. An asset whose region is gone is dropped as the labels are saved; while a job runs it is kept, after the rest, until the job's end drops it. The pictures uploaded to the manual are listed apart from the index, oldest first, and placed by their IDs as its pictures are.

GET
/api/manuals/{id}/assets

The manual's asset index, each picture's link and how each asset stands.

The index is the saved one as the saved labels place it: every asset in the labels' order, with the name, label type, count, link, parent and groups the labels give its region, so a new order or a new name shows here once the labels are saved, with no job. What was made of each asset is as the last build left it. An asset whose region is gone is dropped as the labels are saved; while a job runs it is kept, after the rest, until the job's end drops it. The pictures uploaded to the manual are listed apart from the index, oldest first, and placed by their IDs as its pictures are.

Authorization

headerx-api-key<token>

Scope: manuals:read

Path Parameters

id*string
Match^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response Body

The library; an index of nothing until a breakdown or a regeneration

application/json
  1. response
index*
version*integer|null
standApart*array<>
statuses*array<>
uploads*array<>
uploadStorage*
links*
Example Request
curl -X GET 'https://www.chameleonlabs.org/api/manuals/string/assets'
Example Response
{  "index": {    "format": 3,    "manualId": "string",    "assets": [      {        "id": "string",        "page": 1,        "name": "string",        "labelType": "string",        "count": 1,        "link": "string",        "parent": "string",        "groups": [          "string"        ],        "fingerprint": "string",        "producedBy": {          "process": "breakdown",          "jobId": "string"        },        "kind": "picture",        "picture": {          "src": "string",          "hash": "string",          "width": 1,          "height": 1,          "scale": 1,          "origin": [            -100000,            -100000          ],          "resolution": 1,          "measures": {            "clearShare": 0,            "holeShare": 0,            "smallHoles": 0,            "edgeShare": 0,            "specksDropped": 0          }        }      }    ],    "groups": [      {        "id": "string",        "name": "string",        "count": 1,        "members": [          "string"        ]      }    ],    "linkedElements": [      {        "id": "string",        "name": "string",        "count": 1      }    ],    "order": [      "string"    ]  },  "version": 0,  "standApart": [    {      "id": "string",      "on": [        "clearShare"      ]    }  ],  "statuses": [    {      "id": "string",      "status": "current"    }  ],  "uploads": [    {      "id": "string",      "kind": "picture",      "name": "string",      "picture": {        "src": "string",        "hash": "string",        "width": 0,        "height": 0      },      "uploadedAt": "2019-08-24T14:15:22Z"    }  ],  "uploadStorage": {    "usedBytes": 0,    "limitBytes": 0  },  "links": {    "property1": {      "url": "http://example.com",      "expiresAt": "2019-08-24T14:15:22Z"    },    "property2": {      "url": "http://example.com",      "expiresAt": "2019-08-24T14:15:22Z"    }  }}