Get a workflow task

Get a workflow task.

Request syntax

GET /workflows/${WORKFLOW_ID}/tasks/${TASK_ID} HTTP/1.1
Host: api.simworkflow.com
Authorization: Bearer ${PERSONAL_ACCESS_TOKEN}

Request headers

Authorization	`Bearer ${PERSONAL_ACCESS_TOKEN}`

Response syntax

HTTP/1.1 200 OK
{
  "id": String,
  "workflowId": String,
  "organizationId": String,
  "workflowDefinitionId": String,
  "workflowDefinitionVersion": Integer,
  "taskName": String,
  "input": {
    ...JSON,
    "swf:taskName": String,
    "swf:workflowId": String,
    "swf:createdOn": Timestamp,
    "swf:updatedOn": Timestamp,
    "swf:createdBy": {
      "id": Timestamp,
      "organizationId": Timestamp,
      "fullName": Timestamp,
      "email": Timestamp,
      "disabled": Boolean,
      "locked": Boolean
    },
    "swf:updatedBy": {
      "id": Timestamp,
      "organizationId": Timestamp,
      "fullName": Timestamp,
      "email": Timestamp,
      "disabled": Boolean,
      "locked": Boolean
    }
  },
  "output": JSON,
  "status": String,
  "systemTask": Boolean,
  "createdOn": Timestamp,
  "createdBy": {
    "id": Timestamp,
    "organizationId": Timestamp,
    "fullName": Timestamp,
    "email": Timestamp,
    "disabled": Boolean,
    "locked": Boolean
  },
  "modifiedOn": Timestamp,
  "modifiedBy": {
    "id": Timestamp,
    "organizationId": Timestamp,
    "fullName": Timestamp,
    "email": Timestamp,
    "disabled": Boolean,
    "locked": Boolean
  }
}

Response elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the body contains the workflow JSON.

Errors

cURL example: get a workflow task

GET /workflows/23bBE1NGSll5narSt8NLsy/tasks/4qBMWPZxMPPC26Oogs047K

curl \
--request "GET" \
--header "Authorization: Bearer ${PERSONAL_ACCESS_TOKEN}" \
--url "https://api.simworkflow.com/workflows/23bBE1NGSll5narSt8NLsy/tasks/4qBMWPZxMPPC26Oogs047K"

RESPONSE

HTTP/1.1 200 OK
{
  "id": "4qBMWPZxMPPC26Oogs047K",
  "workflowId": "23bBE1NGSll5narSt8NLsy",
  "organizationId": "0y4OfYajRyqc2RNueODHww",
  "workflowDefinitionId": "7RXzkCER4ERYGpMzvrfy1D",
  "workflowDefinitionVersion": 2,
  "taskName": "Issue",
  "input": {
    "key": "ISS-33",
    "page": "7d7vCZdVD45eGiL9xLjgAC",
    "type": "Task",
    "status": "Open",
    "summary": "",
    "assignee": null,
    "priority": "Medium",
    "swf:taskId": "4qBMWPZxMPPC26Oogs047K",
    "attachments": null,
    "description": "",
    "swf:taskName": "Issue",
    "swf:workflowId": "23bBE1NGSll5narSt8NLsy",
    "swf:createdOn": "2023-11-06T15:02:44.359Z",
    "swf:updatedOn": "2023-11-10T02:26:29.730Z",
    "swf:createdBy": {
      "id": "5ZnzgxJWTtHhXbmHK31sEb",
      "organizationId": "0y4OfYajRyqc2RNueODHww",
      "fullName": "John Smith",
      "email": "john.smith@simworkflow.com",
      "disabled": false,
      "locked": false
    },
    "swf:updatedBy": {
      "id": "5ZnzgxJWTtHhXbmHK31sEb",
      "organizationId": "0y4OfYajRyqc2RNueODHww",
      "fullName": "John Smith",
      "email": "john.smith@simworkflow.com",
      "disabled": false,
      "locked": false
    }
  },
  "output": {
    "type": "Task",
    "status": "Open",
    "summary": "Attachments",
    "priority": "Medium",
    "swf:taskId": "4qBMWPZxMPPC26Oogs047K",
    "description": "This is a test task.",
    "swf:workflowId": "23bBE1NGSll5narSt8NLsy"
  },
  "status": "Completed",
  "systemTask": false,
  "createdOn": "2023-11-06T15:02:44.359Z",
  "createdBy": {
    "id": "5ZnzgxJWTtHhXbmHK31sEb",
    "organizationId": "0y4OfYajRyqc2RNueODHww",
    "fullName": "John Smith",
    "email": "john.smith@simworkflow.com",
    "disabled": false,
    "locked": false
  },
  "modifiedOn": "2023-11-10T02:26:29.730Z",
  "modifiedBy": {
    "id": "5ZnzgxJWTtHhXbmHK31sEb",
    "organizationId": "0y4OfYajRyqc2RNueODHww",
    "fullName": "John Smith",
    "email": "john.smith@simworkflow.com",
    "disabled": false,
    "locked": false
  }
}