Gets the task settings dimension.

GET /api/TaskSettingsDimension

This request should be used to retrieve information on task settings for specified engagement(s). The information here will be similar to what can be seen in the Task Library. The columns here include information on the task name, the task code, which folder the task is located in, the task description, procedure and other settings that are defined in the Library.

Query parameters

engagement string

Short Guid of desired engagement Ex - ESXmkya-nEeWMX-7_3fSxA or Guid of desired engagement Ex - 45c31339-96d0-4262-b051-c00f392685c1

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- taskSettingKey integer(int32)
- engagementKey string(uuid)
- taskName string | null
- taskCode string | null
- taskFolderName string | null
- taskFolderPath string | null
- taskDescription string | null
- taskProcedure string | null
- taskType string | null
- taskIsInternalControl boolean
- taskNumberOfApprovals integer(int32) | null
- taskReminderDays integer(int32) | null
- taskExpectedCompletionTime number(double)
- taskLibraryAttachments integer(int32) | null
404

Not Found
400

Bad Request
500

Server Error

GET /api/TaskSettingsDimension

curl \
 -X GET https://analyticsapi.adra.com/taskmanager/api/TaskSettingsDimension

Response examples (200)

[
  {
    "TaskCode": "10001",
    "TaskName": "Parent 1",
    "TaskType": "Periodic",
    "EngagementKey": "45c31339-96d0-4262-b051-c00f392685c1",
    "TaskProcedure": "",
    "TaskFolderName": "Bug Verification",
    "TaskFolderPath": "Bug Verification",
    "TaskSettingKey": 3527721,
    "TaskDescription": "",
    "TaskReminderDays": null,
    "TaskIsInternalControl": false,
    "TaskNumberOfApprovals": 0,
    "TaskLibraryAttachments": 0,
    "TaskExpectedCompletionTime": 0.0
  }
]