Jump to

• Request
• Response

Update ProjectResource

put

/projectResource

Send a request to this endpoint to update one or more ProjectResource. 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 ()

A list of ProjectResource objects.

Root Schema : List<ProjectResource>

Type: array

Title: List<ProjectResource>

Show Source

• Array of: object ProjectResource
  Title: ProjectResource

  ProjectResource Entity

{
    "title":"List<ProjectResource>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProjectResource"
    }
}

Nested Schema : ProjectResource

Type: object

Title: ProjectResource

ProjectResource Entity

Show Source

• CommittedFlag: boolean
  The Boolean value that determines whether a resource is committed, and so, the resource assignment is stable and unlikely to change. When calculating availability, Primavera considers only assignments that are marked as committed.
• CreateDate: string (date-time)
  The date this project resource was created.
• CreateUser: string
  The name of the user that created this project resource.
• FinishDate: string (date-time)
  The finish date of the assignment. By default, it is set to the Planned Start date of the project + 1 day, finishing at 5:00pm. For example, if the planned start date is January 1, 8:00am, the finish date is set to January 2, 5:00pm. If LifeOfProjectFlag is set to true during creation, this date is set to the Project Scheduled Finish date. If associated ProjectResourceQuantities exist, this field is set to the end of the week of the latest ProjectResourceQuantity.
• IsBaseline: boolean
  The boolean value indicating if this business object is related to a Project or Baseline
• IsTemplate: boolean
  The boolean value indicating if this business object is related to a template Project.
• LastUpdateDate: string (date-time)
  The date this project resource was last updated.
• LastUpdateUser: string
  The name of the user that last updated this project resource.
• LifeOfProjectFlag: boolean
  The Boolean value that determines whether a resource that is assigned to a project at Project or WBS level, has that assignment for the duration of the project.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ProjectId: string
  The short code that uniquely identifies the associated project.
• ProjectObjectId(required): integer (int32)
  The unique ID of the associated project.
• ProjectResourceCategoryName: string
  The name of the associated project resource category.
• ProjectResourceCategoryObjectId: integer (int32)
  The unique ID of the associated project resource category.
• ResourceName: string
  The name of the associated resource.
• ResourceObjectId(required): integer (int32)
  The unique ID of the associated resource.
• ResourceRequest: object ResourceRequest
• RoleName: string
  The name of the associated role.
• RoleObjectId(required): integer (int32)
  The unique ID of the associated role.
• StartDate: string (date-time)
  The start date of the assignment. By default, it is set to the Planned Start date of the project. If LifeOfProjectFlag is set to true, this date is set to the Project Planned Start date. If associated ProjectResourceQuantities exist, this field is set to the beginning of the week of the earliest ProjectResourceQuantity.
• Status: string
  The project or WBS status: 'Planned', 'Active', 'Inactive', 'What-If', or 'Requested'.
• WBSCode: string
  The short code assigned to the associated WBS element for identification.
• WBSObjectId(required): integer (int32)
  The unique ID of the associated WBS.

{
    "title":"ProjectResource",
    "required":[
        "ProjectObjectId",
        "ResourceObjectId",
        "RoleObjectId",
        "WBSObjectId"
    ],
    "type":"object",
    "properties":{
        "CommittedFlag":{
            "type":"boolean",
            "description":"The Boolean value that determines whether a resource is committed, and so, the resource assignment is stable and unlikely to change. When calculating availability, Primavera considers only assignments that are marked as committed."
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this project resource was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this project resource."
        },
        "FinishDate":{
            "type":"string",
            "description":"The finish date of the assignment. By default, it is set to the Planned Start date of the project + 1 day, finishing at 5:00pm. For example, if the planned start date is January 1, 8:00am, the finish date is set to January 2, 5:00pm. If LifeOfProjectFlag is set to true during creation, this date is set to the Project Scheduled Finish date. If associated ProjectResourceQuantities exist, this field is set to the end of the week of the latest ProjectResourceQuantity.",
            "format":"date-time"
        },
        "IsBaseline":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a Project or Baseline"
        },
        "IsTemplate":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a template Project."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this project resource was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this project resource."
        },
        "LifeOfProjectFlag":{
            "type":"boolean",
            "description":"The Boolean value that determines whether a resource that is assigned to a project at Project or WBS level, has that assignment for the duration of the project."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ProjectId":{
            "type":"string",
            "description":"The short code that uniquely identifies the associated project."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "ProjectResourceCategoryName":{
            "type":"string",
            "description":"The name of the associated project resource category."
        },
        "ProjectResourceCategoryObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project resource category.",
            "format":"int32"
        },
        "ResourceName":{
            "type":"string",
            "description":"The name of the associated resource."
        },
        "ResourceObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated resource.",
            "format":"int32"
        },
        "RoleName":{
            "type":"string",
            "description":"The name of the associated role."
        },
        "RoleObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated role.",
            "format":"int32"
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the assignment. By default, it is set to the Planned Start date of the project. If LifeOfProjectFlag is set to true, this date is set to the Project Planned Start date. If associated ProjectResourceQuantities exist, this field is set to the beginning of the week of the earliest ProjectResourceQuantity.",
            "format":"date-time"
        },
        "Status":{
            "type":"string",
            "description":"The project or WBS status: 'Planned', 'Active', 'Inactive', 'What-If', or 'Requested'."
        },
        "WBSCode":{
            "type":"string",
            "description":"The short code assigned to the associated WBS element for identification."
        },
        "WBSObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated WBS.",
            "format":"int32"
        },
        "ResourceRequest":{
            "$ref":"#/components/schemas/ResourceRequest"
        }
    },
    "description":"ProjectResource Entity"
}

Nested Schema : ResourceRequest

Type: object

Show Source

• FinishDate: string (date-time)
• MatchAllCriteria: boolean
• Name: string
• RequestedUnits: number (double)
• ResourceRequestCriterion: array ResourceRequestCriterion
• SequenceNumber: integer (int32)
• ShowOnlyLaborResources: boolean
• ShowOverallocatedResources: boolean
• SortResultsByAvailability: boolean
• StartDate: string (date-time)
• UseActivityDates: boolean

{
    "type":"object",
    "properties":{
        "FinishDate":{
            "type":"string",
            "format":"date-time"
        },
        "MatchAllCriteria":{
            "type":"boolean"
        },
        "Name":{
            "type":"string"
        },
        "RequestedUnits":{
            "type":"number",
            "format":"double"
        },
        "SequenceNumber":{
            "type":"integer",
            "format":"int32"
        },
        "ShowOnlyLaborResources":{
            "type":"boolean"
        },
        "ShowOverallocatedResources":{
            "type":"boolean"
        },
        "SortResultsByAvailability":{
            "type":"boolean"
        },
        "StartDate":{
            "type":"string",
            "format":"date-time"
        },
        "UseActivityDates":{
            "type":"boolean"
        },
        "ResourceRequestCriterion":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRequestCriterion"
            }
        }
    }
}

Nested Schema : ResourceRequestCriterion

Type: array

Show Source

• Array of: object ResourceRequestCriterion

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

Nested Schema : ResourceRequestCriterion

Type: object

Show Source

• CriterionType: string
• Proficiency: string
• ValueObjectId: integer (int32)

{
    "type":"object",
    "properties":{
        "CriterionType":{
            "type":"string"
        },
        "Proficiency":{
            "type":"string"
        },
        "ValueObjectId":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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