Jump to

• Request
• Response

View an Assignment

get

/api/restapi/assignment/{assignmentId}

This endpoint returns assignments that meet the following requirements:

• The object is associated with an assignment with an ID value that matches the value of the {assignmentId} path parameter.

Assignments represent the allocation of project or workspace resources to project activities.

Request

Path Parameters

• assignmentId(required): integer(int64)
  The system-generated identifier of an assignment.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityAssignment

Type: object

Title: ApiEntityAssignment

Show Source

• activityCode: string
  Minimum Length: 0

  Maximum Length: 60

  The activity code of an assignment.
• activityId: integer (int64)
  The unique identifier for the activity.The activity object can also be identified by its unique criteria.
• actualDuration: number (double)
  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.
• actualUnitsCurve: string
  The manual curve for actual units on the assignment.
• 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.
• assignmentManualCurve: assignmentManualCurve
  List the manual curve for planned and remaining units on the assignment.
• atCompletionDuration: number (double)
  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)
  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)
  The portion of baseline labor units that are complete as of the project data date.
• estimateAtCompletionUnits: integer (int64)
  The estimated units at completion of the assignment.
  
• estimateToCompletionUnits: integer (int64)
  The estimated quantity to complete the assignment.
  
• finishDate: string (date-time)
  The finish date for the assignment.
• link: string (url)
  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)
  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)
  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: 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
  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)
  The number of staff units remaining for one or more resource assignments.
• starred: boolean
  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)
  The number of unstaffed units remaining for one or more resource assignments.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The workspace code of an assignment.

