Tasks

Transition a task to Processing

Transition a task to Processing. Allowed only for the owner service or extension. Valid when status is Queued or Rescheduled.

post/public/v1/system/tasks/{id}/execute

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/system/tasks/{id}/execute
  • Auth: none declared

Path parameters

idstring required

The task ID.

Response

OK

idstring
namestring
iconstring nullable
revisioninteger
status'Queued' | 'Processing' | 'Completed' | 'Failed' | 'Rescheduled'
codestring

Task code for the workflow, prefixed with the service namespace.

queuestring

Queue name for task execution, prefixed with the controlling service namespace.

descriptionstring

Parameterized task description.

progressnumber float nullable

Progress in percent. 0-100 or not defined for not yet started task.

etastring date-time nullable

Estimated finish time, if any.

parametersunknown
resultstring nullable

Result URI or reference to the result resource.

externalIdstring nullable

External identifier for task correlation.

Example response

{
  "code": "platform.accounts.buyers.transfer",
  "queue": "marketplace/platform/internal/buyers/commands",
  "object": {
    "id": "BUY-1190-0394",
    "name": "Buyer Account",
    "icon": "/public/v1/accounts/buyers/BUY-1190-0394/icon"
  },
  "description": "Transferring buyer 'BUY-1190-0394' to account 'ACC-5563-4382'",
  "parent": {
    "code": "platform.accounts.buyers.transfer"
  },
  "progress": 45.5,
  "eta": "2026-02-02T14:30:00+00:00",
  "parameters": {
    "BuyerId": "BUY-1190-0394",
    "TargetAccountId": "ACC-5563-4382"
  },
  "result": "/public/v1/accounts/buyers/BUY-1190-0394",
  "externalId": "3f7e7800-b929-4bf3-a969-a8ed5354ff27",
  "access": [
    {
      "id": "ACC-0000-0001",
      "name": "SoftwareONE Operations"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.