Jump to

• Request
• Response

Update a Resource Work Rate

put

/api/restapi/resourceWorkRate

Send a request to this endpoint to update a resource work rate.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityResourceWorkRateInput

Type: object

Title: ApiEntityResourceWorkRateInput

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

• resourceWorkRateId
• effectiveStartDate,workspaceResourceId
• effectiveStartDate,resourceId,workspaceId
• effectiveStartDate,resourceId,workspaceCode
• effectiveStartDate,resourceCode,resourceClass,workspaceId
• effectiveStartDate,resourceCode,resourceClass,workspaceCode

Show Source

• effectiveStartDate(required): string (date-time)
  The 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)
  The maximum work units per time the resource or role can perform on all their assigned activities
  For example, if the selected resource is one person, a reasonable value may be 8 hours (units) per day (duration). In this case, the Max Units/Time would be 8.00h/d, or 8 hours of work per day. Similarly, if the selected resource is a department with 5 people, then the Max Units/Time may be 40.00h/d. This means that 5 people can perform 40 hours of work per day, rather than 1 person performing 8 hours of work per day.
• 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 unique identifier for the resource or role.
• resourceId(required): integer (int64)
  The unique identifier for the resource or role.
• resourceWorkRateCost: resourceWorkRateCost
  An entity containing the price per unit fields of a resource work rate.
• resourceWorkRateId: integer (int64)
  The system-generated identifier of the work rate.
• 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 user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
• workspaceResourceId: integer (int64)
  The unique identifier for the resource.The resource object can also be identified by its unique criteria.

{
    "title":"ApiEntityResourceWorkRateInput",
    "required":[
        "effectiveStartDate",
        "maxUnitsPerTime",
        "resourceId",
        "workspaceId"
    ],
    "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"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "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":"The 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":"The maximum work units per time the resource or role can perform on all their assigned activities <br />For example, if the selected resource is one person, a reasonable value may be 8 hours (units) per day (duration). In this case, the Max Units/Time would be 8.00h/d, or 8 hours of work per day. Similarly, if the selected resource is a department with 5 people, then the Max Units/Time may be 40.00h/d. This means that 5 people can perform 40 hours of work per day, rather than 1 person performing 8 hours of work per day.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceWorkRateId":{
            "type":"integer",
            "description":"The system-generated identifier of the work rate.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceResourceId":{
            "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"
            ]
        },
        "resourceWorkRateCost":{
            "description":"An entity containing the price per unit fields of a resource work rate.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityResourceWorkRateCostInput"
                }
            ]
        },
        "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 ResourceWorkRate object, a unique ResourceWorkRate object can be identified by the following combinations of the fields.<ul><li>resourceWorkRateId</li><li>effectiveStartDate,workspaceResourceId</li><li>effectiveStartDate,resourceId,workspaceId</li><li>effectiveStartDate,resourceId,workspaceCode</li><li>effectiveStartDate,resourceCode,resourceClass,workspaceId</li><li>effectiveStartDate,resourceCode,resourceClass,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : resourceWorkRateCost

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

Match All

Show Source

• object ApiEntityResourceWorkRateCostInput
  Title: ApiEntityResourceWorkRateCostInput

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

Nested Schema : ApiEntityResourceWorkRateCostInput

Type: object

Title: ApiEntityResourceWorkRateCostInput

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)
  Minimum Value: 0

  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)
  Minimum Value: 0

  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)
  Minimum Value: 0

  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)
  Minimum Value: 0

  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)
  Minimum Value: 0

  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.
• resourceWorkRateId: integer (int64)
  The system-generated identifier of the work rate.
• updateDate: string (date-time)
  Read Only: true

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

{
    "title":"ApiEntityResourceWorkRateCostInput",
    "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":"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
        },
        "pricePerUnit2":{
            "minimum":"0",
            "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
        },
        "pricePerUnit3":{
            "minimum":"0",
            "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
        },
        "pricePerUnit4":{
            "minimum":"0",
            "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
        },
        "pricePerUnit5":{
            "minimum":"0",
            "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
        },
        "resourceWorkRateId":{
            "type":"integer",
            "description":"The system-generated identifier of the work rate.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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 Update a Resource Work Rate Using Resource Work Rate ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the Resource Work Rate service.

Back to Top