Batch Update Assignments

put

/api/restapi/assignment/batch

Send a request to this endpoint to update one or more assignments. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : List<ApiEntityAssignmentInput>
Type: array
Title: List<ApiEntityAssignmentInput>
Show Source
  • ApiEntityAssignmentInput
    Title: ApiEntityAssignmentInput
    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 : ApiEntityAssignmentInput
Type: object
Title: ApiEntityAssignmentInput
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
Show Source
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
Nested Schema : assignmentManualCurve
Read Only: true
Deprecated. As of 25.1.
List the manual curve for planned and remaining units on the assignment.
Match All
Deprecated. As of 25.1.
List the manual curve for planned and remaining units on the assignment.
Show Source
Nested Schema : configuredFields
Type: array
The list of configured fields for an assignment.
Show Source
  • ApiEntityAssignmentConfiguredFieldValueInput
    Title: ApiEntityAssignmentConfiguredFieldValueInput
    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
The resource's units and costs distributed over the duration of an activity.
Show Source
  • ApiEntityCurveInput
    Title: ApiEntityCurveInput
    This entity represents a Curve object, a unique Curve object can be identified by the following combinations of the fields.
    • curveId
    • curveName,workspaceId
    • curveName,workspaceCode
Nested Schema : ApiEntityAssignmentFinancialInput
Type: object
Title: ApiEntityAssignmentFinancialInput
Show Source
  • The system-generated identifier of an activity.
  • 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.
  • The actual cost for the resource assignment on the activity. This value is based on the project currency.
  • 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.
  • The labor, nonlabor, and material costs incurred during the current financial period. This value is based on the project currency.
  • Read Only: true
    Deprecated. As of 25.1, replaced by 'ApiEntityAssignmentFinancialInput.assignmentId'.
    The unique identifier for the assignment.
  • The unique identifier for the assignment.
  • 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.
  • The sum of the actual costs plus remaining costs for the resource assignment on the activity. This value is based on the project currency.
  • Read Only: true
    Deprecated. As of 25.1.
    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.
  • Read Only: true
    Deprecated. As of 25.1.
    The approved budget for work actually completed by the specified project data date. This value is based on the project currency.
  • 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.
  • The expected total cost of the item, such as an assignment, expense, or response plan. This value is based on the project currency.
  • Read Only: true
    Deprecated. As of 25.1.
    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.
  • Read Only: true
    Deprecated. As of 25.1.
    The amount of approved capital spent on a scheduled portion of work on a project. This value is based on the project currency.
  • 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.
  • Minimum Value: 0
    The price per unit of time for the resource or role. This value is based on the project currency.
  • Read Only: true
    Deprecated. As of 25.1.
    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.
  • Read Only: true
    Deprecated. As of 25.1.
    The total actual costs incurred at the time of the last stored period performance. This value is based on the project currency.
  • The system-generated identifier of a project.
  • 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.
  • The remaining cost for the resource assignment on the activity. This value is based on the project currency.
  • The system-generated identifier of a resource.
  • Read Only: true
    Deprecated. As of 25.1.
    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.
  • Read Only: true
    Deprecated. As of 25.1.
    The remaining cost for resource assignments that have a filled role. This value is based on the project currency.
  • Read Only: true
    Deprecated. As of 25.1.
    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.
  • Read Only: true
    Deprecated. As of 25.1.
    The remaining cost for resource assignments that do not have a filled role. This value is based on the project currency.
  • Read Only: true
    Deprecated. As of 25.1.
    Date when the record was last updated.
Nested Schema : ApiEntityAssignmentManualCurveInput
Type: object
Title: ApiEntityAssignmentManualCurveInput
Read Only: true
Show Source
  • Read Only: true
    Deprecated. As of 25.1.
    The unique identifier for the assignment.
  • Read Only: true
    Minimum Length: 0
    Maximum Length: 4000
    Deprecated. As of 25.1.
    The manual curve for planned units on the assignment.
  • Read Only: true
    Minimum Length: 0
    Maximum Length: 4000
    Deprecated. As of 25.1.
    The manual curve for remaining units on the assignment.
  • Read Only: true
    Deprecated. As of 25.1.
    Date when the record was last updated.
Nested Schema : ApiEntityAssignmentConfiguredFieldValueInput
Type: object
Title: ApiEntityAssignmentConfiguredFieldValueInput
This entity represents a AssignmentConfiguredFieldValue object, a unique AssignmentConfiguredFieldValue object can be identified by the following combinations of the fields.
  • assignmentConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel
Show Source
  • Allowed Values: [ "DELETE" ]
    Provide value for this field during object update to delete the assigned configured field value.
  • The unique identifier for the Assignment Configured Field.
  • The system-generated identifier of an assignment.
  • Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
  • Minimum Length: 1
    Maximum Length: 100
    The user-specified UDF column label.
  • Minimum Length: 1
    Maximum Length: 100
    The user-specified UDF column name.
  • Read Only: true
    Deprecated. As of 25.1.
    This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
  • Read Only: true
    Deprecated. As of 25.1.
    This holds values for Cost type configured fields in the workspace1 currency conversion.
  • Read Only: true
    Deprecated. As of 25.1.
    This holds values for Cost type configured fields in the workspace2 currency conversion.
  • Read Only: true
    Deprecated. As of 25.1.
    This holds values for Cost type configured fields in the workspace3 currency conversion.
  • This holds values for Date type configured fields.
  • Read Only: true
    Maximum Length: 4000
    Deprecated. As of 25.1.
    Provides the error message for why the formula calculation resulted in an error.
  • Read Only: true
    Deprecated. As of 25.1.
    Determines if formula calculation hit an error calculating a value for this field.
  • 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.
  • Maximum Length: 4000
    This holds values for Boolean, List and Text type configured fields.
  • Read Only: true
    Deprecated. As of 25.1.
    Date when the record was last updated.
Nested Schema : ApiEntityCurveInput
Type: object
Title: ApiEntityCurveInput
This entity represents a Curve object, a unique Curve object can be identified by the following combinations of the fields.
  • curveId
  • curveName,workspaceId
  • curveName,workspaceCode
Show Source
  • Read Only: true
    Allowed Values: [ "OWNED", "INHERITED" ]
    Deprecated. As of 24.5.
    The type of association in the relationship between the curve and the workspace. Possible values are Owned and Inherited.
  • buckets
    The buckets of a cost curve.
  • The unique identifier of a curve.
  • Minimum Length: 1
    Maximum Length: 255
    The name of the curve profile.
  • 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.
  • Read Only: true
    Deprecated. As of 24.5.
    Date when the record was last updated.
  • Minimum Length: 0
    Maximum Length: 60
    The user-specified identifier of a workspace.
  • 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
Nested Schema : ApiEntityCurveBucketInput
Type: object
Title: ApiEntityCurveBucketInput
Show Source
Examples

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"},"warnings":[{"primaryKeyName":"objectIdFieldName","uniqueFieldName":"object_code_01","uniqueFieldValue":"objectCodeFieldName","primaryKeyValue":1,"warningMessages":["warning_message_1","warning_message_2"]}]}

400 Response

Invalid input for the Assignment service.
Back to Top