{
    "title":"ApiEntityAssignment",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "baselineUnits":{
            "type":"integer",
            "description":"The number of baseline units for the activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "rateType":{
            "type":"string",
            "description":"The type of rate that defines the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CUSTOM",
                "PRICE_PER_UNIT_1",
                "PRICE_PER_UNIT_2",
                "PRICE_PER_UNIT_3",
                "PRICE_PER_UNIT_4",
                "PRICE_PER_UNIT_5"
            ]
        },
        "remainingLag":{
            "type":"number",
            "description":"The time lag between the activity's remaining start date and the resource's remaining start date on the activity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignmentCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"A unique identifier for the assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proficiency":{
            "type":"string",
            "description":"The skill level of the resource an activity is assigned to. The valid values are Master, Expert, Skilled, Proficient, and Inexperienced.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ONE",
                "TWO",
                "THREE",
                "FOUR",
                "FIVE"
            ]
        },
        "curveId":{
            "type":"integer",
            "description":"The resource's units and costs distributed over the duration of an activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceType":{
            "type":"string",
            "description":"The resource type. Valid values are Labor, Nonlabor, and Material.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "LABOR",
                "NONLABOR",
                "MATERIAL"
            ]
        },
        "remainingUnits":{
            "type":"integer",
            "description":"The remaining units of work to be performed by the resource on the activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "resourceCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified identifier of a resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "assignmentId":{
            "type":"integer",
            "description":"The system-generated identifier of an assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "plannedLag":{
            "type":"number",
            "description":"The planned time lag between the activity's planned start date and the resource's planned start date on the activity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualUnits":{
            "type":"integer",
            "description":"The sum of the actual non-overtime and the overtime units worked by the resource on the activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "plannedUnits":{
            "type":"integer",
            "description":"The planned units of work for the resource assignment on the activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "resourceRoleId":{
            "type":"integer",
            "description":"The identifier for the role assigned to the resource.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "atCompletionDuration":{
            "type":"number",
            "description":"The total working time from the assignment's current start date to the current finish date.",
            "format":"double",
            "exampleSetFlag":false
        },
        "schedulePercentComplete":{
            "type":"number",
            "description":"The assignment schedule percent complete, which specifies how much of the assignment's project baseline duration is complete so far. <br />",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitsPercentComplete":{
            "type":"number",
            "description":"The percent complete of units for the resource assignment on the activity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingDuration":{
            "type":"number",
            "description":"The remaining working time for the resource assignment on the activity, from the resource's remaining start date to the remaining finish date.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingStart":{
            "type":"string",
            "description":"The date the assignment is scheduled to begin.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingFinish":{
            "type":"string",
            "description":"The date the assignment is scheduled to be finished.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "assignmentFinancial":{
            "description":"List all assignment cost field spread data assigned to the assignment.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityAssignmentFinancial"
                }
            ]
        },
        "assignmentManualCurve":{
            "description":"List the manual curve for planned and remaining units on the assignment.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityAssignmentManualCurve"
                }
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for an assignment.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignmentConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The workspace code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityId":{
            "type":"integer",
            "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activityCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The activity code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The project code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "actualDuration":{
            "type":"number",
            "description":"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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "calendarId":{
            "type":"integer",
            "description":"The calendar used to record and track the assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The start date for the activity assignment.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finishDate":{
            "type":"string",
            "description":"The finish date for the assignment.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedDuration":{
            "type":"number",
            "description":"The resource's total working time on the activity from the Planned Start date to the Planned Finish date.",
            "format":"double",
            "exampleSetFlag":false
        },
        "starred":{
            "type":"boolean",
            "description":"Specifies whether the assignment has been marked as important.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class of the resource of an assignment. ",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "curveName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the curve profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedStart":{
            "type":"string",
            "description":"The planned start date for the assignment on the activity.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualStart":{
            "type":"string",
            "description":"If the activity has started, the date work began on the activity.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedFinish":{
            "type":"string",
            "description":"The date the assignment is scheduled to be finished. It is calculated by the scheduler and will not change once the activity has started.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualFinish":{
            "type":"string",
            "description":"The date on which the assignment was completed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingLateStart":{
            "type":"string",
            "description":"The latest possible date the assignment must begin to not delay the project finish date.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingLateFinish":{
            "type":"string",
            "description":"The latest possible date the assignment must be finished to not delay the project finish date.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedValueUnits":{
            "type":"integer",
            "description":"The product of the budget at completion and the schedule percent complete.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "estimateAtCompletionUnits":{
            "type":"integer",
            "description":"The estimated units at completion of the assignment. <br />",
            "format":"int64",
            "exampleSetFlag":false
        },
        "estimateToCompletionUnits":{
            "type":"integer",
            "description":"The estimated quantity to complete the assignment. <br />",
            "format":"int64",
            "exampleSetFlag":false
        },
        "remainingUnitsPerHour":{
            "type":"integer",
            "description":"The units per time required for the resource assignment to complete the activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "actualThisPeriodUnits":{
            "type":"integer",
            "description":"The actual cost of an activity resource assignment during this period.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "totalRemainingLag":{
            "type":"number",
            "description":"The sum of expired lag and remaining lag for the activity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedUnitsPerHour":{
            "type":"integer",
            "description":"The planned units per time at which the resource is to perform work on the activity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "pricePerUnitSourceType":{
            "type":"string",
            "description":"The value that indicates which Price/Unit will be used to calculate costs for the assignment. Valid options are Resource, Role, or Override.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE",
                "OVERRIDE"
            ]
        },
        "earnedValueUnits":{
            "type":"integer",
            "description":"The portion of baseline labor units that are complete as of the project data date.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "staffedRemainingUnits":{
            "type":"integer",
            "description":"The number of staff units remaining for one or more resource assignments.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "resourceRoleCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified identifier of a contract.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "unstaffedRemainingUnits":{
            "type":"integer",
            "description":"The number of unstaffed units remaining for one or more resource assignments.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "driveActivityDates":{
            "type":"boolean",
            "description":"Determines whether new resource or role assignments determine activity dates.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "atCompletionUnits":{
            "type":"integer",
            "description":"The sum of the actual units and remaining units for the resource assignment on the activity. <br />Calculated as Actual Units plus Remaining Units.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "priorActualUnits":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "calculateCostFromUnitsFlag":{
            "type":"boolean",
            "description":"Indicates whether to calculate costs based on units for an assignment.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "actualUnitsCurve":{
            "type":"string",
            "description":"The manual curve for actual units on the assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceCurve":{
            "description":"The resource's units and costs distributed over the duration of an activity.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityCurve"
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : assignmentFinancial

List all assignment cost field spread data assigned to the assignment.

Match All

List all assignment cost field spread data assigned to the assignment.

Show Source

• object ApiEntityAssignmentFinancial
  Title: ApiEntityAssignmentFinancial

{
    "description":"List all assignment cost field spread data assigned to the assignment.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityAssignmentFinancial"
        }
    ]
}

Nested Schema : assignmentManualCurve

List the manual curve for planned and remaining units on the assignment.

Match All

List the manual curve for planned and remaining units on the assignment.

Show Source

• object ApiEntityAssignmentManualCurve
  Title: ApiEntityAssignmentManualCurve

{
    "description":"List the manual curve for planned and remaining units on the assignment.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityAssignmentManualCurve"
        }
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for an assignment.

Show Source

• Array of: object ApiEntityAssignmentConfiguredFieldValue
  Title: ApiEntityAssignmentConfiguredFieldValue

{
    "type":"array",
    "description":"The list of configured fields for an assignment.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignmentConfiguredFieldValue",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : resourceCurve

The resource's units and costs distributed over the duration of an activity.

Match All

The resource's units and costs distributed over the duration of an activity.

Show Source

• object ApiEntityCurve
  Title: ApiEntityCurve

{
    "description":"The resource's units and costs distributed over the duration of an activity.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityCurve"
        }
    ]
}

Nested Schema : ApiEntityAssignmentFinancial

Type: object

Title: ApiEntityAssignmentFinancial

Show Source

• 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)
  Deprecated. As of 25.1, replaced by 'ApiEntityAssignmentFinancial.assignmentId'.
  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)
  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)
  The approved budget for work actually completed by the specified project data date. This value is based on the project currency.
• link: string (url)
  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)
  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)
  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)
  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)
  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)
  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)
  The remaining cost for resource assignments that have a filled role. This value is based on the project currency.
• unstaffedRemainingCost: number (double)
  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)
  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)
  Date when the record was last updated.

