Jump to

• Request
• Response

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

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityAssignmentInput>

Type: array

Title: List<ApiEntityAssignmentInput>

Show Source

• Array of: object 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

{
    "title":"List<ApiEntityAssignmentInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignmentInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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

• 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.
• 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: number (double)
  The actual cost of an activity resource assignment during this period.
• actualUnits: number (double)
  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.
• atCompletionUnits: number (double)
  The sum of the actual units and remaining units for the resource assignment on the activity.
  Calculated as Actual Units plus Remaining Units.
• calculateCostFromUnitsFlag: boolean
  Indicates whether to calculate costs based on units for an 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.
• finishDate: string (date-time)
  The finish date for the assignment.
• 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: number (double)
  The planned units of work for the resource assignment on the activity.
• plannedUnitsPerHour: number (double)
  The planned units per time at which the resource is to perform work on the activity.
• 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.
• 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: number (double)
  The remaining units of work to be performed by the resource on the activity.
• remainingUnitsPerHour: number (double)
  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.
• resourceRoleId: integer (int64)
  The identifier for the role assigned to the resource.
• schedulePercentComplete: number (double)
  The assignment schedule percent complete, which specifies how much of the assignment's project baseline duration is complete so far.
  
• 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.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The workspace code of an assignment.

{
    "title":"ApiEntityAssignmentInput",
    "required":[
        "activityId",
        "resourceId"
    ],
    "type":"object",
    "properties":{
        "calculateCostFromUnitsFlag":{
            "type":"boolean",
            "description":"Indicates whether to calculate costs based on units for an assignment.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "resourceCurve":{
            "description":"The resource's units and costs distributed over the duration of an activity.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityCurveInput"
                }
            ]
        },
        "assignmentFinancial":{
            "description":"List all assignment cost field spread data assigned to the assignment.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityAssignmentFinancialInput"
                }
            ]
        },
        "remainingFinish":{
            "type":"string",
            "description":"The date the assignment is scheduled to be finished.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingStart":{
            "type":"string",
            "description":"The date the assignment is scheduled to begin.",
            "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"
            ]
        },
        "curveId":{
            "type":"integer",
            "description":"The resource's units and costs distributed over the duration of an activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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
        },
        "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
        },
        "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
        },
        "plannedUnitsPerHour":{
            "type":"number",
            "description":"The planned units per time at which the resource is to perform work on the activity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "driveActivityDates":{
            "type":"boolean",
            "description":"Determines whether new resource or role assignments determine activity dates.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "actualUnits":{
            "type":"number",
            "description":"The sum of the actual non-overtime and the overtime units worked by the resource on the activity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedUnits":{
            "type":"number",
            "description":"The planned units of work for the resource assignment on the activity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "assignmentCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"A unique identifier for the assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "atCompletionUnits":{
            "type":"number",
            "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":"double",
            "exampleSetFlag":false
        },
        "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
        },
        "remainingUnitsPerHour":{
            "type":"number",
            "description":"The units per time required for the resource assignment to complete the activity.",
            "format":"double",
            "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"
            ]
        },
        "assignmentId":{
            "type":"integer",
            "description":"The system-generated identifier of an assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "actualThisPeriodUnits":{
            "type":"number",
            "description":"The actual cost of an activity resource assignment during this period.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingUnits":{
            "type":"number",
            "description":"The remaining units of work to be performed by the resource on the activity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "totalRemainingLag":{
            "type":"number",
            "description":"The sum of expired lag and remaining lag for the activity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "actualStart":{
            "type":"string",
            "description":"If the activity has started, the date work began on the activity.",
            "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"
            ]
        },
        "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"
            ]
        },
        "resourceCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified identifier of a resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceRoleId":{
            "type":"integer",
            "description":"The identifier for the role assigned to the resource.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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
        },
        "activityCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The activity code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for an assignment.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignmentConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The workspace code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The project code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a Assignment object, a unique Assignment object can be identified by the following combinations of the fields.<ul><li>assignmentId</li><li>activityId,resourceId,assignmentCode</li><li>activityCode,projectCode,workspaceCode,resourceId,assignmentCode</li><li>activityId,workspaceCode,resourceCode,resourceClass,assignmentCode</li><li>activityCode,projectCode,workspaceCode,resourceCode,resourceClass,assignmentCode</li>",
    "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 ApiEntityAssignmentFinancialInput
  Title: ApiEntityAssignmentFinancialInput

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

Nested Schema : configuredFields

Type: array

The list of configured fields for an assignment.

Show Source

• Array of: object 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

{
    "type":"array",
    "description":"The list of configured fields for an assignment.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignmentConfiguredFieldValueInput",
        "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 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

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

Nested Schema : ApiEntityAssignmentFinancialInput

Type: object

Title: ApiEntityAssignmentFinancialInput

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

{
    "title":"ApiEntityAssignmentFinancialInput",
    "type":"object",
    "properties":{
        "resource":{
            "type":"integer",
            "description":"The system-generated identifier of a resource.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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
        },
        "activity":{
            "type":"integer",
            "description":"The system-generated identifier of an activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "project":{
            "type":"integer",
            "description":"The system-generated identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "assignmentId":{
            "type":"integer",
            "description":"The unique identifier for the assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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
        },
        "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
        },
        "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
        }
    },
    "exampleSetFlag":false
}

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

• 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.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• 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.

{
    "title":"ApiEntityAssignmentConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "assignmentConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Assignment Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignmentId":{
            "type":"integer",
            "description":"The system-generated identifier of an assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "columnLabel":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "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"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        }
    },
    "description":"This entity represents a AssignmentConfiguredFieldValue object, a unique AssignmentConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>assignmentConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

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

• buckets: array buckets
  The buckets of a cost curve.
• curveId: integer (int64)
  The unique identifier of a curve.
• curveName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the curve profile.
• 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.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityCurveInput",
    "required":[
        "curveName",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "curveId":{
            "type":"integer",
            "description":"The unique identifier of a curve.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "buckets":{
            "type":"array",
            "description":"The buckets of a cost curve.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCurveBucketInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "curveName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the curve profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "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"
            ]
        }
    },
    "description":"This entity represents a Curve object, a unique Curve object can be identified by the following combinations of the fields.<ul><li>curveId</li><li>curveName,workspaceId</li><li>curveName,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : buckets

Type: array

The buckets of a cost curve.

Show Source

• Array of: object ApiEntityCurveBucketInput
  Title: ApiEntityCurveBucketInput

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

Nested Schema : ApiEntityCurveBucketInput

Type: object

Title: ApiEntityCurveBucketInput

Show Source

• bucketLevel(required): 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.
• value: number
  Numeric value of a bucket curve. Curve bucket values determine the shape of curves.

{
    "title":"ApiEntityCurveBucketInput",
    "required":[
        "bucketLevel"
    ],
    "type":"object",
    "properties":{
        "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Assignments Using Assignment Codes Batch Update Assignments to Assign Configured Field

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