Jump to

• Request
• Response

View all Work Manager Task Commitments by Associated User

get

/api/restapi/workManagerTaskCommitment/user/{applicationUserId}

This endpoint returns work manager task commitments that meet the following requirements:

• The object is associated with an application user with an ID value that matches the value of the {applicationUserId} path parameter.

Request

Path Parameters

• applicationUserId(required): integer(int64)
  The system-generated identifier of an application user.

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<ApiEntityWorkManagerTaskCommitment>

Type: array

Title: List<ApiEntityWorkManagerTaskCommitment>

Show Source

• Array of: object ApiEntityWorkManagerTaskCommitment
  Title: ApiEntityWorkManagerTaskCommitment

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

Nested Schema : ApiEntityWorkManagerTaskCommitment

Type: object

Title: ApiEntityWorkManagerTaskCommitment

Show Source

• 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.

{
    "title":"ApiEntityWorkManagerTaskCommitment",
    "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"
            ]
        },
        "status":{
            "type":"string",
            "description":"The status of the commitment. Valid values are Committed and Recommitted.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "COMMITTED",
                "RECOMMITTED"
            ]
        },
        "taskName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "comments":{
            "maxLength":"4000",
            "minLength":"1",
            "type":"string",
            "description":"The comments captured with a task commitment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createDate":{
            "type":"string",
            "description":"The date on which work manager task commitment was created.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companyName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCompanyId":{
            "type":"integer",
            "description":"The system-generated identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "companyPostalCode":{
            "maxLength":"20",
            "minLength":"0",
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCompanyColor":{
            "maxLength":"6",
            "minLength":"1",
            "type":"string",
            "description":"The selected color representation of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dueDate":{
            "type":"string",
            "description":"The date by which the task is expected to be completed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "applicationUserId":{
            "type":"integer",
            "description":"The system-generated identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workManagerTaskId":{
            "type":"integer",
            "description":"The unique identifier for the work manager task.The work manager task object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "reasons":{
            "type":"array",
            "description":"The reasons of a work manager task commitment.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityReason",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workManagerTaskCommitmentId":{
            "type":"integer",
            "description":"The unique identifier of a commitment. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "addByUserId":{
            "type":"integer",
            "description":"The username of the user who added the item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "timezoneDateAdded":{
            "type":"string",
            "description":"The date on which the commitment was added.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "workManagerTaskCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier assigned to the task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : reasons

Type: array

The reasons of a work manager task commitment.

Show Source

• Array of: object ApiEntityReason
  Title: ApiEntityReason

{
    "type":"array",
    "description":"The reasons of a work manager task commitment.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityReason",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityReason

Type: object

Title: ApiEntityReason

Show Source

• 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.

{
    "title":"ApiEntityReason",
    "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"How data is shared between parent and child workspaces. <br />Manual: Data can be pulled down by child workspaces. This is the default option. <br />Automatic: Data is automatically shared with all child workspaces.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the reason and the workspace. Possible values are Owned and Inherited.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "reasonId":{
            "type":"integer",
            "description":"The unique identifier of a reason.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "reasonName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the reason for recommitting to a task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "abbreviation":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The abbreviation of the reason for recommitting to a task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "appliesTo":{
            "type":"array",
            "description":"Indicates the type of object the reason is associated to.   ",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ],
                "enum":[
                    "TASKS",
                    "CHANGE_EVENT"
                ]
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

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" ]

{
    "type":"array",
    "description":"Indicates the type of object the reason is associated to.   ",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ],
        "enum":[
            "TASKS",
            "CHANGE_EVENT"
        ]
    },
    "types":[
        "array"
    ]
}

204 Response

Successful operation with no content.

404 Response

The requested work manager task commitment does not exist, or you do not have access to it.

Back to Top