Batch Sync Assignments
post
/api/restapi/assignment/syncBatch
Send a request to this endpoint to create or update one or more assignments.
Request
Header Parameters
-
singleTransaction:
Enabling this boolean flag fails to complete the request if an error occurred when processing any assignment sent as part of the request.
Allowed Values: [ "true", "false" ].Default Value:false
Supported Media Types
- application/json
Root Schema : List<ApiEntityAssignment>
Type:
array
Title:
Show Source
List<ApiEntityAssignment>
-
Array of:
object ApiEntityAssignment
Title:
ApiEntityAssignment
This entity represents a Assignment object, a unique Assignment object can be identified by the following combinations of the fields.- assignmentId
- activityId,resourceId,assignmentCode
- activityCode,projectCode,workspaceCode,resourceId,assignmentCode
- activityId,workspaceCode,resourceCode,resourceClass,assignmentCode
- activityCode,projectCode,workspaceCode,resourceCode,resourceClass,assignmentCode
Nested Schema : ApiEntityAssignment
Type:
object
Title:
ApiEntityAssignment
This entity represents a Assignment object, a unique Assignment object can be identified by the following combinations of the fields.
Show Source
- assignmentId
- activityId,resourceId,assignmentCode
- activityCode,projectCode,workspaceCode,resourceId,assignmentCode
- activityId,workspaceCode,resourceCode,resourceClass,assignmentCode
- activityCode,projectCode,workspaceCode,resourceCode,resourceClass,assignmentCode
-
activityCode: string
Minimum Length:
0
Maximum Length:60
The activity code of an assignment. -
activityId(required): integer
(int64)
The unique identifier for the activity.The activity object can also be identified by its unique criteria.
-
actualDuration: number
(double)
Read Only:
true
The total working time from the assignment actual start date to the actual finish date for completed assignments, or the total working time from the actual start date to the data date for in-progress assignments. -
actualFinish: string
(date-time)
The date on which the assignment was completed.
-
actualStart: string
(date-time)
If the activity has started, the date work began on the activity.
-
actualThisPeriodUnits: integer
(int64)
The actual cost of an activity resource assignment during this period.
-
actualUnits: integer
(int64)
The sum of the actual non-overtime and the overtime units worked by the resource on the activity.
-
assignmentCode: string
Minimum Length:
0
Maximum Length:60
A unique identifier for the assignment. -
assignmentFinancial:
assignmentFinancial
List all assignment cost field spread data assigned to the assignment.
-
assignmentId: integer
(int64)
The system-generated identifier of an assignment.
-
atCompletionDuration: number
(double)
Read Only:
true
The total working time from the assignment's current start date to the current finish date. -
atCompletionUnits: integer
(int64)
The sum of the actual units and remaining units for the resource assignment on the activity.
Calculated as Actual Units plus Remaining Units. -
baselineUnits: integer
(int64)
Read Only:
true
The number of baseline units for the activity. -
calculateCostFromUnitsFlag: boolean
Indicates whether to calculate costs based on units for an assignment.
-
calendarId: integer
(int64)
The calendar used to record and track the assignment.
-
configuredFields: array
configuredFields
The list of configured fields for an assignment.
-
curveId: integer
(int64)
The resource's units and costs distributed over the duration of an activity.
-
curveName: string
Minimum Length:
1
Maximum Length:255
The name of the curve profile. -
driveActivityDates: boolean
Determines whether new resource or role assignments determine activity dates.
-
earnedValueUnits: integer
(int64)
Read Only:
true
The portion of baseline labor units that are complete as of the project data date. -
estimateAtCompletionUnits: integer
(int64)
Read Only:
true
The estimated units at completion of the assignment. -
estimateToCompletionUnits: integer
(int64)
Read Only:
true
The estimated quantity to complete the assignment. -
finishDate: string
(date-time)
The finish date for the assignment.
-
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
plannedDuration: number
(double)
The resource's total working time on the activity from the Planned Start date to the Planned Finish date.
-
plannedFinish: string
(date-time)
The date the assignment is scheduled to be finished. It is calculated by the scheduler and will not change once the activity has started.
-
plannedLag: number
(double)
The planned time lag between the activity's planned start date and the resource's planned start date on the activity.
-
plannedStart: string
(date-time)
The planned start date for the assignment on the activity.
-
plannedUnits: integer
(int64)
The planned units of work for the resource assignment on the activity.
-
plannedUnitsPerHour: integer
(int64)
The planned units per time at which the resource is to perform work on the activity.
-
plannedValueUnits: integer
(int64)
Read Only:
true
The product of the budget at completion and the schedule percent complete. -
pricePerUnitSourceType: string
Allowed Values:
[ "RESOURCE", "ROLE", "OVERRIDE" ]
The value that indicates which Price/Unit will be used to calculate costs for the assignment. Valid options are Resource, Role, or Override. -
priorActualUnits: integer
(int64)
Read Only:
true
The total actual units incurred at the time of the last stored period performance. This represents the total units incurred from the last period closeout date. -
proficiency: string
Allowed Values:
[ "ONE", "TWO", "THREE", "FOUR", "FIVE" ]
The skill level of the resource an activity is assigned to. The valid values are Master, Expert, Skilled, Proficient, and Inexperienced. -
projectCode: string
Minimum Length:
1
Maximum Length:60
The project code of an assignment. -
projectId: integer
(int64)
The unique identifier for the project.
-
rateType: string
Allowed Values:
[ "CUSTOM", "PRICE_PER_UNIT_1", "PRICE_PER_UNIT_2", "PRICE_PER_UNIT_3", "PRICE_PER_UNIT_4", "PRICE_PER_UNIT_5" ]
The type of rate that defines the activity. -
remainingDuration: number
(double)
The remaining working time for the resource assignment on the activity, from the resource's remaining start date to the remaining finish date.
-
remainingFinish: string
(date-time)
The date the assignment is scheduled to be finished.
-
remainingLag: number
(double)
The time lag between the activity's remaining start date and the resource's remaining start date on the activity.
-
remainingLateFinish: string
(date-time)
The latest possible date the assignment must be finished to not delay the project finish date.
-
remainingLateStart: string
(date-time)
The latest possible date the assignment must begin to not delay the project finish date.
-
remainingStart: string
(date-time)
The date the assignment is scheduled to begin.
-
remainingUnits: integer
(int64)
The remaining units of work to be performed by the resource on the activity.
-
remainingUnitsPerHour: integer
(int64)
The units per time required for the resource assignment to complete the activity.
-
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class of the resource of an assignment. -
resourceCode: string
Minimum Length:
1
Maximum Length:60
The user-specified identifier of a resource. -
resourceCurve:
resourceCurve
The resource's units and costs distributed over the duration of an activity.
-
resourceId(required): integer
(int64)
The unique identifier for the resource.The resource object can also be identified by its unique criteria.
-
resourceRoleCode: string
Minimum Length:
1
Maximum Length:60
The user-specified identifier of a contract. -
resourceRoleId: integer
(int64)
The identifier for the role assigned to the resource.
-
resourceType: string
Read Only:
true
Allowed Values:[ "LABOR", "NONLABOR", "MATERIAL" ]
The resource type. Valid values are Labor, Nonlabor, and Material. -
schedulePercentComplete: number
(double)
The assignment schedule percent complete, which specifies how much of the assignment's project baseline duration is complete so far.
-
staffedRemainingUnits: integer
(int64)
Read Only:
true
The number of staff units remaining for one or more resource assignments. -
starred: boolean
Read Only:
true
Specifies whether the assignment has been marked as important. -
startDate: string
(date-time)
The start date for the activity assignment.
-
totalRemainingLag: number
(double)
The sum of expired lag and remaining lag for the activity.
-
unitsPercentComplete: number
(double)
The percent complete of units for the resource assignment on the activity.
-
unstaffedRemainingUnits: integer
(int64)
Read Only:
true
The number of unstaffed units remaining for one or more resource assignments. -
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The workspace code of an assignment.
Nested Schema : assignmentFinancial
List all assignment cost field spread data assigned to the assignment.
Match All
Show Source
-
object
ApiEntityAssignmentFinancial
Title:
ApiEntityAssignmentFinancial
Nested Schema : configuredFields
Type:
array
The list of configured fields for an assignment.
Show Source
-
Array of:
object ApiEntityAssignmentConfiguredFieldValue
Title:
ApiEntityAssignmentConfiguredFieldValue
This entity represents a AssignmentConfiguredFieldValue object, a unique AssignmentConfiguredFieldValue object can be identified by the following combinations of the fields.- assignmentConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
Nested Schema : resourceCurve
The resource's units and costs distributed over the duration of an activity.
Match All
Show Source
-
object
ApiEntityCurve
Title:
ApiEntityCurve
Nested Schema : ApiEntityAssignmentFinancial
Type:
object
Title:
Show Source
ApiEntityAssignmentFinancial
-
activity: integer
(int64)
The system-generated identifier of an activity.
-
actualCost: number
(double)
The actual cost for the resource assignment on the activity. This field is in base currency and is calculated from actualCostProject field based on the specified exchange rate.
-
actualCostProject: number
(double)
The actual cost for the resource assignment on the activity. This value is based on the project currency.
-
actualThisPeriodCost: number
(double)
The labor, nonlabor, and material costs incurred during the current financial period. This field is in base currency and is calculated from actualThisPeriodCostProject field based on the specified exchange rate.
-
actualThisPeriodCostProject: number
(double)
The labor, nonlabor, and material costs incurred during the current financial period. This value is based on the project currency.
-
assignment: integer
(int64)
The unique identifier for the assignment.
-
assignmentId: integer
(int64)
The unique identifier for the assignment.
-
atCompletionCost: number
(double)
The sum of the actual costs plus remaining costs for the resource assignment on the activity. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.
-
atCompletionCostProject: number
(double)
The sum of the actual costs plus remaining costs for the resource assignment on the activity. This value is based on the project currency.
-
earnedValueCost: number
(double)
Read Only:
true
The remaining cost for resource assignments that have a filled role. This field is in base currency and is calculated from earnedValueCostProject field based on the specified exchange rate. -
earnedValueCostProject: number
(double)
Read Only:
true
The approved budget for work actually completed by the specified project data date. This value is based on the project currency. -
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
plannedCost: number
(double)
The expected total cost of the item, such as an assignment, expense, or response plan. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.
-
plannedCostProject: number
(double)
The expected total cost of the item, such as an assignment, expense, or response plan. This value is based on the project currency.
-
plannedValueCost: number
(double)
Read Only:
true
The amount of approved capital spent on a scheduled portion of work on a project. This field is in base currency and is calculated from plannedValueCostProject field based on the specified exchange rate. -
plannedValueCostProject: number
(double)
Read Only:
true
The amount of approved capital spent on a scheduled portion of work on a project. This value is based on the project currency. -
pricePerUnit: number
(double)
Minimum Value:
0
The price per unit of time for the resource or role. This field is in base currency and is calculated from pricePerUnitProject field based on the specified exchange rate. -
pricePerUnitProject: number
(double)
Minimum Value:
0
The price per unit of time for the resource or role. This value is based on the project currency. -
priorActualCost: number
(double)
Read Only:
true
The total actual costs incurred at the time of the last stored period performance. This field is in base currency and is calculated from priorActualCostProject field based on the specified exchange rate. -
priorActualCostProject: number
(double)
Read Only:
true
The total actual costs incurred at the time of the last stored period performance. This value is based on the project currency. -
project: integer
(int64)
The system-generated identifier of a project.
-
remainingCost: number
(double)
The remaining cost for the activity resource assignment. Calculated as Remaining Units multiplied by Cost/Time. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.
-
remainingCostProject: number
(double)
The remaining cost for the resource assignment on the activity. This value is based on the project currency.
-
resource: integer
(int64)
The system-generated identifier of a resource.
-
staffedRemainingCost: number
(double)
Read Only:
true
The remaining cost for resource assignments that have a filled role. This field is in base currency and is calculated from staffedRemainingCostProject field based on the specified exchange rate. -
staffedRemainingCostProject: number
(double)
Read Only:
true
The remaining cost for resource assignments that have a filled role. This value is based on the project currency. -
unstaffedRemainingCost: number
(double)
Read Only:
true
The remaining cost for resource assignments that do not have a filled role. This field is in base currency and is calculated from unstaffedRemainingCostProject field based on the specified exchange rate. -
unstaffedRemainingCostProject: number
(double)
Read Only:
true
The remaining cost for resource assignments that do not have a filled role. This value is based on the project currency. -
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated.
Nested Schema : ApiEntityAssignmentConfiguredFieldValue
Type:
object
Title:
ApiEntityAssignmentConfiguredFieldValue
This entity represents a AssignmentConfiguredFieldValue object, a unique AssignmentConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- assignmentConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
assignmentConfiguredFieldValueId: integer
(int64)
The unique identifier for the Assignment Configured Field.
-
assignmentId: integer
(int64)
The system-generated identifier of an assignment.
-
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
Read Only:
true
Minimum Length:1
Maximum Length:100
The user-specified UDF column name. -
costValue: number
Read Only:
true
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
This holds values for Cost type configured fields in the workspace1 currency conversion. -
costValueWorkspace2: number
(double)
Read Only:
true
This holds values for Cost type configured fields in the workspace2 currency conversion. -
costValueWorkspace3: number
(double)
Read Only:
true
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
Read Only:
true
Maximum Length:4000
Provides the error message for why the formula calculation resulted in an error. -
hasException: boolean
Read Only:
true
Determines if formula calculation hit an error calculating a value for this field. -
link: string
(url)
Read Only:
true
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
Date when the record was last updated.
Nested Schema : ApiEntityCurve
Type:
object
Title:
Show Source
ApiEntityCurve
-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the curve and the workspace. Possible values are Owned and Inherited. -
buckets: array
buckets
The buckets of a cost curve.
-
curveId: integer
(int64)
The unique identifier of a curve.
-
curveName: string
Minimum Length:
1
Maximum Length:255
The name of the curve profile. -
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" ]
It describes 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. -
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.
Nested Schema : buckets
Type:
array
The buckets of a cost curve.
Show Source
-
Array of:
object ApiEntityCurveBucket
Title:
ApiEntityCurveBucket
Nested Schema : ApiEntityCurveBucket
Type:
object
Title:
Show Source
ApiEntityCurveBucket
-
bucketLevel: integer
(int32)
The level of a curve bucket.
-
curveBucketId: integer
(int64)
The unique identifier of a curve bucket.
-
curveId: integer
(int64)
The unique identifier of a curve.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
value: number
Numeric value of a bucket curve. Curve bucket values determine the shape of curves.
Examples
Back to Top
Response
Supported Media Types
- application/json
207 Response
The object was successfully integrated.
Root Schema : List<ApiEntitySyncApiResponse>
Type:
array
Title:
Show Source
List<ApiEntitySyncApiResponse>
-
Array of:
object ApiEntitySyncApiResponse
Title:
ApiEntitySyncApiResponse
Nested Schema : ApiEntitySyncApiResponse
Type:
object
Title:
Show Source
ApiEntitySyncApiResponse
-
identifier: object
identifier
The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked. -
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
message: string
Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.
-
statusCode: integer
(int32)
The response code representing the state of the API operation.
Nested Schema : identifier
Type:
object
The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked.
Match One Schema
Show Source
-
object
ConstraintIdentifier
Title:
ConstraintIdentifier
-
object
CBSSheetSegmentIdentifier
Title:
CBSSheetSegmentIdentifier
-
object
CBSTemplateSegmentIdentifier
Title:
CBSTemplateSegmentIdentifier
-
object
ScopeAssignmentActualsTimePhasedDataIdentifier
Title:
ScopeAssignmentActualsTimePhasedDataIdentifier
-
object
ScopeAssignmentInstalledTimePhasedDataIdentifier
Title:
ScopeAssignmentInstalledTimePhasedDataIdentifier
-
object
ResourceWorkRateIdentifier
Title:
ResourceWorkRateIdentifier
-
object
ReasonIdentifier
Title:
ReasonIdentifier
-
object
WorkManagerTaskIdentifier
Title:
WorkManagerTaskIdentifier
-
object
ChangeRequestIdentifier
Title:
ChangeRequestIdentifier
-
object
ScopeItemAssignmentActivityIdentifier
Title:
ScopeItemAssignmentActivityIdentifier
-
object
RiskScoreTypeIdentifier
Title:
RiskScoreTypeIdentifier
-
object
RiskMatrixIdentifier
Title:
RiskMatrixIdentifier
-
object
ProjectRiskIdentifier
Title:
ProjectRiskIdentifier
-
object
ProgramRiskIdentifier
Title:
ProgramRiskIdentifier
-
object
ActivityRiskIdentifier
Title:
ActivityRiskIdentifier
-
object
RiskMitigationIdentifier
Title:
RiskMitigationIdentifier
-
object
ProgramRiskMitigationIdentifier
Title:
ProgramRiskMitigationIdentifier
-
object
ProgramRiskWeatherPeriodIdentifier
Title:
ProgramRiskWeatherPeriodIdentifier
-
object
HolidayGroupIdentifier
Title:
HolidayGroupIdentifier
-
object
RiskWeatherPeriodIdentifier
Title:
RiskWeatherPeriodIdentifier
-
object
PortfolioIdentifier
Title:
PortfolioIdentifier
-
object
PortfolioMeasureIdentifier
Title:
PortfolioMeasureIdentifier
-
object
EntityReferenceIdentifier
Title:
EntityReferenceIdentifier
-
object
PortfolioMeasureManualValueIdentifier
Title:
PortfolioMeasureManualValueIdentifier
-
object
CustomLogTypeObjectIdentifier
Title:
CustomLogTypeObjectIdentifier
-
object
CustomLogItemIdentifier
Title:
CustomLogItemIdentifier
-
object
ProjectRankIdentifier
Title:
ProjectRankIdentifier
-
object
ProjectDependencyIdentifier
Title:
ProjectDependencyIdentifier
-
object
LocationIdentifier
Title:
LocationIdentifier
-
object
MeasureIdentifier
Title:
MeasureIdentifier
-
object
MeasureThresholdIdentifier
Title:
MeasureThresholdIdentifier
-
object
ReportCycleIdentifier
Title:
ReportCycleIdentifier
-
object
UnitsOfMeasureIdentifier
Title:
UnitsOfMeasureIdentifier
-
object
WorkspaceIdentifier
Title:
WorkspaceIdentifier
-
object
ApplicationUserGroupIdentifier
Title:
ApplicationUserGroupIdentifier
-
object
CalendarIdentifier
Title:
CalendarIdentifier
-
object
CodeTypeIdentifier
Title:
CodeTypeIdentifier
-
object
CodeValueIdentifier
Title:
CodeValueIdentifier
-
object
CostCategoryIdentifier
Title:
CostCategoryIdentifier
-
object
CurveIdentifier
Title:
CurveIdentifier
-
object
DocumentFolderStructureTemplateIdentifier
Title:
DocumentFolderStructureTemplateIdentifier
-
object
IdeaIdentifier
Title:
IdeaIdentifier
-
object
OfficeIdentifier
Title:
OfficeIdentifier
-
object
ProjectCompanyIdentifier
Title:
ProjectCompanyIdentifier
-
object
ResourceDemandIdentifier
Title:
ResourceDemandIdentifier
-
object
ProjectBudgetChangeIdentifier
Title:
ProjectBudgetChangeIdentifier
-
object
ProjectBudgetTransferIdentifier
Title:
ProjectBudgetTransferIdentifier
-
object
ProjectResourceWorkRateIdentifier
Title:
ProjectResourceWorkRateIdentifier
-
object
ProjectActualsLineItemIdentifier
Title:
ProjectActualsLineItemIdentifier
-
object
ProjectActualsIdentifier
Title:
ProjectActualsIdentifier
-
object
ProjectBudgetItemIdentifier
Title:
ProjectBudgetItemIdentifier
-
object
ProgramIdentifier
Title:
ProgramIdentifier
-
object
StrategyIdentifier
Title:
StrategyIdentifier
-
object
StrategyTypeIdentifier
Title:
StrategyTypeIdentifier
-
object
RuleOfCreditIdentifier
Title:
RuleOfCreditIdentifier
-
object
ResourceRoleAssignmentIdentifier
Title:
ResourceRoleAssignmentIdentifier
-
object
BudgetPlanningScenarioIdentifier
Title:
BudgetPlanningScenarioIdentifier
-
object
ScopeAssignmentPlannedTimePhasedDataIdentifier
Title:
ScopeAssignmentPlannedTimePhasedDataIdentifier
-
object
ProgramBudgetTransferIdentifier
Title:
ProgramBudgetTransferIdentifier
-
object
ProgramBudgetChangeIdentifier
Title:
ProgramBudgetChangeIdentifier
-
object
ActivityIdentifier
Title:
ActivityIdentifier
-
object
AssignmentIdentifier
Title:
AssignmentIdentifier
-
object
RelationshipIdentifier
Title:
RelationshipIdentifier
-
object
FundActualIdentifier
Title:
FundActualIdentifier
-
object
ProgramBudgetItemIdentifier
Title:
ProgramBudgetItemIdentifier
Nested Schema : ConstraintIdentifier
Type:
object
Title:
Show Source
ConstraintIdentifier
-
constraintCode(required): string
The user specified identifier for a constraint.
-
constraintId: integer
(int64)
The unique identifier of a constraint.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : CBSSheetSegmentIdentifier
Type:
object
Title:
Show Source
CBSSheetSegmentIdentifier
-
cbsSheetSegmentId: integer
(int64)
The system-generated identifier of a cost sheet segment. This value should not be provided in create operation request data, however, it is required for update requests.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
segmentDefinitionName(required): string
Maximum Length:
255
The name of the level of the cost breakdown structure segment definition. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CBSTemplateSegmentIdentifier
Type:
object
Title:
Show Source
CBSTemplateSegmentIdentifier
-
cbsTemplateSegmentId: integer
(int64)
The unique identifier for the CBS segment. This value should not be provided in create operation request data, however, it is required for update requests.
-
segmentDefinitionName(required): string
Maximum Length:
255
The name of the CBS segment. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ScopeAssignmentActualsTimePhasedDataIdentifier
Type:
object
Title:
Show Source
ScopeAssignmentActualsTimePhasedDataIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
scopeAssignmentActualsTimePhasedDataId: integer
(int64)
The unique identifier of scope actuals time phased data. This value should not be provided in create operation request data, however, it is required for update requests.
-
scopeItemAssignCode: string
Maximum Length:
60
The user-specified unique identifier for the scope assignment. -
scopeItemAssignmentId: integer
(int64)
The unique identifier for the scope item assigned to the work package.
-
scopeItemCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier for the scope item. -
workPackageCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the work package. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ScopeAssignmentInstalledTimePhasedDataIdentifier
Type:
object
Title:
Show Source
ScopeAssignmentInstalledTimePhasedDataIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
scopeAssignmentInstalledTimePhasedDataId: integer
(int64)
The unique identifier of scope assignment data. This value should not be provided in create operation request data, however, it is required for update requests.
-
scopeItemAssignCode: string
Maximum Length:
60
The user-specified unique identifier for the scope assignment. -
scopeItemAssignmentId: integer
(int64)
The unique identifier for the scope item assigned to the work package.
-
scopeItemCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier for the scope item. -
workPackageCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the work package. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ResourceWorkRateIdentifier
Type:
object
Title:
Show Source
ResourceWorkRateIdentifier
-
effectiveStartDate: string
(date-time)
Date that the corresponding units/time period and rates go into effect for the resource or role.
-
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class identifies the item as a resource or a role. -
resourceCode: string
Maximum Length:
60
The unique identifier for the resource or role. -
resourceId: integer
(int64)
The unique identifier for the resource or role.
-
resourceWorkRateId: integer
(int64)
The system-generated identifier of the work rate.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
-
workspaceResourceId: integer
(int64)
The unique identifier for the resource.The resource object can also be identified by its unique criteria.
Nested Schema : ReasonIdentifier
Type:
object
Title:
Show Source
ReasonIdentifier
-
reasonId: integer
(int64)
The unique identifier of a reason.
-
reasonName: string
Maximum Length:
255
The name of the reason for recommitting to a task. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : WorkManagerTaskIdentifier
Type:
object
Title:
Show Source
WorkManagerTaskIdentifier
-
itemCode: string
Maximum Length:
60
The user-specified unique identifier assigned to the task. -
project: integer
(int64)
The unique identifier for the project.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
workManagerTaskId: integer
(int64)
The unique identifier for the resource or role.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ChangeRequestIdentifier
Type:
object
Title:
Show Source
ChangeRequestIdentifier
-
changeRequestCode: string
Maximum Length:
60
The user-specified unique identifier of the change request. -
changeRequestId: integer
(int64)
The unique identifier of the change request.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ScopeItemAssignmentActivityIdentifier
Type:
object
Title:
Show Source
ScopeItemAssignmentActivityIdentifier
-
activityCode: string
Maximum Length:
60
The user-specified identifier of the activity. -
activityId: integer
(int64)
The unique identifier for the activity.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
scopeItemAssignmentActivityId: integer
(int64)
The system-generated identifier of a scope item.
-
scopeItemAssignmentCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier for the scope item. -
scopeItemAssignmentId: integer
(int64)
The unique identifier for the scope item assigned to the work package.
-
scopeItemCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier for the scope item. -
workPackageCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the work package. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : RiskScoreTypeIdentifier
Type:
object
Title:
Show Source
RiskScoreTypeIdentifier
-
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
riskScoreTypeId: integer
(int64)
The unique identifier of a score type.
-
riskScoreTypeName: string
Maximum Length:
255
The name of the risk score type. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : RiskMatrixIdentifier
Type:
object
Title:
Show Source
RiskMatrixIdentifier
-
matrixName: string
Maximum Length:
60
The name of the risk scoring matrix. -
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
riskMatrixId: integer
(int64)
The system-generated identifier of the risk matrix.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ProjectRiskIdentifier
Type:
object
Title:
Show Source
ProjectRiskIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
projectRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ProgramRiskIdentifier
Type:
object
Title:
Show Source
ProgramRiskIdentifier
-
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
programRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ActivityRiskIdentifier
Type:
object
Title:
Show Source
ActivityRiskIdentifier
-
activityCode: string
Maximum Length:
60
The user-specified identifier of the activity. -
activityId: integer
(int64)
The unique identifier of an activity assigned to a risk.
-
activityRiskId: integer
(int64)
The unique identifier for the activity.The activity object can also be identified by its unique criteria.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
projectRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : RiskMitigationIdentifier
Type:
object
Title:
Show Source
RiskMitigationIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
projectRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
riskMitigationCode: string
Maximum Length:
60
The unique identifier for the risk response action item. -
riskMitigationId: integer
(int64)
The system-generated identifier of a risk mitigation.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProgramRiskMitigationIdentifier
Type:
object
Title:
Show Source
ProgramRiskMitigationIdentifier
-
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
programRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
programRiskMitigationCode: string
Maximum Length:
60
The unique identifier for the risk response action item. -
programRiskMitigationId: integer
(int64)
The system-generated identifier of a risk mitigation.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProgramRiskWeatherPeriodIdentifier
Type:
object
Title:
Show Source
ProgramRiskWeatherPeriodIdentifier
-
periodName: string
Maximum Length:
255
The name of the period. -
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
programRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
programRiskWeatherPeriodId: integer
(int64)
The system-generated identifier for the period.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : HolidayGroupIdentifier
Type:
object
Title:
Show Source
HolidayGroupIdentifier
-
holidayGroupName: string
Maximum Length:
60
The name of the holiday list. -
holidayListId: integer
(int64)
The unique identifier for the holiday list.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : RiskWeatherPeriodIdentifier
Type:
object
Title:
Show Source
RiskWeatherPeriodIdentifier
-
periodName: string
Maximum Length:
255
The name of the period. -
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
projectRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
riskWeatherPeriodId: integer
(int64)
The system-generated identifier for the period.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : PortfolioIdentifier
Type:
object
Title:
Show Source
PortfolioIdentifier
-
name: string
Minimum Length:
1
Maximum Length:255
The name of the portfolio. -
portfolioId: integer
(int64)
The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : PortfolioMeasureIdentifier
Type:
object
Title:
Show Source
PortfolioMeasureIdentifier
-
measureId: integer
(int64)
The unique identifier of a portfolio measure.
-
measureName: string
Maximum Length:
255
The name of the measure. -
portfolioId: integer
(int64)
The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
-
portfolioMeasureId: integer
(int64)
The unique identifier of a portfolio measure.
-
portfolioName: string
Maximum Length:
255
The name of the portfolio. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : EntityReferenceIdentifier
Type:
object
Title:
Show Source
EntityReferenceIdentifier
-
entityReferenceId: integer
(int64)
The system-generated identifier of a reference.
Nested Schema : PortfolioMeasureManualValueIdentifier
Type:
object
Title:
Show Source
PortfolioMeasureManualValueIdentifier
-
beginDate: string
(date-time)
The start date of a portfolio.
-
capitalPortfolioId: integer
(int64)
The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.
-
endDate: string
(date-time)
The end date of the portfolio.
-
measureId: integer
(int64)
The unique identifier of a portfolio measure.
-
measureName: string
Maximum Length:
255
The name of the measure. -
portfolioMeasureManualValueId: integer
(int64)
The unique identifier of a portfolio measure.
-
portfolioName: string
Maximum Length:
255
The name of the portfolio. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : CustomLogTypeObjectIdentifier
Type:
object
Title:
Show Source
CustomLogTypeObjectIdentifier
-
customLogTypeObjectId: integer
(int64)
The system-generated identifier of custom log type object.
-
customLogTypeObjectName: string
The user-defined identifier of a custom log type object.
-
scope: string
Maximum Length:
40
Allowed Values:[ "project", "program", "workspace" ]
The scope of an object. -
scopeCode: string
The user-defined identifier of a reference to another object.
-
scopeId: integer
(int64)
The system-generated identifier of a reference to another object.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CustomLogItemIdentifier
Type:
object
Title:
Show Source
CustomLogItemIdentifier
-
customLogItemCode: string
Maximum Length:
60
A unique identifier unique of the custom log item. -
customLogItemId: integer
(int64)
The system-generated identifier of a custom log item. This value should not be provided in create operation request data, however, it is required for update requests.
-
customLogTypeObjectId: integer
(int64)
The unique identifier for the custom log type object.The custom log type object can also be identified by its unique criteria.
-
customLogTypeObjectName: string
The user-specified identifier of a custom log type.
-
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ProjectRankIdentifier
Type:
object
Title:
Show Source
ProjectRankIdentifier
-
evaluationCategoryId: integer
(int64)
Evaluation category ID.
-
evaluationSubCategoryId: integer
(int64)
Evaluation subcategory ID.
-
projectId: integer
(int64)
The system-generated identifier of the project.
-
projectRankId: integer
(int64)
The system-generated identifier of the project rank.
Nested Schema : ProjectDependencyIdentifier
Type:
object
Title:
Show Source
ProjectDependencyIdentifier
-
dependentProjectCode: string
The project code of a project that has other projects that it relies on for support.
-
dependentProjectId: integer
(int64)
The unique identifier of a project that has other projects that it relies on for support.
-
dependentProjectWorkspaceCode: string
The workspace code of a project that has other projects that it relies on for support.#project invalid inputs
-
projectCode: string
The project code of a project that has other projects depending on it.
-
projectDependencyId: integer
(int64)
The unique identifier of a project dependency.
-
projectId: integer
(int64)
The unique identifier of a project that has other projects depending on it.
-
projectWorkspaceCode: string
The workspace code of a project that has other projects depending on it.
Nested Schema : LocationIdentifier
Type:
object
Title:
Show Source
LocationIdentifier
-
locationCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier of the location. -
locationId: integer
(int64)
The unique identifier for the location.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : MeasureIdentifier
Type:
object
Title:
Show Source
MeasureIdentifier
-
measureId: integer
(int64)
The unique identifier of a measure.
-
measureName: string
Maximum Length:
255
The name of the measure. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : MeasureThresholdIdentifier
Type:
object
Title:
Show Source
MeasureThresholdIdentifier
-
computeAgainstType: string
Allowed Values:
[ "ACTUAL_VALUE", "PERCENT_OF_TARGET" ]
The against type of a threshold. -
desirableState: string
Allowed Values:
[ "HIGH_VALUES", "LOW_VALUES" ]
The type of direction of a threshold. -
measureId: integer
(int64)
The unique identifier of a measure.
-
measureName: string
Maximum Length:
255
The name of the measure. -
measureThresholdId: integer
(int64)
The unique identifier of a threshold.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ReportCycleIdentifier
Type:
object
Title:
Show Source
ReportCycleIdentifier
-
cycleName: string
Maximum Length:
255
The name of the reporting cycle. -
reportCycleId: integer
(int64)
The unique identifier of a report cycle.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : UnitsOfMeasureIdentifier
Type:
object
Title:
Show Source
UnitsOfMeasureIdentifier
-
key: string
Maximum Length:
60
The abbreviation for the unit of measure name. -
unitOfMeasureId: integer
(int64)
The unique identifier for the unit of measure.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : WorkspaceIdentifier
Type:
object
Title:
Show Source
WorkspaceIdentifier
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApplicationUserGroupIdentifier
Type:
object
Title:
Show Source
ApplicationUserGroupIdentifier
-
applicationUserGroupId: integer
(int64)
The unique identifier of a user group.
-
groupName: string
Minimum Length:
1
Maximum Length:255
Name of a user group. -
scope: string
Allowed Values:
[ "PROJECT", "WORKSPACE" ]
Type of a user group. -
scopeCode: string
The unique identifier for a project/workspace set by the user who created the project/workspace.
-
scopeId: integer
(int64)
The unique identifier of a project/workspace.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CalendarIdentifier
Type:
object
Title:
Show Source
CalendarIdentifier
-
calendarCode: string
Maximum Length:
255
The unique code for the calendar. -
calendarId: integer
(int64)
The unique identifier for the calendar.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CodeTypeIdentifier
Type:
object
Title:
Show Source
CodeTypeIdentifier
-
codeTypeCode: string
Displays the code or ID of the Code Type.
-
codeTypeId: integer
(int64)
The system-generated identifier of a code type.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CodeValueIdentifier
Type:
object
Title:
Show Source
CodeValueIdentifier
-
codeTypeCode: string
Displays the code or ID of the Code Type.
-
codeTypeId: integer
(int64)
The system-generated identifier of a code type.
-
codeValueCode: string
Maximum Length:
60
The unique identifier for the code value. -
codeValueId: integer
(int64)
The unique identifier for the code value.
-
parentCVCodes: array
parentCVCodes
List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
-
parentId: integer
(int64)
The unique identifier of a parent code value.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : CostCategoryIdentifier
Type:
object
Title:
Show Source
CostCategoryIdentifier
-
abbreviation: string
Minimum Length:
1
Maximum Length:10
The abbreviation for the cost category name. -
costCategoryId: integer
(int64)
The system-generated identifier of a cost category.
-
costCategoryName: string
Minimum Length:
1
Maximum Length:255
The name of the cost category. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CurveIdentifier
Type:
object
Title:
Show Source
CurveIdentifier
-
curveId: integer
(int64)
The unique identifier of a curve.
-
curveName: string
Maximum Length:
255
The name of the curve profile. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : DocumentFolderStructureTemplateIdentifier
Type:
object
Title:
Show Source
DocumentFolderStructureTemplateIdentifier
-
documentFolderStructureTemplateId: integer
(int64)
The system-generated identifier of a document folder structure template.
-
templateName: string
Maximum Length:
255
The name of the document template. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : IdeaIdentifier
Type:
object
Title:
Show Source
IdeaIdentifier
-
ideaId: integer
(int64)
The system-generated identifier of an idea.
-
ideaName: string
The name of the Idea.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : OfficeIdentifier
Type:
object
Title:
Show Source
OfficeIdentifier
-
companyId: integer
(int64)
The system-generated identifier of a company.
-
companyName: string
Minimum Length:
1
Maximum Length:255
The name of the company. -
countryCode: string
Maximum Length:
3
The country for a location. -
officeId: integer
(int64)
The unique identifier of an office.
-
officeName: string
Minimum Length:
1
Maximum Length:255
The name of the office. -
postalCode: string
Maximum Length:
20
The postal code, post code, or zip code of a location.
Nested Schema : ProjectCompanyIdentifier
Type:
object
Title:
Show Source
ProjectCompanyIdentifier
-
companyId: integer
(int64)
The system-generated identifier of a company.
-
companyName: string
Minimum Length:
1
Maximum Length:255
The name of the company. -
postalCode: string
Maximum Length:
20
The postal code, post code, or zip code of a location. -
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectCompanyId: integer
(int64)
The system-generated unique identifier of the project company.
-
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ResourceDemandIdentifier
Type:
object
Title:
Show Source
ResourceDemandIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class identifies the item as a resource or a role. -
resourceCode: string
Maximum Length:
60
The unique identifier for the resource or role. -
resourceDemandId: integer
(int64)
The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.
-
resourceId: integer
(int64)
The unique identifier for the resource or role.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProjectBudgetChangeIdentifier
Type:
object
Title:
Show Source
ProjectBudgetChangeIdentifier
-
budgetChangeCode: string
Maximum Length:
60
The unique identifier of the project budget change request. -
budgetChangeId: integer
(int64)
The system-generated identifier of a budget change.
-
projectBudgetId: integer
(int64)
The system-generated identifier of a project budget.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProjectBudgetTransferIdentifier
Type:
object
Title:
Show Source
ProjectBudgetTransferIdentifier
-
budgetTransferCode: string
Maximum Length:
60
The unique identifier of the project budget transfer request. -
budgetTransferId: integer
(int64)
The system-generated identifier of a budget transfer.
-
projectBudgetId: integer
(int64)
The system-generated identifier of a project budget.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProjectResourceWorkRateIdentifier
Type:
object
Title:
Show Source
ProjectResourceWorkRateIdentifier
-
effectiveStartDate: string
(date-time)
Date that the corresponding units/time period and rates go into effect for the resource or role.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
projectResourceId: integer
(int64)
The unique identifier of a project resource.
-
projectResourceWorkRateId: integer
(int64)
The unique identifier of a project work rate.
-
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class identifies the item as a resource or a role. -
resourceCode: string
The code of a resource of a project resource.
-
resourceId: integer
(int64)
The unique identifier for the resource.The resource object can also be identified by its unique criteria.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProjectActualsLineItemIdentifier
Type:
object
Title:
Show Source
ProjectActualsLineItemIdentifier
-
projectActualsCode: string
The user-specified identifier of a project actual.
-
projectActualsId: integer
(int64)
The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.
-
projectActualsLineItemCode: string
Maximum Length:
60
The user-specified unique identifier for an actual line item. -
projectActualsLineItemId: integer
(int64)
The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProjectActualsIdentifier
Type:
object
Title:
Show Source
ProjectActualsIdentifier
-
projectActualsCode: string
The user-specified identifier of a project actual.
-
projectActualsId: integer
(int64)
The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProjectBudgetItemIdentifier
Type:
object
Title:
Show Source
ProjectBudgetItemIdentifier
-
budgetItemCode: string
Maximum Length:
60
The unique identifier of the project budget item. -
budgetItemId: integer
(int64)
The system-generated identifier of a budget item.
-
projectBudgetId: integer
(int64)
The system-generated identifier of a project budget.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProgramIdentifier
Type:
object
Title:
Show Source
ProgramIdentifier
-
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : StrategyIdentifier
Type:
object
Title:
Show Source
StrategyIdentifier
-
strategyId: integer
(int64)
The system-generated identifier of the strategy.
-
strategyName: string
The name of a strategy.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : StrategyTypeIdentifier
Type:
object
Title:
Show Source
StrategyTypeIdentifier
-
levelName: string
The name of a strategy.
-
strategyTypeId: integer
(int64)
The system-generated identifier of a strategy type. This value should not be provided in create operation request data, however, it is required for update requests.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : RuleOfCreditIdentifier
Type:
object
Title:
Show Source
RuleOfCreditIdentifier
-
rocId: integer
(int64)
Unique identifier of the rule of credit.
-
rocName: string
Minimum Length:
1
Maximum Length:255
The name of the rule of credit. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ResourceRoleAssignmentIdentifier
Type:
object
Title:
Show Source
ResourceRoleAssignmentIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
resourceCode: string
Maximum Length:
60
The unique identifier for the resource or role. -
resourceId: integer
(int64)
The unique identifier for the resource or role.
-
resourceRoleAssignmentId: integer
(int64)
The system-generated identifier of the resource role assignment.
-
roleCode: string
The user-specified identifier of the role.
-
roleId: integer
(int64)
The unique identifier for the role.The role object can also be identified by its unique criteria.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : BudgetPlanningScenarioIdentifier
Type:
object
Title:
Show Source
BudgetPlanningScenarioIdentifier
-
planPeriod: integer
(int32)
The period during which budget is allocated to projects within the plan.
This value determines the year in which budget planning timescales start.
You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
After the planning period for a budget plan has been set it cannot be changed. -
portfolioId: integer
(int64)
The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
-
portfolioName: string
Maximum Length:
255
The name of the portfolio. -
scenarioId: integer
(int64)
The system-generated identifier of the Budget Plan Scenario.
-
scenarioName: string
Maximum Length:
255
The name of Budget Plan Scenario. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ScopeAssignmentPlannedTimePhasedDataIdentifier
Type:
object
Title:
Show Source
ScopeAssignmentPlannedTimePhasedDataIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
scopeAssignmentPlannedTimePhasedDataId: integer
(int64)
The unique identifier of scope assignment plan data. This value should not be provided in create operation request data, however, it is required for update requests.
-
scopeItemAssignCode: string
Maximum Length:
60
The user-specified unique identifier for the scope assignment. -
scopeItemAssignmentId: integer
(int64)
The unique identifier for the scope item assigned to the work package.
-
workPackageCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the work package. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProgramBudgetTransferIdentifier
Type:
object
Title:
Show Source
ProgramBudgetTransferIdentifier
-
programBudgetId: integer
(int64)
The system-generated identifier of a program budget.
-
programBudgetTransferCode: string
Maximum Length:
60
The unique identifier of the program budget transfer request. -
programBudgetTransferId: integer
(int64)
The system-generated identifier of a program budget transfer.
-
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ProgramBudgetChangeIdentifier
Type:
object
Title:
Show Source
ProgramBudgetChangeIdentifier
-
programBudgetChangeCode: string
Maximum Length:
60
The unique identifier of the program budget change request. -
programBudgetChangeId: integer
(int64)
The system-generated identifier of a program budget change.
-
programBudgetId: integer
(int64)
The system-generated identifier of a program budget.
-
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ActivityIdentifier
Type:
object
Title:
Show Source
ActivityIdentifier
-
activityCode: string
Maximum Length:
60
The user-specified identifier of the activity. -
activityId: integer
(int64)
The unique identifier for the activity.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : AssignmentIdentifier
Type:
object
Title:
Show Source
AssignmentIdentifier
-
activityCode: string
Maximum Length:
60
The user-specified identifier of the activity. -
activityId: integer
(int64)
The unique identifier for the activity.The activity object can also be identified by its unique criteria.
-
assignmentCode: string
Maximum Length:
60
A unique identifier for the assignment. -
assignmentId: integer
(int64)
The system-generated identifier of an assignment.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class of the resource of an assignment. -
resourceCode: string
The user-specified identifier of a resource.
-
resourceId: integer
(int64)
The unique identifier for the resource.The resource object can also be identified by its unique criteria.
-
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : RelationshipIdentifier
Type:
object
Title:
Show Source
RelationshipIdentifier
-
predActivityCode: string
The code of the predecessor activity.
-
predActivityId: integer
(int64)
The unique identifier of the predecessor of an activity.
-
predProjectCode: string
The code of the project of the predecessor of an activity.
-
predWorkspaceCode: string
The code of the workspace of the predecessor of an activity.
-
relationshipId: integer
(int64)
The system-generated identifier of an activity relationship.
-
succActivityCode: string
The code of the successor activity.
-
succActivityId: integer
(int64)
The unique identifier of the successor of an activity.
-
succProjectCode: string
The code of the project of the successor of an activity.
-
succWorkspaceCode: string
The code of the workspace of the successor of an activity.
Nested Schema : FundActualIdentifier
Type:
object
Title:
Show Source
FundActualIdentifier
-
fundActualId: integer
(int64)
The system-generated identifier of a fund actual.
-
fundCode: string
The user-specified unique identifier of a fund.
-
fundId: integer
(int64)
The system-generated identifier of a fund.
-
projectActualsCode: string
Maximum Length:
60
The unique identifier for an actual. -
projectActualsId: integer
(int64)
The system-generated identifier of a project actual.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
workspaceCode: string
The user-specified identifier of a workspace.
Nested Schema : ProgramBudgetItemIdentifier
Type:
object
Title:
Show Source
ProgramBudgetItemIdentifier
-
programBudgetId: integer
(int64)
The ID of the program budget.
-
programBudgetItemCode: string
Maximum Length:
60
The unique identifier of the program budget item. -
programBudgetItemId: integer
(int64)
The system-generated identifier for a budget.
-
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : parentCVCodes
Type:
array
List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
Show Source
400 Response
Invalid input for the Assignment service.