Jump to

• Request
• Response

Update ResourceAssignmentSpread

put

/spread/resourceAssignmentSpread

Send a request to this endpoint to update one or more ResourceAssignmentSpread. An application object will be created for each JSON object provided in the request body

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

ResourceAssignmentSpread object.

Root Schema : UpdateResourceAssignmentSpread

Type: object

Title: UpdateResourceAssignmentSpread

UpdateResourceAssignmentSpread Entity

Show Source

• PeriodType: string
  Spread period type enumerations are used to specify the spread interval for EPS, project, WBS, Activity, and resource assignment spreads.
• ResourceAssignmentSpread: array ResourceAssignmentSpread
  The live resource assignment spread data.

{
    "title":"UpdateResourceAssignmentSpread",
    "type":"object",
    "properties":{
        "PeriodType":{
            "type":"string",
            "description":"Spread period type enumerations are used to specify the spread interval for EPS, project, WBS, Activity, and resource assignment spreads."
        },
        "ResourceAssignmentSpread":{
            "type":"array",
            "description":"The live resource assignment spread data.",
            "items":{
                "$ref":"#/components/schemas/ResourceAssignmentSpread"
            }
        }
    },
    "description":"UpdateResourceAssignmentSpread Entity"
}

Nested Schema : ResourceAssignmentSpread

Type: array

The live resource assignment spread data.

Show Source

• Array of: object ResourceAssignmentSpread
  The live resource assignment spread data.

{
    "type":"array",
    "description":"The live resource assignment spread data.",
    "items":{
        "$ref":"#/components/schemas/ResourceAssignmentSpread"
    }
}

Nested Schema : ResourceAssignmentSpread

Type: object

The live resource assignment spread data.

Show Source

• Period: array Period
• ResourceAssignmentObjectId: string
  The unique ID of the associated resource assignment.

{
    "type":"object",
    "properties":{
        "ResourceAssignmentObjectId":{
            "type":"string",
            "description":"The unique ID of the associated resource assignment."
        },
        "Period":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Period"
            }
        }
    },
    "description":"The live resource assignment spread data."
}

Nested Schema : Period

Type: array

Show Source

• Array of: object Period

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Period"
    }
}

Nested Schema : Period

Type: object

Show Source

• PlannedUnits: number (double)
  The planned units of work for the resource assignment on the activity. This field is named BudgetedUnits in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.
• RemainingUnits: number (double)
  The remaining units of work to be performed by this resource on this activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.
• StartDate: string (date-time)
  The start of the time period that you are interested in.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string",
            "description":"The start of the time period that you are interested in.",
            "format":"date-time"
        },
        "PlannedUnits":{
            "type":"number",
            "description":"The planned units of work for the resource assignment on the activity. This field is named BudgetedUnits in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.",
            "format":"double"
        },
        "RemainingUnits":{
            "type":"number",
            "description":"The remaining units of work to be performed by this resource on this activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.",
            "format":"double"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : schema

Type: boolean

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top