Jump to

• Request
• Response

View a Work Manager Task by Code and Parent Codes

get

/api/restapi/workManagerTask/byCode

Send a request to this endpoint to view a work manager task with codes matching the code fields in query parameters.

Request

Query Parameters

• includeCommitments: boolean
  Indicates whether a commitment needs to be included in ApiEntityWorkManagerTask.

  Default Value: false
• itemCode(required): string
  The user-specified name of a work manager task.
  This is a required field.
• projectCode(required): string
  The user-specified identifier of a project.
  This is a required field.
• workspaceCode(required): string
  The user-specified identifier of a workspace.
  This is a required field.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityWorkManagerTask

Type: object

Title: ApiEntityWorkManagerTask

Show Source

• activityCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of the activity.
• activityCompleteStatus: string
  Allowed Values: [ "NO_ACTIVITY", "ACTIVITY_COMPLETE_TASK_NOT", "TASK_COMPLETE_ACTIVITY_NOT", "BOTH_COMPLETE", "BOTH_NOT_COMPLETE" ]

  Indicates the completion status of the activity and its assigned tasks.
• activityDateStatus: string
  Allowed Values: [ "INSIDE_ACTIVITY", "OUTSIDE_ACTIVITY", "NO_ACTIVITY" ]

  Indicates the overall date status of the activity's assigned tasks.
  Outside Activity: A task's dates are outside of the activity's Start and Finish dates.
  Inside Activity: All of the tasks' dates are within the activity's Start and Finish dates.
  No Tasks Assigned: No tasks are assigned to the activity.
• activityId: integer (int64)
  The activity to which the task is assigned. The activity must have a Type of Activity Dependent or Resource Dependent.
• codeValues: array codeValues
  The list of code values for a work manager task. This entity can only be used to assign codeValues or create codeValues on the fly.
• commitmentCount: integer (int64)
  The number of commitments on a task.
• 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.
• completedDate: string (date-time)
  The date when the task was completed. This field is set automatically when the task is completed.
• configuredFields: array configuredFields
  The list of configured fields for a work manager task.
• constraintCount: integer (int64)
  The number of constraints assigned to the selected task or task milestone.
• durationHours: number (double)
  Minimum Value: 0

  The total amount of expected time required to complete the task, in days.
• favorite: boolean
  Indicates whether or not the work manager task is marked as favorite.
• hasCommitments: boolean
  Tasks that contain commitments to due dates.
• hasConstraints: boolean
  Indicates whether the selected task or task milestone has any constraints assigned.
• hasProposedDueDate: boolean
  Tasks that have a proposed due date value that has not yet been accepted.
• hasSlack: boolean
  Task slack is the amount of time a task can be delayed before it impacts the start date of the most immediate hand-off successor.
• isDueThisWeek: boolean
  Tasks that are due within the calendar week from Sunday to Saturday.
• isMissingActivityAssignment: boolean
  Tasks that are missing Activity assignment.
• isOutsideActivity: boolean
  Tasks with due dates that occur before the activity start date or after the activity end date.
• isOverdue: boolean
  Tasks that have not been completed by their due date.
• isPending: boolean
  Tasks that have a due date but are not committed, or tasks that are committed but the due date has been changed.
• isSchNonWorkDays: boolean
  Tasks that occur on non-work days as defined by the project calendar when Use Only Work Days is selected.
• isUnassigned: boolean
  Tasks that do not have a user assigned.
• isUnplanned: boolean
  Tasks without a due date.
• itemCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier assigned to the task.
• latestCommitmentDueDate: string (date-time)
  The current due date of the task commitment.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• originalCommitmentDueDate: string (date-time)
  The original due date of the task commitment.
• overdue: boolean
  Tasks that have not been completed by their due date.
• parentWbsId: integer (int64)
  The system-generated identifier of the parent WBS.
• predecessorCount: integer (int64)
  The number of predecessor hand-offs assigned to the task.
• project: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• 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 name of the company that owns the task.
• proposedDueDate: string (date-time)
  The date proposed for the task due date. Proposed Due Dates do not affect task Due Dates until they are accepted.
