Complete a one-off task

Sets the task status to Completed. No-op if already completed. Returns the updated task.

post/work/tasks/{taskId}/complete

Request

Base URL
https://public-api.process.st/api/v1.1
URL
https://public-api.process.st/api/v1.1/work/tasks/{taskId}/complete
Auth
- API key in header X-API-Key
- or HTTP bearer

Path parameters

taskIdstring required

The ID of the One-Off Task

Response

Example response

{
  "data": {
    "id": "mhGeUiemI7MBoZxtbT95fQ",
    "createdBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "assignments": [
      {
        "user": {
          "id": "paiZa0_oyxEBoZxtatp33g",
          "email": "jane.doe@example.com",
          "username": "Jane Doe"
        }
      }
    ],
    "linkedWorkflowRun": {
      "id": "pz8IN1P4gwkBoZxtbVt2ew",
      "templateId": "pz8IN1P4gwkBoZxtbVt2ew"
    },
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}

Changes

No recorded changes to this operation across all 16 revisions of this API.