Jump to

• Request
• Response

View all Constraints by Work Manager Task

get

/api/restapi/constraint/workManagerTask/{workManagerTaskId}

This endpoint returns constraints that meet the following requirements:

• The object is associated with a work manager task with an ID value that matches the value of the {workManagerTaskId} path parameter.

Request

Path Parameters

• workManagerTaskId(required): integer(int64)
  The system-generated identifier of a work manager task.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityConstraint>

Type: array

Title: List<ApiEntityConstraint>

Show Source

• Array of: object ApiEntityConstraint
  Title: ApiEntityConstraint

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

Nested Schema : ApiEntityConstraint

Type: object

Title: ApiEntityConstraint

Show Source

• codeValues: array codeValues
  The list of code values for a constraint. 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.
• configuredFields: array configuredFields
  The list of configured fields for a constraint.
• constraintCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user specified identifier for a constraint.
• constraintId: integer (int64)
  The unique identifier of a constraint.
• constraintName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of a constraint.
• constraintType: string
  Allowed Values: [ "ACCESS", "DESIGN_ISSUE", "DOCUMENTS", "EQUIPMENT", "LABOR_CREWS", "MATERIALS", "QA_QC" ]

  The type of constraint.
• dateIdentified: string (date-time)
  The date the constraint was first identified as an impediment to completing a task.
• dateNeeded: string (date-time)
  The date the constraint needs to be resolved by to prevent a delay in the completion of the tasks or task milestones that are dependent on it.
• deliveredDate: string (date-time)
  The date the responsible party actually resolved the constraint.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• notes: string
  Maximum Length: 0

  The Notes on the constraint.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The project code of the constraint.
• projectCompanyColor: string
  Minimum Length: 1

  Maximum Length: 6

  The selected color representation of the company.
• projectCompanyId: integer (int64)
  The system-generated unique identifier of the company.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• promisedDate: string (date-time)
  The date by which the responsible party has agreed to resolve the constraint.
• status: string
  Allowed Values: [ "NOT_PLANNED", "PLANNED", "DELIVERED" ]

  The status of the task constraint. Valid values are Not Planned, Planned, and Delivered.
• taskConstraints: array taskConstraints
  List of work manager task constraints.
• updateDate: string (date-time)
  Date when the record was last updated.
• userId: integer (int64)
  The unique identifier of a user.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The workspace code of the constraint.

{
    "title":"ApiEntityConstraint",
    "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 task constraint. Valid values are Not Planned, Planned, and Delivered.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NOT_PLANNED",
                "PLANNED",
                "DELIVERED"
            ]
        },
        "userId":{
            "type":"integer",
            "description":"The unique identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a constraint.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityConstraintConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "codeValues":{
            "type":"array",
            "description":"The list of code values for a constraint. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueConstraint",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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 project code of the constraint.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "constraintType":{
            "type":"string",
            "description":"The type of constraint.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACCESS",
                "DESIGN_ISSUE",
                "DOCUMENTS",
                "EQUIPMENT",
                "LABOR_CREWS",
                "MATERIALS",
                "QA_QC"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The workspace code of the constraint.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companyName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "constraintId":{
            "type":"integer",
            "description":"The unique identifier of a constraint.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "constraintCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user specified identifier for a constraint.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCompanyId":{
            "type":"integer",
            "description":"The system-generated unique identifier of the company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "notes":{
            "maxLength":"0",
            "type":"string",
            "description":"The Notes on the constraint. ",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "constraintName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of a constraint.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateIdentified":{
            "type":"string",
            "description":"The date the constraint was first identified as an impediment to completing a task.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateNeeded":{
            "type":"string",
            "description":"The date the constraint needs to be resolved by to prevent a delay in the completion of the tasks or task milestones that are dependent on it.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "promisedDate":{
            "type":"string",
            "description":"The date by which the responsible party has agreed to resolve the constraint.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "deliveredDate":{
            "type":"string",
            "description":"The date the responsible party actually resolved the constraint.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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 constraint. This entity can only be used to assign codeValues or create codeValues on the fly.

Show Source

• Array of: object ApiEntityCodeValueConstraint
  Title: ApiEntityCodeValueConstraint

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

Nested Schema : configuredFields

Type: array

The list of configured fields for a constraint.

Show Source

• Array of: object ApiEntityConstraintConfiguredFieldValue
  Title: ApiEntityConstraintConfiguredFieldValue

{
    "type":"array",
    "description":"The list of configured fields for a constraint.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityConstraintConfiguredFieldValue",
        "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 : ApiEntityCodeValueConstraint

Type: object

Title: ApiEntityCodeValueConstraint

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.
• codeValueConstraintId: integer (int64)
  The unique identifier of a code value of a constraint.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• codeValueName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the code 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.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• 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.

{
    "title":"ApiEntityCodeValueConstraint",
    "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"
            ]
        },
        "constraintId":{
            "type":"integer",
            "description":"The unique identifier of a constraint.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueConstraintId":{
            "type":"integer",
            "description":"The unique identifier of a code value of a constraint.",
            "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"
            ]
        },
        "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 : ApiEntityConstraintConfiguredFieldValue

Type: object

Title: ApiEntityConstraintConfiguredFieldValue

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.
• constraintId: integer (int64)
  The unique identifier of a constraint.
• constraintUdfValueId: integer (int64)
  The system-generated unique identifier of the Constraint Configured Field.
• 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.

{
    "title":"ApiEntityConstraintConfiguredFieldValue",
    "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"
            ]
        },
        "constraintUdfValueId":{
            "type":"integer",
            "description":"The system-generated unique identifier of the Constraint 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
}

204 Response

Successful operation with no content.

404 Response

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

Back to Top