• sequenceNumber: integer (int32)
  The number that specifies the position of a task within a task hierarchy.
• slack: number (double)
  Minimum Value: 0

  The amount of time a task can be delayed before it affects the start date of its most immediate successor. This is a read-only field.
• startDate: string (date-time)
  The date when the task is set to begin.
  If the task is set to allow non-work days, the date is calculated as Due Date minus Duration plus 1 day.
  If the task is not set to allow non-work days, the date is calculated as Due Date minus the sum of Duration plus Non-Work Days, plus 1 day.
  This is a read-only field.
• status: string
  Allowed Values: [ "NEW", "PENDING", "COMMITTED", "COMPLETED" ]

  The current status of the task. Valid values are New, Pending, Committed, and Completed.
• successorCount: integer (int64)
  The number of successor hand-offs assigned to the task.
• taskConstraints: array taskConstraints
  List of work manager task constraints.
• tentativeDate: string (date-time)
  The date by which the task is expected to be completed.
• type: string
  Allowed Values: [ "TASK", "TASK_MILESTONE" ]

  The type of task. Valid values are Task and Task Milestone.
• updateDate: string (date-time)
  Date when the record was last updated.
• useCalendar: boolean
  Enables the user to allow only the project calendar's work days and ignore non-work days when determining the value for Start and Due Date.
• userId: integer (int64)
  The person responsible for the task.
• visibility: string
  Allowed Values: [ "PUBLIC", "PRIVATE" ]

  The visibility of task. Valid values are Private and Public.
• wbsCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the WBS.
• wbsId: integer (int64)
  Unique identifier of the WBS.
• wbsPath: string
  Maximum Length: 4000

  The path to the WBS.
• workManagerTaskCommitments: array workManagerTaskCommitments
  List of Work Manager task commitments associated with the task.
• workManagerTaskId: integer (int64)
  The unique identifier of a task. This value should not be provided in create operation request data, however, it is required for update requests.
