Jump to

• Request
• Response

View Task Handoff Chain by Task

get

/api/restapi/workManagerTaskDependency/task/{workManagerTaskId}

Send a request to this end point to view the entire task handoff chain by the specified task ID.

Request

Path Parameters

• workManagerTaskId(required): integer(int64)
  Task ID for which Task Handoffs to be found.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityWorkManagerTaskDependency>

Type: array

Title: List<ApiEntityWorkManagerTaskDependency>

Show Source

• Array of: object ApiEntityWorkManagerTaskDependency
  Title: ApiEntityWorkManagerTaskDependency

{
    "title":"List<ApiEntityWorkManagerTaskDependency>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkManagerTaskDependency",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityWorkManagerTaskDependency

Type: object

Title: ApiEntityWorkManagerTaskDependency

Show Source

• lag: number (double)
  Minimum Value: 0

  The amount of time a successor task is required to be delayed with respect to a predecessor task in a hand-off, in hours.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• predecessorTaskCompany: string
  Company assigned to the predecessor Task.
• predecessorTaskDueDate: string (date-time)
  Last committed due date of the predecessor Task.
• predecessorTaskId: integer (int64)
  The unique identifier of a predecessor task.
• predecessorTaskName: string
  Minimum Length: 1

  Maximum Length: 255

  Task name of the predecessor Task.
• predecessorTaskStatus: string
  Allowed Values: [ "NEW", "PENDING", "COMMITTED", "COMPLETED" ]

  Task status of the predecessor Task.
• projectId: integer (int64)
  The unique identifier of the project to which the dependency belongs.
• slack: number (double)
  Minimum Value: 0

  The amount of time between a predecessor task's due date and its successor task's start date. This is a read-only field.
• successorTaskCompany: string
  Company assigned to the successor Task.
• successorTaskDueDate: string (date-time)
  Last committed due date of the successor Task.
• successorTaskId: integer (int64)
  The unique identifier of a successor task.
• successorTaskName: string
  Minimum Length: 1

  Maximum Length: 255

  Task name of the successor Task.
• successorTaskStatus: string
  Allowed Values: [ "NEW", "PENDING", "COMMITTED", "COMPLETED" ]

  Task status of the successor Task.
• type: string
  Allowed Values: [ "FINISH_TO_START", "START_TO_START", "FINISH_TO_FINISH" ]

  The hand-off dependency type. The valid value is Finish to Start.
• updateDate: string (date-time)
  Date when the record was last updated.
• useCalendar: boolean
  Allows user to set whether or not lag can fall on project calendar's nonwork days.
• workManagerTaskDependencyId: integer (int64)
  The system-generated identifier of a work manager task dependency. This value should not be provided in create operation request data, however, it is required for update requests.

{
    "title":"ApiEntityWorkManagerTaskDependency",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "type":{
            "type":"string",
            "description":"The hand-off dependency type. The valid value is Finish to Start.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "FINISH_TO_START",
                "START_TO_START",
                "FINISH_TO_FINISH"
            ]
        },
        "useCalendar":{
            "type":"boolean",
            "description":"Allows user to set whether or not lag can fall on project calendar's nonwork days.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "slack":{
            "minimum":0,
            "type":"number",
            "description":"The amount of time between a predecessor task's due date and its successor task's start date. This is a read-only field.",
            "format":"double",
            "exampleSetFlag":false
        },
        "successorTaskId":{
            "type":"integer",
            "description":"The unique identifier of a successor task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "lag":{
            "minimum":0,
            "type":"number",
            "description":"The amount of time a successor task is required to be delayed with respect to a predecessor task in a hand-off, in hours. ",
            "format":"double",
            "exampleSetFlag":false
        },
        "predecessorTaskId":{
            "type":"integer",
            "description":"The unique identifier of a predecessor task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workManagerTaskDependencyId":{
            "type":"integer",
            "description":"The system-generated identifier of a work manager task dependency. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "successorTaskName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Task name of the successor Task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "predecessorTaskName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Task name of the predecessor Task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier of the project to which the dependency belongs.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "successorTaskDueDate":{
            "type":"string",
            "description":"Last committed due date of the successor Task.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "predecessorTaskDueDate":{
            "type":"string",
            "description":"Last committed due date of the predecessor Task.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "successorTaskStatus":{
            "type":"string",
            "description":"Task status of the successor Task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "PENDING",
                "COMMITTED",
                "COMPLETED"
            ]
        },
        "predecessorTaskCompany":{
            "type":"string",
            "description":"Company assigned to the predecessor Task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "successorTaskCompany":{
            "type":"string",
            "description":"Company assigned to the successor Task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "predecessorTaskStatus":{
            "type":"string",
            "description":"Task status of the predecessor Task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "PENDING",
                "COMMITTED",
                "COMPLETED"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested Task Handoffs does not exist or you do not have access to it.

Back to Top