GET /task-definitions/{id}
Oauth2

Gets the task definition detail. If the deep query parameter is provided also loads all sub tasks. In order to view the task, the user must either be a close admin, or be assigned as one or more of the performer, reviewer or approver.

Path parameters

  • id integer Required

    The identifier of the task definition. Only task definitions defined for the specified entity definition details will be returned

Query parameters

  • fetchDepth integer(int32)

    We define a fetchDepth parameter in the parameters section. It should have positive integer value.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id integer
    • parentId integer
    • name string
    • number string
    • description string
    • instructions string
    • isCritical boolean
    • entity object
      Hide entity attributes Show entity attributes object
      • id object
      • name string
    • performer object
      Hide performer attributes Show performer attributes object
      • id integer
      • name string
      • email string
      • userName string
      • first string
      • middle string
      • last string
    • reviewer object
      Hide reviewer attributes Show reviewer attributes object
      • id integer
      • name string
      • email string
      • userName string
      • first string
      • middle string
      • last string
    • approver object
      Hide approver attributes Show approver attributes object
      • id integer
      • name string
      • email string
      • userName string
      • first string
      • middle string
      • last string
    • children array[object]
      Hide children attributes Show children attributes object
      • id object
      • name string
GET /task-definitions/{id} 
curl \
 --request GET 'https://usaapi02.cadencyservices.trintech.com/test/api/task-definitions/{id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "id": 42,
  "parentId": 42,
  "name": "string",
  "number": "string",
  "description": "string",
  "instructions": "string",
  "isCritical": true,
  "entity": {
    "id": {},
    "name": "string"
  },
  "performer": {
    "id": 42,
    "name": "string",
    "email": "string",
    "userName": "string",
    "first": "string",
    "middle": "string",
    "last": "string"
  },
  "reviewer": {
    "id": 42,
    "name": "string",
    "email": "string",
    "userName": "string",
    "first": "string",
    "middle": "string",
    "last": "string"
  },
  "approver": {
    "id": 42,
    "name": "string",
    "email": "string",
    "userName": "string",
    "first": "string",
    "middle": "string",
    "last": "string"
  },
  "children": [
    {
      "id": {},
      "name": "string"
    }
  ]
}