Jump to

• Request
• Response

Create ProjectResourceQuantity

post

/projectResourceQuantity

Send a request to this endpoint to create one or more ProjectResourceQuantity. 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 projectresourcequantity objects.

Root Schema : List<ProjectResourceQuantity>

Type: array

Title: List<ProjectResourceQuantity>

Show Source

• Array of: object ProjectResourceQuantity
  Title: ProjectResourceQuantity

  ProjectResourceQuantity Entity

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

Nested Schema : ProjectResourceQuantity

Type: object

Title: ProjectResourceQuantity

ProjectResourceQuantity 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 quantity was created.
• CreateUser: string
  The name of the user that created this project resource quantity.
• FinancialPeriod1ObjectId: integer (int32)
  The unique ID of the associated first financial period for this project resource quantity.
• FinancialPeriod1Quantity(required): number (double)
  The value that represents the resource allocation hours for the first financial period for this project resource quantity. If the week contains days from two different months, two ProjectResourceQuantity business objects will exist. The first business object's Quantity field represents the hours of the first week fragment (WeekStartDate and MonthStartDate have the same month value). The second business object's Quantity field represents the second week fragment (WeekStartDate and MonthStartDate have different month values).
• FinancialPeriod2ObjectId: integer (int32)
  The unique ID of the associated second financial period for this project resource quantity.
• FinancialPeriod2Quantity(required): number (double)
  The value that represents the resource allocation hours for the second financial period for this project resource quantity. If the week contains days from two different months, two ProjectResourceQuantity business objects will exist. The first business object's Quantity field represents the hours of the first week fragment (WeekStartDate and MonthStartDate have the same month value). The second business object's Quantity field represents the second week fragment (WeekStartDate and MonthStartDate have different month values).
• FinancialPeriodTmplId: integer (int32)
• 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 quantity was last updated.
• LastUpdateUser: string
  The name of the user that last updated this project resource quantity.
• MonthStartDate: string (date-time)
  The date value that represents the first day of the month. If the week contains days from two different months, two objects will exist. The first ProjectResourceQuantity object's MonthStartDate is the first day of the month for the first week fragment. The second ProjectResourceQuantity object's MonthStartDate is the first day of the month for the second week fragment.
• ProjectObjectId: integer (int32)
  The unique ID of the associated project.
• ProjectResourceObjectId(required): integer (int32)
  The unique ID of the associated project resource.
• Quantity(required): number (double)
  The value that represents the resource allocation hours per week for this project resource quantity. If the week contains days from two different months, two ProjectResourceQuantity business objects will exist. The first business object's Quantity field represents the hours of the first week fragment (WeekStartDate and MonthStartDate have the same month value). The second business object's Quantity field represents the second week fragment (WeekStartDate and MonthStartDate have different month values).
• ResourceObjectId: integer (int32)
  The unique ID of the associated resource.
• RoleObjectId: integer (int32)
  The unique ID of the associated role.
• WBSObjectId: integer (int32)
  The unique ID of the associated WBS.
• WeekStartDate(required): string (date-time)
  The date value that represents the first day of the week.

