Update manual
Changes a manual's title, category or tags. A published manual's pack carries its title, so a new title writes the pack again under a new name and points the manual at it, which an agent may do only with the publish permission. A new title is refused while a job runs.
Changes a manual's title, category or tags.
A published manual's pack carries its title, so a new title writes the pack again under a new name and points the manual at it, which an agent may do only with the publish permission. A new title is refused while a job runs.
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}$application/json- body
title?string1 <= length <= 200categoryId?|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$tags?array<>items <= 50The manual as changed
application/json- response
id*string^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ownerId*stringtitle*stringcategoryId*|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$tags*array<string>source*|nulldocuments*hasAssets*booleanhasCards*booleancardCount*integerpublished*string"none""public""private"packKey*string|nullpublishedAt*|date-timepublishedCardCount*integer|nulljob*|nullcreatedAt*stringdate-timeupdatedAt*stringdate-timecurl -X PATCH 'https://www.chameleonlabs.org/api/manuals/string' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": "string", "ownerId": "string", "title": "string", "categoryId": "string", "tags": [ "string" ], "source": { "sha256": "string", "pageCount": 0, "pageSizes": [ { "width": 0, "height": 0 } ] }, "documents": { "labels": 0, "image-settings": 0, "cards": 0, "asset-index": 0 }, "hasAssets": true, "hasCards": true, "cardCount": 0, "published": "none", "packKey": "string", "publishedAt": "2019-08-24T14:15:22Z", "publishedCardCount": 0, "job": { "id": "string", "kind": "breakdown", "status": "running", "startedAt": "2019-08-24T14:15:22Z", "stoppedAt": "2019-08-24T14:15:22Z", "error": "string" }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}List manuals GET
The caller's manuals, last changed first.
Complete PDF upload POST
Inspects the uploaded PDF and records it as the manual's source. Call once the upload has finished. The PDF is checked and kept with its rotated pages flattened, and the manual records its page count and page sizes, and the labels its pages. A PDF the platform doesn't take is deleted and refused with the reason, and the next one needs a new upload.