Jump to

• Request
• Response

Batch Update Project Resource Work Rates

put

/api/restapi/projectResourceWorkRate/batch

Send a request to this endpoint to update one or more project resource work rates.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityProjectResourceWorkRateInput>

Type: array

Title: List<ApiEntityProjectResourceWorkRateInput>

Show Source

• Array of: object ApiEntityProjectResourceWorkRateInput
  Title: ApiEntityProjectResourceWorkRateInput

  This entity represents a ProjectResourceWorkRate object, a unique ProjectResourceWorkRate object can be identified by the following combinations of the fields.

  • projectResourceWorkRateId
  • effectiveStartDate,projectResourceId
  • effectiveStartDate,resourceId,projectCode,workspaceCode
  • effectiveStartDate,resourceCode,resourceClass,projectId
  • effectiveStartDate,resourceCode,resourceClass,projectCode,workspaceCode

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

Nested Schema : ApiEntityProjectResourceWorkRateInput

Type: object

Title: ApiEntityProjectResourceWorkRateInput

This entity represents a ProjectResourceWorkRate object, a unique ProjectResourceWorkRate object can be identified by the following combinations of the fields.

• projectResourceWorkRateId
• effectiveStartDate,projectResourceId
• effectiveStartDate,resourceId,projectCode,workspaceCode
• effectiveStartDate,resourceCode,resourceClass,projectId
• effectiveStartDate,resourceCode,resourceClass,projectCode,workspaceCode

Show Source

• effectiveStartDate(required): string (date-time)
  Date that the corresponding units/time period and rates go into effect for the resource or role.
• maxUnitsPerTime(required): number (double)
  Maximum work units per time the resource or role can perform on all their assigned activities.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The code of a project of a project resource.
• projectId(required): integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• projectResourceId: integer (int64)
  The unique identifier of a project resource.
• projectResourceWorkRateCost: projectResourceWorkRateCost
  An entity containing the price per unit fields of a project resource work rate.
• projectResourceWorkRateId: integer (int64)
  The unique identifier of a project work rate.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class identifies the item as a resource or a role.
• resourceCode: string
  Minimum Length: 1

  Maximum Length: 60

  The code of a resource of a project resource.
• resourceId(required): integer (int64)
  The unique identifier for the resource.The resource object can also be identified by its unique criteria.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The code of a workspace of a project resource.

{
    "title":"ApiEntityProjectResourceWorkRateInput",
    "required":[
        "effectiveStartDate",
        "maxUnitsPerTime",
        "projectId",
        "resourceId"
    ],
    "type":"object",
    "properties":{
        "projectResourceWorkRateCost":{
            "description":"An entity containing the price per unit fields of a project resource work rate.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRateCostInput"
                }
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The code of a project of a project resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The code of a workspace of a project resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "effectiveStartDate":{
            "type":"string",
            "description":"Date that the corresponding units/time period and rates go into effect for the resource or role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectResourceWorkRateId":{
            "type":"integer",
            "description":"The unique identifier of a project work rate.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectResourceId":{
            "type":"integer",
            "description":"The unique identifier of a project resource.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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 code of a resource of a project resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "maxUnitsPerTime":{
            "type":"number",
            "description":"Maximum work units per time the resource or role can perform on all their assigned activities.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "description":"This entity represents a ProjectResourceWorkRate object, a unique ProjectResourceWorkRate object can be identified by the following combinations of the fields.<ul><li>projectResourceWorkRateId</li><li>effectiveStartDate,projectResourceId</li><li>effectiveStartDate,resourceId,projectCode,workspaceCode</li><li>effectiveStartDate,resourceCode,resourceClass,projectId</li><li>effectiveStartDate,resourceCode,resourceClass,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : projectResourceWorkRateCost

An entity containing the price per unit fields of a project resource work rate.

Match All

An entity containing the price per unit fields of a project resource work rate.

Show Source

• object ApiEntityProjectResourceWorkRateCostInput
  Title: ApiEntityProjectResourceWorkRateCostInput

{
    "description":"An entity containing the price per unit fields of a project resource work rate.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRateCostInput"
        }
    ]
}

Nested Schema : ApiEntityProjectResourceWorkRateCostInput

Type: object

Title: ApiEntityProjectResourceWorkRateCostInput

Show Source

• pricePerUnit1Project: number (double)
  The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.
• pricePerUnit2Project: number (double)
  The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.
• pricePerUnit3Project: number (double)
  The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.
• pricePerUnit4Project: number (double)
  The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.
• pricePerUnit5Project: number (double)
  The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.

{
    "title":"ApiEntityProjectResourceWorkRateCostInput",
    "type":"object",
    "properties":{
        "pricePerUnit3Project":{
            "type":"number",
            "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pricePerUnit1Project":{
            "type":"number",
            "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pricePerUnit5Project":{
            "type":"number",
            "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pricePerUnit2Project":{
            "type":"number",
            "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pricePerUnit4Project":{
            "type":"number",
            "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Create Project Resource Work Rates Using Resource Work Rate IDs

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}

400 Response

Invalid input.

Back to Top