Jump to

• Request
• Response

View a Project Resource Work Rate

get

/api/restapi/projectResourceWorkRate/{projectResourceWorkRateId}

This endpoint returns a project resource work rate that meet the following requirements:

• The object has an ID that matches the value of the {projectResourceWorkRateId} path parameter.

Request

Path Parameters

• projectResourceWorkRateId(required): integer(int64)
  The system-generated identifier of a project resource work rate.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityProjectResourceWorkRate

Type: object

Title: ApiEntityProjectResourceWorkRate

Show Source

• effectiveStartDate: string (date-time)
  Date that the corresponding units/time period and rates go into effect for the resource or role.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• maxUnitsPerTime: 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: 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: integer (int64)
  The unique identifier for the resource.The resource object can also be identified by its unique criteria.
• updateDate: string (date-time)
  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":"ApiEntityProjectResourceWorkRate",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "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/ApiEntityProjectResourceWorkRateCost"
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : projectResourceWorkRateCost

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

Match All

Show Source

• object ApiEntityProjectResourceWorkRateCost
  Title: ApiEntityProjectResourceWorkRateCost

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

Nested Schema : ApiEntityProjectResourceWorkRateCost

Type: object

Title: ApiEntityProjectResourceWorkRateCost

Show Source

• link: string (url)
  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. 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)
  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. 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)
  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. 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)
  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. 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)
  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. 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)
  The unique identifier of a project work rate.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProjectResourceWorkRateCost",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "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. This field is in base currency and is calculated from pricePerUnit1Project field based on the specified exchange rate.",
            "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. This field is in base currency and is calculated from pricePerUnit2Project field based on the specified exchange rate.",
            "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. This field is in base currency and is calculated from pricePerUnit3Project field based on the specified exchange rate.",
            "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. This field is in base currency and is calculated from pricePerUnit4Project field based on the specified exchange rate.",
            "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. This field is in base currency and is calculated from pricePerUnit5Project field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectResourceWorkRateId":{
            "type":"integer",
            "description":"The unique identifier of a project work rate.",
            "format":"int64",
            "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":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested project resource work rate does not exist, or you do not have access to it.

Back to Top