• workManagerTaskName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the task.
• 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":"ApiEntityWorkManagerTask",
    "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 type of task. Valid values are Task and Task Milestone.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "TASK",
                "TASK_MILESTONE"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of a task within a task hierarchy.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "status":{
            "type":"string",
            "description":"The current status of the task. Valid values are New, Pending, Committed, and Completed.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "PENDING",
                "COMMITTED",
                "COMPLETED"
            ]
        },
        "project":{
            "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"
            ]
        },
        "userId":{
            "type":"integer",
            "description":"The person responsible for the task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workManagerTaskCommitments":{
            "type":"array",
            "description":"List of Work Manager task commitments associated with the task.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkManagerTaskCommitment",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "wbsPath":{
            "maxLength":"4000",
            "type":"string",
            "description":"The path to the WBS.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a work manager task.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkManagerTaskConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "codeValues":{
            "type":"array",
            "description":"The list of code values for a work manager task. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueWorkManagerTask",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The date when the task is set to begin. <br />If the task is set to allow non-work days, the date is calculated as Due Date minus Duration plus 1 day. <br />If the task is not set to allow non-work days, the date is calculated as Due Date minus the sum of Duration plus Non-Work Days, plus 1 day. <br />This is a read-only field.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "wbsId":{
            "type":"integer",
            "description":"Unique identifier of the WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "wbsCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the WBS.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "visibility":{
            "type":"string",
            "description":"The visibility of task. Valid values are Private and Public.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PUBLIC",
                "PRIVATE"
            ]
        },
        "activityId":{
            "type":"integer",
            "description":"The activity to which the task is assigned. The activity must have a Type of Activity Dependent or Resource Dependent.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "itemCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier assigned to the task.",
            "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"
            ]
        },
        "companyName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCompanyId":{
            "type":"integer",
            "description":"The name of the company that owns the task.",
            "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"
            ]
        },
        "taskConstraints":{
            "type":"array",
            "description":"List of work manager task constraints.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityTaskConstraint",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workManagerTaskId":{
            "type":"integer",
            "description":"The unique identifier of a task. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "durationHours":{
            "minimum":"0",
            "type":"number",
            "description":"The total amount of expected time required to complete the task, in days.",
            "format":"double",
            "exampleSetFlag":false
        },
        "overdue":{
            "type":"boolean",
            "description":"Tasks that have not been completed by their due date.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "useCalendar":{
            "type":"boolean",
            "description":"Enables the user to allow only the project calendar's work days and ignore non-work days when determining the value for Start and Due Date.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "workManagerTaskName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "tentativeDate":{
            "type":"string",
            "description":"The date by which the task is expected to be completed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "completedDate":{
            "type":"string",
            "description":"The date when the task was completed. This field is set automatically when the task is completed. ",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityDateStatus":{
            "type":"string",
            "description":"Indicates the overall date status of the activity's assigned tasks.<br/>Outside Activity: A task's dates are outside of the activity's Start and Finish dates.<br/>Inside Activity: All of the tasks' dates are within the activity's Start and Finish dates.<br/>No Tasks Assigned: No tasks are assigned to the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "INSIDE_ACTIVITY",
                "OUTSIDE_ACTIVITY",
                "NO_ACTIVITY"
            ]
        },
        "activityCompleteStatus":{
            "type":"string",
            "description":"Indicates the completion status of the activity and its assigned tasks.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NO_ACTIVITY",
                "ACTIVITY_COMPLETE_TASK_NOT",
                "TASK_COMPLETE_ACTIVITY_NOT",
                "BOTH_COMPLETE",
                "BOTH_NOT_COMPLETE"
            ]
        },
        "favorite":{
            "type":"boolean",
            "description":"Indicates whether or not the work manager task is marked as favorite.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "commitmentCount":{
            "type":"integer",
            "description":"The number of commitments on a task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "slack":{
            "minimum":"0",
            "type":"number",
            "description":"The amount of time a task can be delayed before it affects the start date of its most immediate successor. This is a read-only field.",
            "format":"double",
            "exampleSetFlag":false
        },
        "predecessorCount":{
            "type":"integer",
            "description":"The number of predecessor hand-offs assigned to the task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "successorCount":{
            "type":"integer",
            "description":"The number of successor hand-offs assigned to the task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "proposedDueDate":{
            "type":"string",
            "description":"The date proposed for the task due date. Proposed Due Dates do not affect task Due Dates until they are accepted.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "latestCommitmentDueDate":{
            "type":"string",
            "description":"The current due date of the task commitment.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "originalCommitmentDueDate":{
            "type":"string",
            "description":"The original due date of the task commitment.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "isDueThisWeek":{
            "type":"boolean",
            "description":"Tasks that are due within the calendar week from Sunday to Saturday.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "hasSlack":{
            "type":"boolean",
            "description":"Task slack is the amount of time a task can be delayed before it impacts the start date of the most immediate hand-off successor.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "hasCommitments":{
            "type":"boolean",
            "description":"Tasks that contain commitments to due dates.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "isUnassigned":{
            "type":"boolean",
            "description":"Tasks that do not have a user assigned.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "isPending":{
            "type":"boolean",
            "description":"Tasks that have a due date but are not committed, or tasks that are committed but the due date has been changed.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "isUnplanned":{
            "type":"boolean",
            "description":"Tasks without a due date.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "isOutsideActivity":{
            "type":"boolean",
            "description":"Tasks with due dates that occur before the activity start date or after the activity end date.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "isSchNonWorkDays":{
            "type":"boolean",
            "description":"Tasks that occur on non-work days as defined by the project calendar when Use Only Work Days is selected.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "isOverdue":{
            "type":"boolean",
            "description":"Tasks that have not been completed by their due date.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "hasProposedDueDate":{
            "type":"boolean",
            "description":"Tasks that have a proposed due date value that has not yet been accepted.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "isMissingActivityAssignment":{
            "type":"boolean",
            "description":"Tasks that are missing Activity assignment.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "constraintCount":{
            "type":"integer",
            "description":"The number of constraints assigned to the selected task or task milestone.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "hasConstraints":{
            "type":"boolean",
            "description":"Indicates whether the selected task or task milestone has any constraints assigned.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "parentWbsId":{
            "type":"integer",
            "description":"The system-generated identifier of the parent WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : codeValues

Type: array

The list of code values for a work manager task. This entity can only be used to assign codeValues or create codeValues on the fly.

Show Source

• Array of: object ApiEntityCodeValueWorkManagerTask
  Title: ApiEntityCodeValueWorkManagerTask

{
    "type":"array",
    "description":"The list of code values for a work manager task. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueWorkManagerTask",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a work manager task.

Show Source

• Array of: object ApiEntityWorkManagerTaskConfiguredFieldValue
  Title: ApiEntityWorkManagerTaskConfiguredFieldValue

{
    "type":"array",
    "description":"The list of configured fields for a work manager task.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkManagerTaskConfiguredFieldValue",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : taskConstraints

Type: array

List of work manager task constraints.

Show Source

• Array of: object ApiEntityTaskConstraint
  Title: ApiEntityTaskConstraint

{
    "type":"array",
    "description":"List of work manager task constraints.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityTaskConstraint",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : workManagerTaskCommitments

Type: array

List of Work Manager task commitments associated with the task.

Show Source

• Array of: object ApiEntityWorkManagerTaskCommitment
  Title: ApiEntityWorkManagerTaskCommitment

{
    "type":"array",
    "description":"List of Work Manager task commitments associated with the task.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkManagerTaskCommitment",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCodeValueWorkManagerTask

Type: object

Title: ApiEntityCodeValueWorkManagerTask

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide a value for this field during object update to delete code value assigned to the object.
• codeTypeCode: string
  Minimum Length: 0

  Maximum Length: 60

  This field displays the name of a code or value.
• codeTypeId(required): integer (int64)
  The unique identifier for the code type.The code type object can also be identified by its unique criteria.
• codeTypeName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of a code or value.
• codeValueCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the code value.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• codeValueName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the code value.
• codeValueTasksId: integer (int64)
  The unique identifier of a code value of a task.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The code of a Project of a Project CodeType.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• sequenceNumber: integer (int32)
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Date when the record was last updated.
• workManagerTaskId: integer (int64)
  The unique identifier of a task.

{
    "title":"ApiEntityCodeValueWorkManagerTask",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "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"
            ]
        },
        "workManagerTaskId":{
            "type":"integer",
            "description":"The unique identifier of a task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueTasksId":{
            "type":"integer",
            "description":"The unique identifier of a code value of a task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "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 code of a Project of a Project CodeType.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeTypeName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the code value.",
            "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 : ApiEntityWorkManagerTaskConfiguredFieldValue

Type: object

Title: ApiEntityWorkManagerTaskConfiguredFieldValue

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• costValue: number
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Maximum Length: 4000

  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Date when the record was last updated.
• workManagerTaskConfiguredFieldValueId: integer (int64)
  The unique identifier for the Task Configured Field.
• workManagerTaskId: integer (int64)
  The system-generated identifier of a Task.

{
    "title":"ApiEntityWorkManagerTaskConfiguredFieldValue",
    "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"
            ]
        },
        "workManagerTaskId":{
            "type":"integer",
            "description":"The system-generated identifier of a Task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workManagerTaskConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Task Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityTaskConstraint

Type: object

Title: ApiEntityTaskConstraint

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• constraintId: integer (int64)
  The unique identifier of a constraint.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• taskConstraintId: integer (int64)
  The unique identifier of a work manager task constraint.
• updateDate: string (date-time)
  Date when the record was last updated.
• workManagerTaskId: integer (int64)
  The unique identifier of a task.

{
    "title":"ApiEntityTaskConstraint",
    "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"
            ]
        },
        "constraintId":{
            "type":"integer",
            "description":"The unique identifier of a constraint.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "taskConstraintId":{
            "type":"integer",
            "description":"The unique identifier of a work manager task constraint.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workManagerTaskId":{
            "type":"integer",
            "description":"The unique identifier of a task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

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

404 Response

The requested object does not exist, or you do not have access to it.

Back to Top