View an Assignment

get

/primeapi/restapi/assignment/{id}

This endpoint returns assignments that meet the following requirements:
  • The object has an ID that matches the value of the {id} path parameter.
Assignments represent the allocation of project or workspace resources to project activities.

Request

Path Parameters

Response

Supported Media Types

200 Response

successful operation
Body ()
Root Schema : ApiEntityAssignment
Type: object
Show Source
Nested Schema : Duration
Type: object
Show Source
Nested Schema : Unit
Type: object
Nested Schema : ApiEntityAssignmentConfiguredFields
Type: object
Show Source
Nested Schema : ApiEntityAssignmentFinancial
Type: object
Show Source
Nested Schema : Percent
Type: object
Show Source
Nested Schema : ApiEntityCurve
Type: object
Show Source
Nested Schema : spreads
Type: array
Unique Items Required: true
The Assignment spread control objects associated with the specified assignment object.
Show Source
Nested Schema : costFlexMap
Type: object
Additional Properties Allowed
Show Source
The cost fields associated with an asssignment.
Nested Schema : otherFlexMap
Type: object
Additional Properties Allowed
Show Source
The cost fields associated with an asssignment.
Nested Schema : textFlexMap
Type: object
Additional Properties Allowed
Show Source
The cost fields associated with an asssignment.
Nested Schema : additionalProperties
Type: object
Nested Schema : additionalProperties
Type: object
Nested Schema : additionalProperties
Type: object
Nested Schema : Cost
Type: object
Nested Schema : buckets
Type: array
Unique Items Required: true
The buckets of a cost curve.
Show Source
Nested Schema : ApiEntityCurveBucket
Type: object
Show Source
Nested Schema : ApiEntityResourceAssignmentSpreadControlObject
Type: object
Show Source
Nested Schema : spreadRows
Type: array
Unique Items Required: true
Spread Rows of the assignment.
Show Source
Nested Schema : ApiEntityResourceAssignmentSpreadRow
Type: object
Show Source
Nested Schema : actualOverTimeUnitsHourlySpread
Type: array
The hourly actual overtime units worked by the resource on the activity.
Show Source
Nested Schema : actualRegularUnitsHourlySpread
Type: array
The hourly actual non-overtime units worked by the resource on the activity.
Show Source
Nested Schema : actualUnitsHourlySpread
Type: array
The hourly actual units worked by the resource on the activity.
Show Source
Nested Schema : atCompletionUnitsHourlySpread
Type: array
The hourly sum of actual units and remaining units for the activity resource assignment.
Show Source
Nested Schema : plannedUnitsHourlySpread
Type: array
The hourly expected number of units required to complete the activity.
Show Source
Nested Schema : remainingLateUnitsHourlySpread
Type: array
The hourly number of units remaining to be worked on for the assignment distributed over the late start and finish dates.
Show Source
Nested Schema : remainingUnitsHourlySpread
Type: array
The number of units remaining to be worked on for the assignment distributed over the late start and finish dates.
Show Source
Nested Schema : staffedRemainingUnitsHourlySpread
Type: array
The hourly remaining units that have filled a role for the activity resource assignment.
Show Source
Nested Schema : unstaffedRemainingUnitsHourlySpread
Type: array
The hourly remaining units that have not filled a role for the activity resource assignment.
Show Source

404 Response

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