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.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• maxUnitsPerTime(required): integer (int64)
  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.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• 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":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "maxUnitsPerTime":{
            "type":"integer",
            "description":"Maximum work units per time the resource or role can perform on all their assigned activities.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "projectResourceWorkRateCost":{
            "description":"An entity containing the price per unit fields of a project resource work rate.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRateCostInput"
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "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

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

• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• pricePerUnit1: number (double)
  Read Only: true

  Minimum Value: 0

  Deprecated. As of 23.11.
  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. This field is in base currency and is calculated from pricePerUnit1Project field based on the specified exchange rate.
• 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.
• pricePerUnit2: number (double)
  Read Only: true

  Minimum Value: 0

  Deprecated. As of 23.11.
  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. This field is in base currency and is calculated from pricePerUnit2Project field based on the specified exchange rate.
• 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.
• pricePerUnit3: number (double)
  Read Only: true

  Minimum Value: 0

  Deprecated. As of 23.11.
  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. This field is in base currency and is calculated from pricePerUnit3Project field based on the specified exchange rate.
• 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.
• pricePerUnit4: number (double)
  Read Only: true

  Minimum Value: 0

  Deprecated. As of 23.11.
  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. This field is in base currency and is calculated from pricePerUnit4Project field based on the specified exchange rate.
• 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.
• pricePerUnit5: number (double)
  Read Only: true

  Minimum Value: 0

  Deprecated. As of 23.11.
  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. This field is in base currency and is calculated from pricePerUnit5Project field based on the specified exchange rate.
• 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.
• projectResourceWorkRateId: integer (int64)
  Deprecated. As of 23.11.
  The unique identifier of a project work rate.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityProjectResourceWorkRateCostInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "pricePerUnit1":{
            "minimum":"0",
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>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. This field is in base currency and is calculated from pricePerUnit1Project field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "pricePerUnit2":{
            "minimum":"0",
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>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. This field is in base currency and is calculated from pricePerUnit2Project field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "pricePerUnit3":{
            "minimum":"0",
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>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. This field is in base currency and is calculated from pricePerUnit3Project field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "pricePerUnit4":{
            "minimum":"0",
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>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. This field is in base currency and is calculated from pricePerUnit4Project field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "pricePerUnit5":{
            "minimum":"0",
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>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. This field is in base currency and is calculated from pricePerUnit5Project field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "projectResourceWorkRateId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The unique identifier of a project work rate.",
            "format":"int64",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "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