Replace document
Writes a document whole, over the version last read. The body is checked against the document's format and stored in its standard form. Send If-Match with the ETag last read; a document changed since answers 412. Cards don't exist until first written: send If-None-Match: * for that write. A document an agent writes changes only what agents change in the saved one: any other part changed answers 422, an issue for each.
Writes a document whole, over the version last read.
The body is checked against the document's format and stored in its standard form. Send If-Match with the ETag last read; a document changed since answers 412. Cards don't exist until first written: send If-None-Match: * for that write. A document an agent writes changes only what agents change in the saved one: any other part changed answers 422, an issue for each.
x-api-key<token>Scope: manuals:write
id*string^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$name*string"labels""image-settings""cards"if-match?stringif-none-match?stringapplication/json- body
format*44manualId*string^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$template?labelTypes*array<>pageTypes*array<>pages*array<>regions*array<>groups*array<>linkedElements*array<>order?array<>The version now stored
application/json- response
name*string"labels""image-settings""cards"format*integerversion*integercurl -X PUT 'https://www.chameleonlabs.org/api/manuals/string/documents/labels' \ -H 'Content-Type: application/json' \ -d '{ "format": 4, "manualId": "string", "labelTypes": [ { "id": "string", "name": "string", "color": [ 0, 0, 0 ] } ], "pageTypes": [ { "id": "string", "name": "string" } ], "pages": [ { "page": 1, "size": [ 100000, 100000 ] } ], "regions": [ { "id": "string", "page": 1, "polygon": [ [ -100000, -100000 ], [ -100000, -100000 ], [ -100000, -100000 ] ], "labelType": "string", "name": "string" } ], "groups": [ { "id": "string", "name": "string", "members": [ "string" ] } ], "linkedElements": [ { "id": "string", "name": "string" } ]}'{ "name": "labels", "format": 0, "version": 0}Get document GET
A manual's labels, image settings or cards, as last saved.
List assets GET
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.