{
    "title":"ApiEntityAssignmentFinancial",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resource":{
            "type":"integer",
            "description":"The system-generated identifier of a resource.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "project":{
            "type":"integer",
            "description":"The system-generated identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "earnedValueCostProject":{
            "type":"number",
            "description":"The approved budget for work actually completed by the specified project data date. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedValueCostProject":{
            "type":"number",
            "description":"The amount of approved capital spent on a scheduled portion of work on a project. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "activity":{
            "type":"integer",
            "description":"The system-generated identifier of an activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignmentId":{
            "type":"integer",
            "description":"The unique identifier for the assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "plannedValueCost":{
            "type":"number",
            "description":"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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "assignment":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>25.1</i>,  replaced by <i>'ApiEntityAssignmentFinancial.assignmentId'</i>.</br>The unique identifier for the assignment.",
            "format":"int64",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "earnedValueCost":{
            "type":"number",
            "description":"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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedCost":{
            "type":"number",
            "description":"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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pricePerUnit":{
            "minimum":0,
            "type":"number",
            "description":"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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingCost":{
            "type":"number",
            "description":"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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCost":{
            "type":"number",
            "description":"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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "priorActualCost":{
            "type":"number",
            "description":"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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unstaffedRemainingCost":{
            "type":"number",
            "description":"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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostProject":{
            "type":"number",
            "description":"The actual cost for the resource assignment on the activity. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionCost":{
            "type":"number",
            "description":"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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "staffedRemainingCostProject":{
            "type":"number",
            "description":"The remaining cost for resource assignments that have a filled role. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionCostProject":{
            "type":"number",
            "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualThisPeriodCost":{
            "type":"number",
            "description":"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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "staffedRemainingCost":{
            "type":"number",
            "description":"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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualThisPeriodCostProject":{
            "type":"number",
            "description":"The labor, nonlabor, and material costs incurred during the current financial period. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pricePerUnitProject":{
            "minimum":0,
            "type":"number",
            "description":"The price per unit of time for the resource or role. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "priorActualCostProject":{
            "type":"number",
            "description":"The total actual costs incurred at the time of the last stored period performance. This value is based on the project currency. ",
            "format":"double",
            "exampleSetFlag":false
        },
        "unstaffedRemainingCostProject":{
            "type":"number",
            "description":"The remaining cost for resource assignments that do not have a filled role. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingCostProject":{
            "type":"number",
            "description":"The remaining cost for the resource assignment on the activity. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedCostProject":{
            "type":"number",
            "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignmentManualCurve

Type: object

Title: ApiEntityAssignmentManualCurve

Show Source

• assignment: integer (int64)
  Deprecated. As of 25.1, replaced by 'ApiEntityAssignmentManualCurve.assignmentId'.
  The unique identifier for the assignment.
• assignmentId: integer (int64)
  The unique identifier for the assignment.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• plannedUnitsCurve: string
  Minimum Length: 0

  Maximum Length: 4000

  The manual curve for planned units on the assignment.
• remainingUnitsCurve: string
  Minimum Length: 0

  Maximum Length: 4000

  The manual curve for remaining units on the assignment.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityAssignmentManualCurve",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "assignmentId":{
            "type":"integer",
            "description":"The unique identifier for the assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignment":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>25.1</i>,  replaced by <i>'ApiEntityAssignmentManualCurve.assignmentId'</i>.</br>The unique identifier for the assignment.",
            "format":"int64",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "remainingUnitsCurve":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"The manual curve for remaining units on the assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedUnitsCurve":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"The manual curve for planned units on the assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignmentConfiguredFieldValue

Type: object

Title: ApiEntityAssignmentConfiguredFieldValue

Show Source

• 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
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• costValue: number
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Maximum Length: 4000

  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityAssignmentConfiguredFieldValue",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "assignmentId":{
            "type":"integer",
            "description":"The system-generated identifier of an assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignmentConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Assignment Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnLabel":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "textValue":{
            "maxLength":4000,
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "exceptionMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityCurve

Type: object

Title: ApiEntityCurve

Show Source

• 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.

{
    "title":"ApiEntityCurve",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "curveId":{
            "type":"integer",
            "description":"The unique identifier of a curve.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "curveName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the curve profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"It describes how data is shared between parent and child workspaces. <br />Manual: Data can be pulled down by child workspaces. This is the default option. <br />Automatic: Data is automatically shared with all child workspaces.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the curve and the workspace. Possible values are Owned and Inherited.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "buckets":{
            "type":"array",
            "description":"The buckets of a cost curve.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCurveBucket",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : buckets

Type: array

The buckets of a cost curve.

Show Source

• Array of: object ApiEntityCurveBucket
  Title: ApiEntityCurveBucket

{
    "type":"array",
    "description":"The buckets of a cost curve.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCurveBucket",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCurveBucket

Type: object

Title: ApiEntityCurveBucket

Show Source

• 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.

{
    "title":"ApiEntityCurveBucket",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "value":{
            "type":"number",
            "description":"Numeric value of a bucket curve. Curve bucket values determine the shape of curves.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "curveId":{
            "type":"integer",
            "description":"The unique identifier of a curve.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "curveBucketId":{
            "type":"integer",
            "description":"The unique identifier of a curve bucket.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "bucketLevel":{
            "type":"integer",
            "description":"The level of a curve bucket.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

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

Back to Top