PorticoDocs

Prepared Versions

Generated prepared versions operations.

POST/v1/prepared-versions/{id}/deleteRun prepared versions deletelibrary
Audience
Clients · Native API
Authorization
API key or personal access token with the library scope, or a signed-in session
OpenAPI operation ID
post_prepared_versions_id_delete
Max body
64 KiB

Parameters

NameInTypeDescription
idrequiredpathstring

Request body application/json · required

Example
{
  "expectedRevision": 0,
  "idempotencyKey": "string"
}
Schema
  • expectedRevisionintegerrequired
  • idempotencyKeystringrequired

Responses

200Successapplication/json

Example
{
  "createdMs": 1800000,
  "digest": "string",
  "editionId": "id_8h2k4q",
  "facts": {
    "audioBitDepth": 0,
    "audioChannels": 0,
    "audioCodec": "string",
    "audioSampleRate": 0,
    "audioTracks": 0,
    "container": "string",
    "durationMs": 1800000,
    "height": 0,
    "videoCodec": "string",
    "width": 0
  },
  "id": "id_8h2k4q",
  "itemId": "id_8h2k4q",
  "partIndex": 0,
  "profileId": "id_8h2k4q",
  "reason": "string",
  "revision": 0,
  "selectable": true,
  "size": 0,
  "sourceId": "id_8h2k4q",
  "sourceRevision": "r12",
  "state": "string",
  "targetId": "id_8h2k4q"
}
Schema
  • createdMsintegerrequired
  • digeststringrequired
  • editionIdstring | any | nullrequired
  • factsobjectrequired
    • audioBitDepthinteger
    • audioChannelsinteger
    • audioCodecstringrequired
    • audioSampleRateinteger
    • audioTracksintegerrequired
    • containerstringrequired
    • durationMsintegerrequired≥ 0
    • heightintegerrequired
    • videoCodecstringrequired
    • widthintegerrequired
  • idstringrequired
  • itemIdstringrequired
  • partIndexintegerrequired
  • profileIdstringrequired
  • reasonstringrequired
  • revisionintegerrequired
  • selectablebooleanrequired
  • sizeintegerrequired
  • sourceIdstringrequired
  • sourceRevisionstringrequired
  • statestringrequired
  • targetIdstringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/prepared-versions/{id}/delete" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0,"idempotencyKey":"string"}'