actor.resource.control

Generated at from openvibe-contracts v0.177.0 and openvibe-sdk v0.44.0.

Not grantable to apps (active, first-party).

Control a task through OpenVibe.Actor's control API (ADR-048, plan T13 step 10): POST /api/v1/resources/control takes one common.resource-control-request@1 naming an actor.task by its OVRN, from a first-party service (OpenVibe.Services) acting for the person in on_behalf_of. Action: stop (cancel the task: a queued task ends at once, a running one is aborted and ends cancelled when its current step returns; its cost so far is kept and charged as usual); a task that already ended answers done with changed false. Any other action is refused unsupported (Actor deletes tasks only with the person's account data). Only the person who asked for the task may act on it, and only inside the project the OVRN names. dry_run decides and explains without applying. The first answer per (caller, project, idempotency_key) is kept and returned for a repeat; the same key with another request is refused. Answers common.resource-control-result@1.

Owner
actor (token audience openvibe.actor)
Version
1.0
Status
active
Visibility
first-party
Resource constraints
project
Quota class
standard
Permissions
resources:control
Input
common.resource-control-request@1
Output
common.resource-control-result@1
Events
—
Implemented by
  • POST /api/v1/resources/control

These routes in the API explorer