Selection Actions

Generated selection actions operations.

DELETE/v1/selection-actions/{operationId}Stop further command effects while preserving completed outcomesplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: cancel_selection_action

Parameters

Name	In	Type	Description
`operationId`required	path	`string`

Responses

200Successapplication/json

Example

{
  "action": "delete",
  "admitted": 0,
  "bytesDeleted": 0,
  "done": 0,
  "errorCode": "string",
  "failed": 0,
  "filesDeleted": 0,
  "operationId": "id_8h2k4q",
  "retryAfterMs": 1800000,
  "state": "capturing",
  "total": 1
}

Schema

actionstringrequiredone of "delete", "download"
admittedintegerrequired≥ 0
bytesDeletedintegerrequired≥ 0
doneintegerrequired≥ 0
errorCodestring
failedintegerrequired≥ 0
filesDeletedintegerrequired≥ 0
operationIdstringrequiredlength 1–160pattern ^[A-Za-z0-9_-]+$
retryAfterMsintegerrequired0–60000
statestringrequiredone of "capturing", "sealed", "running", "cancelling", "complete", "partial", "failed", "cancelled"
totalintegerrequired≥ 1

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundstale_continuationrate_limitedidempotency_key_reusedinternaltimeoutdatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/selection-actions/{operationId}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/selection-actions/{operationId}Read confirmed command progressread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_selection_action

Parameters

Name	In	Type	Description
`operationId`required	path	`string`

Responses

200Successapplication/json

Example

{
  "action": "delete",
  "admitted": 0,
  "bytesDeleted": 0,
  "done": 0,
  "errorCode": "string",
  "failed": 0,
  "filesDeleted": 0,
  "operationId": "id_8h2k4q",
  "retryAfterMs": 1800000,
  "state": "capturing",
  "total": 1
}

Schema

actionstringrequiredone of "delete", "download"
admittedintegerrequired≥ 0
bytesDeletedintegerrequired≥ 0
doneintegerrequired≥ 0
errorCodestring
failedintegerrequired≥ 0
filesDeletedintegerrequired≥ 0
operationIdstringrequiredlength 1–160pattern ^[A-Za-z0-9_-]+$
retryAfterMsintegerrequired0–60000
statestringrequiredone of "capturing", "sealed", "running", "cancelling", "complete", "partial", "failed", "cancelled"
totalintegerrequired≥ 1

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundstale_continuationrate_limitedidempotency_key_reusedinternaltimeoutdatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/selection-actions/{operationId}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"