ProRoster - Get task by id

API Url

Use it to return an assigned task

GET
http://localhost:16010/ProMarkRESTweb/ProRoster/assigned-tasks/{taskId}

Permissions: user

Path parameters

FieldTypeDescription
taskIdNumber

Task id.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

    tasksObject[]
      backColorString

Background color

      changedDatetime

Date and time when the task was changed

      changedByString

User id that changed the task

      counterNumber

Employee counter for the task

      createdDatetime

Date and time when the task was created

      createdByString

User id that created the task

      dateDate

Date of the unassigned demand.

      demandTypeNumber

Demand type. (5 = Base Task)

      descriptionString

Task description

      foreColorString

Foreground color

      idNumber

The id of the task.

      isPublishedBoolean

TRUE if the task is published

      nameString

Task name

      planIdNumber

The plan id.

      snapshotVersionNumber

Snapshot version

      toDoListoptionalObject[]

Array with a to do list

        descriptionString

Description of the to do item

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Success example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"tasks": [
{
"id": 2205783021,
"planId": 2165121401,
"demandType": 5,
"name": "Some other Task edit",
"description": "This is a dummy task edit",
"date": "2021-05-21",
"backColor": "FFCC33",
"isPublished": false,
"created": "2021-05-18T14:02:01.000",
"createdBy": "AUR",
"changed": "2021-05-18T14:02:11.000",
"changedBy": "AUR",
"snapshotVersion": 0,
"counter": 0,
"toDoList": [
{
"description": "Step 2.one edit"
},
{
"description": "Step 2.two"
}
]
}
]
}
}
}