Update a Constraint
put
/api/restapi/constraint
Send a request to this endpoint to update a constraint.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityConstraintInput
Type:
object
Title:
ApiEntityConstraintInput
This entity represents a Constraint object, a unique Constraint object can be identified by the following combinations of the fields.
Show Source
- constraintId
- constraintCode,constraintName,projectId
- constraintCode,constraintName,projectCode,workspaceCode
-
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(required): string
Minimum Length:
1
Maximum Length:60
The user specified identifier for a constraint. -
constraintId: integer
(int64)
The unique identifier of a constraint.
-
constraintName(required): 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(required): 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(required): integer
(int64)
The system-generated unique identifier of the company.
-
projectId(required): 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: stringRead Only:true
Allowed Values:[ "NOT_PLANNED", "PLANNED", "DELIVERED" ]
Deprecated. As of 23.12.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.
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 ApiEntityCodeValueConstraintInput
Title:
ApiEntityCodeValueConstraintInput
This entity represents a CodeValueConstraint object, a unique CodeValueConstraint object can be identified by the following combinations of the fields.- codeValueConstraintId
- 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
Nested Schema : configuredFields
Type:
array
The list of configured fields for a constraint.
Show Source
-
Array of:
object ApiEntityConstraintConfiguredFieldValueInput
Title:
ApiEntityConstraintConfiguredFieldValueInput
This entity represents a ConstraintConfiguredFieldValue object, a unique ConstraintConfiguredFieldValue object can be identified by the following combinations of the fields.- constraintUdfValueId
- columnDefinitionId
- columnName
- columnLabel
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
Nested Schema : ApiEntityCodeValueConstraintInput
Type:
object
Title:
ApiEntityCodeValueConstraintInput
This entity represents a CodeValueConstraint object, a unique CodeValueConstraint object can be identified by the following combinations of the fields.
Show Source
- codeValueConstraintId
- 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
-
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: stringMinimum Length:0
Maximum Length:255
Deprecated. As of 23.11.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)Read Only:true
Deprecated. As of 23.10.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)Deprecated. As of 23.11.The number that specifies the position of the code value item within the code type list. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : ApiEntityConstraintConfiguredFieldValueInput
Type:
object
Title:
ApiEntityConstraintConfiguredFieldValueInput
This entity represents a ConstraintConfiguredFieldValue object, a unique ConstraintConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- constraintUdfValueId
- columnDefinitionId
- columnName
- columnLabel
-
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: numberRead Only:true
Deprecated. As of 23.10.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)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace1 currency conversion. -
costValueWorkspace2: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace2 currency conversion. -
costValueWorkspace3: number(double)Read Only:true
Deprecated. As of 23.10.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: stringRead Only:true
Maximum Length:4000
Deprecated. As of 23.10.Provides the error message for why the formula calculation resulted in an error. -
hasException: booleanRead Only:true
Deprecated. As of 23.10.Determines if formula calculation hit an error calculating a value for this field. -
link: string(url)Read Only:true
Deprecated. As of 23.10.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)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
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.
Show Source
- taskConstraintId
- constraintId,workManagerTaskId
-
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)Read Only:true
Deprecated. As of 23.10.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)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
workManagerTaskId: integer
(int64)
The unique identifier of a task.
Examples
Back to Top
Response
204 Response
Successful operation with no content.
400 Response
Invalid input for the Constraint service.