Batch Update Resource Demands
put
/api/restapi/resourceDemand/batch
Send a request to this endpoint to update one or more resource demands.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityResourceDemandInput>
Type:
array
Title:
Show Source
List<ApiEntityResourceDemandInput>
-
Array of:
object ApiEntityResourceDemandInput
Title:
ApiEntityResourceDemandInput
This entity represents a ResourceDemand object, a unique ResourceDemand object can be identified by the following combinations of the fields.- resourceDemandId
- projectId,resourceId
- resourceId,projectCode,workspaceCode
- projectId,resourceCode,resourceClass,workspaceCode
- projectCode,resourceCode,resourceClass,workspaceCode
Nested Schema : ApiEntityResourceDemandInput
Type:
object
Title:
ApiEntityResourceDemandInput
This entity represents a ResourceDemand object, a unique ResourceDemand object can be identified by the following combinations of the fields.
Show Source
- resourceDemandId
- projectId,resourceId
- resourceId,projectCode,workspaceCode
- projectId,resourceCode,resourceClass,workspaceCode
- projectCode,resourceCode,resourceClass,workspaceCode
-
allocationPercentage: number
(double)
The allocation of the current role, displayed as a percentage of the availability of the role.
-
commitDuration: number
(double)
The total duration of the commitments.
-
commitEndDate: string
(date-time)
The finish date of the allocation commitment.
-
commitFTE: number
The total committed FTE. Calculated as total commitment units divided by total commitment duration.
-
commitStartDate: string
(date-time)
The start date of the allocation commitment.
-
committedUnits: integer
(int64)
The sum of committed units for a given project - role demand.
-
demandFTE: number
The total demand FTE. Calculated as total demand units divided by total demand duration.
-
demandUnits: integer
(int64)
The sum of the demand units entered for a single role.
-
duration: number
(double)
The total expected duration of the demand.
-
endDate: string
(date-time)
The finish date for the demand.
Calculated as Start plus Total Demand. -
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. -
periodId: integer
(int64)
The unique identifier for the period.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId(required): integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
proposedAllocationUnits: integer
(int64)
The total role allocation units proposed.
-
proposedDuration: number
(double)
The total duration of the proposed role allocation units.
-
proposedEndDate: string
(date-time)
The finish date of the proposed role allocations.
-
proposedFTE: number
The total proposed allocation FTE. Calculated as total proposed role allocation units divided by the total proposed role allocation duration.
-
proposedStartDate: string
(date-time)
The start date of the proposed role allocations.
-
requesterId: integer
(int64)
The unique identifier of the user who submitted the demand.
-
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. -
resourceDemandCost:resourceDemandCostRead Only:true
Deprecated. As of 24.4.The total cost associated with the role's demand. This is calculated based on the standard role rates. -
resourceDemandData: array
resourceDemandData
Data about demand for the resource.
-
resourceDemandId: integer
(int64)
The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.
-
resourceId(required): integer
(int64)
The unique identifier for the resource.The resource object can also be identified by its unique criteria.
-
sequenceNumber(required): integer
(int32)
Determines the order of appearance of demands in a list.
-
startDate: string
(date-time)
The start date for the demand.
-
status: string
Allowed Values:
[ "DRAFT", "COMMITTED", "NEW", "REVISED", "REVIEWED" ]
The status of the current demand. -
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.
Nested Schema : resourceDemandCost
Read Only:
true
Deprecated. As of 24.4.The total cost associated with the role's demand. This is calculated based on the standard role rates.
Match All
Show Source
-
object
ApiEntityResourceDemandCostInput
Title:
ApiEntityResourceDemandCostInput
Read Only:true
Nested Schema : resourceDemandData
Type:
array
Data about demand for the resource.
Show Source
-
Array of:
object ApiEntityResourceDemandDataInput
Title:
ApiEntityResourceDemandDataInput
Nested Schema : ApiEntityResourceDemandCostInput
Type:
object
Title:
ApiEntityResourceDemandCostInput
Read Only:
Show Source
true
-
committedCost: number
(double)
The total cost associated with the role's committed units. This is calculated based on the standard role rates. This field is in base currency and is calculated from committedCostProject field based on the specified exchange rate.
-
committedCostProject: number
(double)
The total cost associated with the role's committed units in a project. This is calculated based on the standard role rates. This value is based on the project currency.
-
demandCost: number
(double)
The total cost associated with the role's demand. This is calculated based on the standard role rates. This field is in base currency and is calculated from demandCostProject field based on the specified exchange rate.
-
demandCostProject: number
(double)
The total cost associated with the role's demand in a project. This is calculated based on the standard role rates. This value is based on the project currency.
-
demandId: integer
(int64)
The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.
-
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. -
projectId: integer
(int64)
The unique identifier for the project.
-
proposedCost: number
(double)
The total cost associated with the role's proposed allocation units. This is calculated based on the standard role rates. This field is in base currency and is calculated from proposedCostProject field based on the specified exchange rate.
-
proposedCostProject: number
(double)
The total cost associated with the role's proposed allocation units in a project. This is calculated based on the standard role rates. This value is based on the project currency.
-
resourceId: integer
(int64)
The unique identifier of the assigned role.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : ApiEntityResourceDemandDataInput
Type:
object
Title:
Show Source
ApiEntityResourceDemandDataInput
-
allocatedUnits: integer
(int64)
The unit allocation for the current role.
-
commitDate: string
(date-time)
The commitment date for the demand.
-
committedFlag: boolean
Indicates whether the weekly demand data is committed.
-
committedUnits: integer
(int64)
The total committed units of the weekly demand data.
-
demandDataId: integer
(int64)
The unique identifier for the weekly demand data.
-
demandUnits: integer
(int64)
The demand units entered for a single role.
-
duration: number
(double)
The total expected duration of the weekly demand data.
-
endDate: string
(date-time)
The finish date for the weekly demand data.
Calculated as Start plus Total Demand. -
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. -
proposedAllocationUnits: integer
(int64)
The total proposed duration of the demand.
-
proposedDuration: number
(double)
The total role allocation units proposed.
-
resourceDemandDataCost:resourceDemandDataCostRead Only:true
Deprecated. As of 24.4.The total cost associated with the role's demand. This is calculated based on the standard role rates. -
resourceDemandId(required): integer
(int64)
The unique identifier for the demand.
-
startDate: string
(date-time)
The start date for the weekly demand data.
-
startOfMonth: string
(date-time)
The month in which the demand starts.
-
status: string
Allowed Values:
[ "DRAFT", "COMMITTED", "NEW", "REVISED", "REVIEWED" ]
The status of the current weekly demand data. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : resourceDemandDataCost
Read Only:
true
Deprecated. As of 24.4.The total cost associated with the role's demand. This is calculated based on the standard role rates.
Match All
Show Source
-
object
ApiEntityResourceDemandDataCostInput
Title:
ApiEntityResourceDemandDataCostInput
Read Only:true
Nested Schema : ApiEntityResourceDemandDataCostInput
Type:
object
Title:
ApiEntityResourceDemandDataCostInput
Read Only:
Show Source
true
-
committedCost: number
(double)
The total cost associated with the role's committed units. This is calculated based on the standard role rates. This field is in base currency and is calculated from committedCostProject field based on the specified exchange rate.
-
committedCostProject: number
(double)
The total cost associated with the role's committed units in a project. This is calculated based on the standard role rates. This value is based on the project currency.
-
demandCost: number
(double)
The total cost associated with the role's demand. This is calculated based on the standard role rates. This field is in base currency and is calculated from demandCostProject field based on the specified exchange rate.
-
demandCostProject: number
(double)
The total cost associated with the role's demand in a project. This is calculated based on the standard role rates. This value is based on the project currency.
-
demandDataId: integer
(int64)
The unique identifier for the weekly demand data.
-
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. -
proposedCost: number
(double)
The total cost associated with the role's proposed allocation units. This is calculated based on the standard role rates.?? This field is in base currency and is calculated from proposedCostProject field based on the specified exchange rate.
-
proposedCostProject: number
(double)
The total cost associated with the role's proposed allocation units in a project. This is calculated based on the standard role rates. This value is based on the project currency.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Examples
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 for the Resource Demand service.