View Assignments by Code
get
/api/restapi/assignment/code/{assignmentCode}
This endpoint returns assignments that meet the following requirements:
- The object has a code that matches the value of the {assignmentCode} path parameter.
Request
Path Parameters
-
assignmentCode(required): string
The user-specified identifier of an assignment.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
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.
204 Response
Successful operation with no content.
404 Response
The requested assignment does not exist, or you do not have access to it.