Jump to

• Request
• Response

Batch Update Tasks

put

/api/restapi/workManagerTask/batch

Send a request to this endpoint to update one or more tasks.

Request

Query Parameters

• keepHandOff: boolean
  Enabling this boolean flag automatically adjusts the tentativeDueDate of dependent tasks if the updated tentativeDueDate of a task overlaps with that of its predecessor or successor dependent tasks.

  Default Value: false

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityWorkManagerTaskInput>

Type: array

Title: List<ApiEntityWorkManagerTaskInput>

Show Source

• Array of: object ApiEntityWorkManagerTaskInput
  Title: ApiEntityWorkManagerTaskInput

  This entity represents a WorkManagerTask object, a unique WorkManagerTask object can be identified by the following combinations of the fields.

  • workManagerTaskId
  • itemCode,project,projectCompanyId
  • itemCode,projectCode,workspaceCode,projectCompanyId
  • itemCode,project,companyName,companyPostalCode,projectCompanyColor
  • itemCode,projectCode,workspaceCode,companyName,companyPostalCode,projectCompanyColor

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

Nested Schema : ApiEntityWorkManagerTaskInput

Type: object

Title: ApiEntityWorkManagerTaskInput

This entity represents a WorkManagerTask object, a unique WorkManagerTask object can be identified by the following combinations of the fields.

• workManagerTaskId
• itemCode,project,projectCompanyId
• itemCode,projectCode,workspaceCode,projectCompanyId
• itemCode,project,companyName,companyPostalCode,projectCompanyColor
• itemCode,projectCode,workspaceCode,companyName,companyPostalCode,projectCompanyColor

Show Source

• 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.
• 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.
• crewSize: integer (int32)
  Minimum Value: 1

  Maximum Value: 99

  The number of people planned to work on the task.
• 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.
• hasProposedDueDate: boolean
  Tasks that have a proposed due date value that has not yet been accepted.
• itemCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier assigned to the task.
• overdue: boolean
  Tasks that have not been completed by their due date.
• parentWbsId: integer (int64)
  The system-generated identifier of the parent WBS.
• project(required): 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.
• status: string
  Allowed Values: [ "NEW", "PENDING", "COMMITTED", "COMPLETED" ]

  The current status of the task. Valid values are New, Pending, Committed, and Completed.
