Assets

Notify a workflow phase change

POSThttps://api-staging.pixwel.com/api/assets/{id}/workflow/notify

Sends phase-change notifications for a single asset, optionally with a note. Mutates a single asset; it is not a collection endpoint.

Path parameters

idstringrequired

Body

phasestringrequired

The workflow phase the note belongs to. Must be non-empty and match the asset's current phase, or the request is rejected as a concurrent modification.

notestring

Note body. Trimmed; an empty value clears the note.

Response

_idstring

studiostring

projectstring

namestring

usageobject

curl -X POST 'https://api-staging.pixwel.com/api/assets/{id}/workflow/notify' \ -H 'Authorization: Basic <credentials>' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "phase": "string", "note": "string" }'

{ "_id": "507f1f77bcf86cd799439011", "studio": "507f1f77bcf86cd799439011", "project": "507f1f77bcf86cd799439011", "name": "string", "usage": { "broadcast": true, "online": true, "dcp": true, "film35": true, "film70": true, "dcp4k": true, "imax": true, "atmos": true }, "importName": "string", "slug": "string", "type": "string", "thumbnail": "507f1f77bcf86cd799439011", "verified": true, "previews": [ { "_id": "507f1f77bcf86cd799439011", "asset": "507f1f77bcf86cd799439011", "created": 0, "label": "string", "language": "string", "project": "507f1f77bcf86cd799439011", "revision": "string", "studio": "507f1f77bcf86cd799439011", "type": "string", "cdn": { "domain": "string", "path": "string", "key": "string" } } ], "created": 0, "mediaType": "string", "creative": true, "$links": { "self": "//example.com/path/to/object", "thumbnail": "//example.com/path/to/object", "project": "//example.com/path/to/object", "studio": "//example.com/path/to/object", "type": "//example.com/path/to/object", "transcription": "//example.com/path/to/object" }, "$flags": null, "$permissions": { "canAutosub": true, "sources": { "requests": { "languages": null, "countries": null }, "autosubs": { "languages": null, "countries": null } }, "access": [ "string" ], "tags": { "online": true, "broadcast": true, "dcp": true, "cmyk": true, "rgb": true }, "ingest": [ "string" ] }, "$embargo": true, "$feedback": { "share": null, "vote": null, "summary": null }, "transcription": { "script": "507f1f77bcf86cd799439011", "_id": "507f1f77bcf86cd799439011", "graphics": "507f1f77bcf86cd799439011" }, "creator": "507f1f77bcf86cd799439011", "private": true, "unorderable": true, "aspectRatio": "string", "autosubIngest": "507f1f77bcf86cd799439011", "notifyUrl": "https://example.com/path/to/object", "embargo": 0 }