{
    "title":"ProjectResourceQuantity",
    "required":[
        "FinancialPeriod1Quantity",
        "FinancialPeriod2Quantity",
        "ProjectResourceObjectId",
        "Quantity",
        "WeekStartDate"
    ],
    "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 quantity was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this project resource quantity."
        },
        "FinancialPeriod1ObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated first financial period for this project resource quantity.",
            "format":"int32"
        },
        "FinancialPeriod1Quantity":{
            "type":"number",
            "description":"The value that represents the resource allocation hours for the first financial period for this project resource quantity. If the week contains days from two different months, two ProjectResourceQuantity business objects will exist. The first business object's Quantity field represents the hours of the first week fragment (WeekStartDate and MonthStartDate have the same month value). The second business object's Quantity field represents the second week fragment (WeekStartDate and MonthStartDate have different month values).",
            "format":"double"
        },
        "FinancialPeriod2ObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated second financial period for this project resource quantity.",
            "format":"int32"
        },
        "FinancialPeriod2Quantity":{
            "type":"number",
            "description":"The value that represents the resource allocation hours for the second financial period for this project resource quantity. If the week contains days from two different months, two ProjectResourceQuantity business objects will exist. The first business object's Quantity field represents the hours of the first week fragment (WeekStartDate and MonthStartDate have the same month value). The second business object's Quantity field represents the second week fragment (WeekStartDate and MonthStartDate have different month values).",
            "format":"double"
        },
        "FinancialPeriodTmplId":{
            "type":"integer",
            "format":"int32"
        },
        "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 quantity was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this project resource quantity."
        },
        "MonthStartDate":{
            "type":"string",
            "description":"The date value that represents the first day of the month. If the week contains days from two different months, two objects will exist. The first ProjectResourceQuantity object's MonthStartDate is the first day of the month for the first week fragment. The second ProjectResourceQuantity object's MonthStartDate is the first day of the month for the second week fragment.",
            "format":"date-time"
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "ProjectResourceObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project resource.",
            "format":"int32"
        },
        "Quantity":{
            "type":"number",
            "description":"The value that represents the resource allocation hours per week for this project resource quantity. If the week contains days from two different months, two ProjectResourceQuantity business objects will exist. The first business object's Quantity field represents the hours of the first week fragment (WeekStartDate and MonthStartDate have the same month value). The second business object's Quantity field represents the second week fragment (WeekStartDate and MonthStartDate have different month values).",
            "format":"double"
        },
        "ResourceObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated resource.",
            "format":"int32"
        },
        "RoleObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated role.",
            "format":"int32"
        },
        "WBSObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated WBS.",
            "format":"int32"
        },
        "WeekStartDate":{
            "type":"string",
            "description":"The date value that represents the first day of the week.",
            "format":"date-time"
        }
    },
    "description":"ProjectResourceQuantity Entity"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Resource Created.

Body ()

Root Schema : List<CreateProjectResourceQuantityResponse>

Type: array

Title: List<CreateProjectResourceQuantityResponse>

Show Source

• Array of: object CreateProjectResourceQuantityResponse
  Title: CreateProjectResourceQuantityResponse

  CreateProjectResourceQuantityResponse Entity

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

Nested Schema : CreateProjectResourceQuantityResponse

Type: object

Title: CreateProjectResourceQuantityResponse

CreateProjectResourceQuantityResponse Entity

Show Source

• MonthStartDate: string
  The value that represents the resource allocation hours per week for this project resource quantity. If the week contains days from two different months, two ProjectResourceQuantity business objects will exist. The first business object's Quantity field represents the hours of the first week fragment (WeekStartDate and MonthStartDate have the same month value). The second business object's Quantity field represents the second week fragment (WeekStartDate and MonthStartDate have different month values).
• ProjectResourceObjectId: integer (int32)
  The unique ID of the associated project resource.
• WeekStartDate: string
  The date value that represents the first day of the week.

{
    "title":"CreateProjectResourceQuantityResponse",
    "type":"object",
    "properties":{
        "ProjectResourceObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project resource.",
            "format":"int32"
        },
        "WeekStartDate":{
            "type":"string",
            "description":"The date value that represents the first day of the week."
        },
        "MonthStartDate":{
            "type":"string",
            "description":"The value that represents the resource allocation hours per week for this project resource quantity. If the week contains days from two different months, two ProjectResourceQuantity business objects will exist. The first business object's Quantity field represents the hours of the first week fragment (WeekStartDate and MonthStartDate have the same month value). The second business object's Quantity field represents the second week fragment (WeekStartDate and MonthStartDate have different month values)."
        }
    },
    "description":"CreateProjectResourceQuantityResponse Entity"
}

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