• 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.
• 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(required): 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.
• 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":"ApiEntityWorkManagerTaskInput",
    "required":[
        "project",
        "visibility"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"The type of task. Valid values are Task and Task Milestone.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "TASK",
                "TASK_MILESTONE"
            ]
        },
        "itemCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified unique identifier assigned to the task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "projectCompanyId":{
            "type":"integer",
            "description":"The name of the company that owns the task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "overdue":{
            "type":"boolean",
            "description":"Tasks that have not been completed by their due date.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "durationHours":{
            "minimum":0,
            "type":"number",
            "description":"The total amount of expected time required to complete the task, in days.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "visibility":{
            "type":"string",
            "description":"The visibility of task. Valid values are Private and Public.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PUBLIC",
                "PRIVATE"
            ]
        },
        "favorite":{
            "type":"boolean",
            "description":"Indicates whether or not the work manager task is marked as favorite.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "parentWbsId":{
            "type":"integer",
            "description":"The system-generated identifier of the parent WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "crewSize":{
            "maximum":99,
            "minimum":1,
            "type":"integer",
            "description":"The number of people planned to work on the task.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "hasProposedDueDate":{
            "type":"boolean",
            "description":"Tasks that have a proposed due date value that has not yet been accepted.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "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"
            ]
        },
        "workManagerTaskName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userId":{
            "type":"integer",
            "description":"The person responsible for the task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a work manager task.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkManagerTaskConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "companyName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "taskConstraints":{
            "type":"array",
            "description":"List of work manager task constraints.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityTaskConstraintInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "wbsId":{
            "type":"integer",
            "description":"Unique identifier of the WBS.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "wbsCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified unique identifier for the WBS.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "wbsPath":{
            "maxLength":4000,
            "type":"string",
            "description":"The path to the WBS.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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/ApiEntityCodeValueWorkManagerTaskInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "description":"This entity represents a WorkManagerTask object, a unique WorkManagerTask object can be identified by the following combinations of the fields.<ul><li>workManagerTaskId</li><li>itemCode,project,projectCompanyId</li><li>itemCode,projectCode,workspaceCode,projectCompanyId</li><li>itemCode,project,companyName,companyPostalCode,projectCompanyColor</li><li>itemCode,projectCode,workspaceCode,companyName,companyPostalCode,projectCompanyColor</li>",
    "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 ApiEntityCodeValueWorkManagerTaskInput
  Title: ApiEntityCodeValueWorkManagerTaskInput

  This entity represents a CodeValueWorkManagerTask object, a unique CodeValueWorkManagerTask object can be identified by the following combinations of the fields.

  • codeValueTasksId
  • codeValueId
  • codeTypeId,codeValueCode
  • codeTypeCode,codeValueCode
  • codeTypeCode,parentId,codeValueCode
  • codeValueCode,codeTypeId,parentId
  • codeTypeCode,codeValueCode,projectCode
  • codeTypeCode,codeValueCode,projectId
  • codeTypeCode,codeValueCode,parentId,projectCode
  • codeTypeCode,codeValueCode,parentId,projectId

{
    "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/ApiEntityCodeValueWorkManagerTaskInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a work manager task.

Show Source

• Array of: object ApiEntityWorkManagerTaskConfiguredFieldValueInput
  Title: ApiEntityWorkManagerTaskConfiguredFieldValueInput

  This entity represents a WorkManagerTaskConfiguredFieldValue object, a unique WorkManagerTaskConfiguredFieldValue object can be identified by the following combinations of the fields.

  • workManagerTaskConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

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

Nested Schema : taskConstraints

Type: array

List of work manager task constraints.

Show Source

• Array of: object ApiEntityTaskConstraintInput
  Title: ApiEntityTaskConstraintInput

  This entity represents a TaskConstraint object, a unique TaskConstraint object can be identified by the following combinations of the fields.

  • taskConstraintId
  • constraintId,workManagerTaskId

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

Nested Schema : ApiEntityCodeValueWorkManagerTaskInput

Type: object

Title: ApiEntityCodeValueWorkManagerTaskInput

This entity represents a CodeValueWorkManagerTask object, a unique CodeValueWorkManagerTask object can be identified by the following combinations of the fields.

• codeValueTasksId
• codeValueId
• codeTypeId,codeValueCode
• codeTypeCode,codeValueCode
• codeTypeCode,parentId,codeValueCode
• codeValueCode,codeTypeId,parentId
• codeTypeCode,codeValueCode,projectCode
• codeTypeCode,codeValueCode,projectId
• codeTypeCode,codeValueCode,parentId,projectCode
• codeTypeCode,codeValueCode,parentId,projectId

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.
• 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.
• 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.
• workManagerTaskId: integer (int64)
  The unique identifier of a task.

{
    "title":"ApiEntityCodeValueWorkManagerTaskInput",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "codeValueTasksId":{
            "type":"integer",
            "description":"The unique identifier of a code value of a task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workManagerTaskId":{
            "type":"integer",
            "description":"The unique identifier of a task.",
            "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"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "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"
            ]
        }
    },
    "description":"This entity represents a CodeValueWorkManagerTask object, a unique CodeValueWorkManagerTask object can be identified by the following combinations of the fields.<ul><li>codeValueTasksId</li><li>codeValueId</li><li>codeTypeId,codeValueCode</li><li>codeTypeCode,codeValueCode</li><li>codeTypeCode,parentId,codeValueCode</li><li>codeValueCode,codeTypeId,parentId</li><li>codeTypeCode,codeValueCode,projectCode</li><li>codeTypeCode,codeValueCode,projectId</li><li>codeTypeCode,codeValueCode,parentId,projectCode</li><li>codeTypeCode,codeValueCode,parentId,projectId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityWorkManagerTaskConfiguredFieldValueInput

Type: object

Title: ApiEntityWorkManagerTaskConfiguredFieldValueInput

This entity represents a WorkManagerTaskConfiguredFieldValue object, a unique WorkManagerTaskConfiguredFieldValue object can be identified by the following combinations of the fields.

• workManagerTaskConfiguredFieldValueId
• columnDefinitionId
• columnName
• columnLabel

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.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• 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.
• workManagerTaskConfiguredFieldValueId: integer (int64)
  The unique identifier for the Task Configured Field.
• workManagerTaskId: integer (int64)
  The system-generated identifier of a Task.

{
    "title":"ApiEntityWorkManagerTaskConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "workManagerTaskConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Task Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workManagerTaskId":{
            "type":"integer",
            "description":"The system-generated identifier of a Task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "textValue":{
            "maxLength":4000,
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        }
    },
    "description":"This entity represents a WorkManagerTaskConfiguredFieldValue object, a unique WorkManagerTaskConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>workManagerTaskConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityTaskConstraintInput

Type: object

Title: ApiEntityTaskConstraintInput

This entity represents a TaskConstraint object, a unique TaskConstraint object can be identified by the following combinations of the fields.

• taskConstraintId
• constraintId,workManagerTaskId

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.
• taskConstraintId: integer (int64)
  The unique identifier of a work manager task constraint.
• workManagerTaskId: integer (int64)
  The unique identifier of a task.

{
    "title":"ApiEntityTaskConstraintInput",
    "type":"object",
    "properties":{
        "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"
            ]
        },
        "constraintId":{
            "type":"integer",
            "description":"The unique identifier of a constraint.",
            "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"
            ]
        }
    },
    "description":"This entity represents a TaskConstraint object, a unique TaskConstraint object can be identified by the following combinations of the fields.<ul><li>taskConstraintId</li><li>constraintId,workManagerTaskId</li>",
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Work Manager Tasks by Assigning Code Values Using Codes or IDs Batch Update Work Manager Tasks by Assigning Hierarchical Code Values Using Codes Batch Update Work Manager Tasks Using Work Manager Task IDs Batch Update Work Manager Tasks to Assign Configured Field

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"},"warnings":[{"primaryKeyName":"objectIdFieldName","uniqueFieldName":"object_code_01","uniqueFieldValue":"objectCodeFieldName","primaryKeyValue":1,"warningMessages":["warning_message_1","warning_message_2"]}]}

400 Response

Invalid input for the Task service.

Back to Top