View a Work Manager Task Commitment
get
/api/restapi/workManagerTaskCommitment/{workManagerTaskCommitmentId}
This endpoint returns work manager task commitments that meet the following requirements:
- The object has an ID that matches the value of the {workManagerTaskCommitmentId} path parameter.
Request
Path Parameters
-
workManagerTaskCommitmentId(required): integer(int64)
The system-generated identifier of a work manager task commitment.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityWorkManagerTaskCommitment
Type:
object
Title:
Show Source
ApiEntityWorkManagerTaskCommitment
-
activityCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of the activity. -
addByUserId: integer
(int64)
The username of the user who added the item.
-
applicationUserId: integer
(int64)
The system-generated identifier of a user.
-
comments: string
Minimum Length:
1
Maximum Length:4000
The comments captured with a task commitment. -
companyName: string
Minimum Length:
1
Maximum Length:255
The name of the company. -
companyPostalCode: string
Minimum Length:
0
Maximum Length:20
The postal code, post code, or zip code of a location. -
createDate: string
(date-time)
The date on which work manager task commitment was created.
-
dueDate: string
(date-time)
The date by which the task is expected to be completed.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectCompanyColor: string
Minimum Length:
1
Maximum Length:6
The selected color representation of the company. -
projectCompanyId: integer
(int64)
The system-generated identifier of a project.
-
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
reasons: array
reasons
The reasons of a work manager task commitment.
-
status: string
Allowed Values:
[ "COMMITTED", "RECOMMITTED" ]
The status of the commitment. Valid values are Committed and Recommitted. -
taskName: string
Minimum Length:
1
Maximum Length:255
The name of the task. -
timezoneDateAdded: string
(date-time)
The date on which the commitment was added.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workManagerTaskCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier assigned to the task. -
workManagerTaskCommitmentId: integer
(int64)
The unique identifier of a commitment. This value should not be provided in create operation request data, however, it is required for update requests.
-
workManagerTaskId: integer
(int64)
The unique identifier for the work manager task.The work manager task object can also be identified by its unique criteria.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Nested Schema : reasons
Type:
array
The reasons of a work manager task commitment.
Show Source
-
Array of:
object ApiEntityReason
Title:
ApiEntityReason
Nested Schema : ApiEntityReason
Type:
object
Title:
Show Source
ApiEntityReason
-
abbreviation: string
Minimum Length:
1
Maximum Length:60
The abbreviation of the reason for recommitting to a task. -
appliesTo: array
appliesTo
Indicates the type of object the reason is associated to.
-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the reason and the workspace. Possible values are Owned and Inherited. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
How data is shared between parent and child workspaces.
Manual: Data can be pulled down by child workspaces. This is the default option.
Automatic: Data is automatically shared with all child workspaces. -
reasonId: integer
(int64)
The unique identifier of a reason.
-
reasonName: string
Minimum Length:
1
Maximum Length:255
The name of the reason for recommitting to a task. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Nested Schema : appliesTo
Type:
array
Indicates the type of object the reason is associated to.
Show Source
-
Array of:
string
Allowed Values:
[ "TASKS", "CHANGE_EVENT" ]
404 Response
The requested work manager task commitment does not exist, or you do not have access to it.