incidence

Add Task API Documentation

After receiving the access token from the OAuth API, use the Add Task API to create a new Task or Incident.

ACC Endpoint

https://acc.bzctrl.com/bzctrl-core-api/api/v1/task/add-task

Copy URL

Production Endpoint

https://www.bzctrl.com/bzctrl-core-api/api/v1/task/add-task

Copy URL

Request Method

POST

Required Headers

Content-Type: application/json
Authorization: Bearer {access_token}

Sample Request Body

{
  "todoType":"TASK",
  "domainWorkSpace":"VTT-NLD-TML-FIN",
  "title":"title",
  "description":"description",
  "result":"result",
  "financialImpact":"123",
  "impact":"HIGH",
  "likelihood":"MEDIUM",
  "status":"TODO",
  "priority":"HIGH",
  "assignee":"rge@vtti.com",
  "reporter":"user@vtti.com",
  "category":["Customs","Fetsa"],
  "subCategory":["high"],
  "lrn":"test",
  "orderID":"tag",
  "reminderDate":"2024-09-27"
}

Field Reference

domainWorkSpace - Workspace value from URL (Example: VTT-BEL-ATP)

todoType - TASK, INCIDENT (must be uppercase)

status - TODO, INPROGRESS, DONE

priority - LOW, MEDIUM, HIGH

impact - LOW, MEDIUM, HIGH

likelihood - LOW, MEDIUM, HIGH

assignee - Valid email address (Example: rge@vtti.com)

reporter - Valid email address (Example: user@vtti.com)

reminderDate - Format YYYY-MM-DD

Allowed Values

todoType: TASK, INCIDENT

status: TODO, INPROGRESS, DONE

priority: LOW, MEDIUM, HIGH

impact: LOW, MEDIUM, HIGH

likelihood: LOW, MEDIUM, HIGH

Sample Response

{
  "title":"Potential Customs claim",
  "taskType":"INCIDENT",
  "description":"Operation started without proper approvals",
  "taskLink":"https://www.bzctrl.com/app/#/todo/IMP-NLD-EXA-SWA-03",
  "tags":["SO 777"]
}

Note: The access token received from the OAuth Token API must be included in the Authorization header using the Bearer scheme.