View all Resource Work Rates by Workspace
get
/api/restapi/resourceWorkRate/workspace/{workspaceId}
Send a request to this endpoint to view the work rates of all resources belonging to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
Request
Path Parameters
-
workspaceId(required): integer(int64)
The system-generated identifier of a workspace.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityResourceWorkRate>
Type:
array
Title:
Show Source
List<ApiEntityResourceWorkRate>
-
Array of:
object ApiEntityResourceWorkRate
Title:
ApiEntityResourceWorkRate
Nested Schema : ApiEntityResourceWorkRate
Type:
object
Title:
Show Source
ApiEntityResourceWorkRate
-
effectiveStartDate: string
(date-time)
The 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)
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: 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)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: 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.
Nested Schema : resourceWorkRateCost
An entity containing the price per unit fields of a resource work rate.
Match All
Show Source
-
object
ApiEntityResourceWorkRateCost
Title:
ApiEntityResourceWorkRateCost
Nested Schema : ApiEntityResourceWorkRateCost
Type:
object
Title:
Show Source
ApiEntityResourceWorkRateCost
-
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. -
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)
Date when the record was last updated.
204 Response
Successful operation with no content.
404 Response
The requested resource work rate does not exist, or you do not have access to it.