Create a labor resource assignment for a task
post
/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskLaborResourceAssignments
Request
Path Parameters
-
ProjectId(required): integer(int64)
Unique identifier of the project.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActualBillAmount: number
Title:
Actual Labor Resource Bill Amount
The actual bill amount for the labor resource associated with the task. -
ActualCostAmount: number
Title:
Actual Labor Resource Cost Amount
The actual cost amount for the labor resource associated with the task. -
ActualEffortinHours: number
Title:
Actual Labor Resource Effort in Hours
Default Value:0
Actual effort in hours for the labor resource assigned to the task. -
CurrentBillAmount: number
Title:
Current Labor Resource Bill Amount
The current bill amount for the labor resource associated with the task. -
CurrentCostAmount: number
Title:
Current Labor Resource Cost Amount
The current cost amount for the labor resource associated with the task. -
CurrentEffortinHours: number
Title:
Current Labor Resource Effort in Hours
Estimated effort in hours on the task at completion for the labor resource. -
EffectiveBillRate: number
Title:
Effective Bill Rate
Indicates the rate derived from the rate schedule for calculating the bill amount. -
EffectiveCostRate: number
Title:
Effective Cost Rate
Indicates the rate derived from the rate schedule for calculating the burdened cost. -
IntegrationSource: string
Title:
Integration Source
Indicates the task was created in a third-party application. -
LaborResourceId: integer
(int64)
Title:
Labor Resource ID
Unique identifier of the labor resource assigned to the project task. You must enter either the Labor Resource ID or the Labor Resource Email when using POST or PATCH, but not both. -
PercentComplete: number
Title:
Labor Resource Percent Complete
Default Value:0
Indicates the percentage of work completed for the labor resource assigned to the task. -
PlannedBillAmount: number
Title:
Planned Labor Resource Bill Amount
The planned bill amount for the labor resource associated with the task. -
PlannedCostAmount: number
Title:
Planned Labor Resource Cost Amount
The planned cost amount for the labor resource associated with the task. -
PlannedEffortinHours: number
Title:
Planned Labor Resource Effort in Hours
Planned effort in hours of the labor resource assigned to the task. -
PrimaryResourceFlag: boolean
Title:
Primary Resource
Indicates whether the resource is the primary labor resource for the project task. The resource is the primary labor resource when the value is True. The value is False when the resource is not the primary labor resource. Default value is False. -
ProgressStatus: string
Title:
Labor Resource Progress Status
Maximum Length:20
Indicates the status of the work for the labor resource assigned to the task. -
ProjectResourceAssignId: integer
Title:
Project Resource Assignment ID
Unique identifier of the assignment of the labor resource in a project. -
RemainingBillAmount: number
Title:
Remaining Labor Resource Bill Amount
The remaining bill amount for the labor resource associated with the task. -
RemainingCostAmount: number
Title:
Remaining Labor Resource Cost Amount
The remaining cost amount for the labor resource associated with the task. -
RemainingEffortinHours: number
Title:
Remaining Labor Resource Effort in Hours
Remaining effort in hours for the labor resource assigned to the task. -
ResourceAllocation: number
Title:
Labor Resource Allocation
Allocation percentage of the labor resource assigned to the task. Default value is the same as the resource allocation for the project. -
ResourceEmail: string
Title:
Labor Resource Email
Maximum Length:240
Email address of the labor resource assigned to the task. You must enter either the Labor Resource ID or the Labor Resource Email when using POST or PATCH, but not both. -
TaskId: integer
(int64)
Title:
Task ID
Identifier of the task to which the labor resource is assigned. Value is mandatory when using POST.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectPlans-TaskLaborResourceAssignments-item-response
Type:
Show Source
object
-
ActualBillAmount: number
Title:
Actual Labor Resource Bill Amount
The actual bill amount for the labor resource associated with the task. -
ActualCostAmount: number
Title:
Actual Labor Resource Cost Amount
The actual cost amount for the labor resource associated with the task. -
ActualEffortinHours: number
Title:
Actual Labor Resource Effort in Hours
Default Value:0
Actual effort in hours for the labor resource assigned to the task. -
CurrentBillAmount: number
Title:
Current Labor Resource Bill Amount
The current bill amount for the labor resource associated with the task. -
CurrentCostAmount: number
Title:
Current Labor Resource Cost Amount
The current cost amount for the labor resource associated with the task. -
CurrentEffortinHours: number
Title:
Current Labor Resource Effort in Hours
Estimated effort in hours on the task at completion for the labor resource. -
EffectiveBillRate: number
Title:
Effective Bill Rate
Indicates the rate derived from the rate schedule for calculating the bill amount. -
EffectiveCostRate: number
Title:
Effective Cost Rate
Indicates the rate derived from the rate schedule for calculating the burdened cost. -
IntegrationSource: string
Title:
Integration Source
Indicates the task was created in a third-party application. -
LaborResourceId: integer
(int64)
Title:
Labor Resource ID
Unique identifier of the labor resource assigned to the project task. You must enter either the Labor Resource ID or the Labor Resource Email when using POST or PATCH, but not both. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PercentComplete: number
Title:
Labor Resource Percent Complete
Default Value:0
Indicates the percentage of work completed for the labor resource assigned to the task. -
PlannedBillAmount: number
Title:
Planned Labor Resource Bill Amount
The planned bill amount for the labor resource associated with the task. -
PlannedCostAmount: number
Title:
Planned Labor Resource Cost Amount
The planned cost amount for the labor resource associated with the task. -
PlannedEffortinHours: number
Title:
Planned Labor Resource Effort in Hours
Planned effort in hours of the labor resource assigned to the task. -
PrimaryResourceFlag: boolean
Title:
Primary Resource
Indicates whether the resource is the primary labor resource for the project task. The resource is the primary labor resource when the value is True. The value is False when the resource is not the primary labor resource. Default value is False. -
ProgressStatus: string
Title:
Labor Resource Progress Status
Maximum Length:20
Indicates the status of the work for the labor resource assigned to the task. -
ProjectResourceAssignId: integer
Title:
Project Resource Assignment ID
Unique identifier of the assignment of the labor resource in a project. -
RemainingBillAmount: number
Title:
Remaining Labor Resource Bill Amount
The remaining bill amount for the labor resource associated with the task. -
RemainingCostAmount: number
Title:
Remaining Labor Resource Cost Amount
The remaining cost amount for the labor resource associated with the task. -
RemainingEffortinHours: number
Title:
Remaining Labor Resource Effort in Hours
Remaining effort in hours for the labor resource assigned to the task. -
ResourceAllocation: number
Title:
Labor Resource Allocation
Allocation percentage of the labor resource assigned to the task. Default value is the same as the resource allocation for the project. -
ResourceEmail: string
Title:
Labor Resource Email
Maximum Length:240
Email address of the labor resource assigned to the task. You must enter either the Labor Resource ID or the Labor Resource Email when using POST or PATCH, but not both. -
ResourceName: string
Title:
Labor Resource Name
Read Only:true
Maximum Length:240
Name of the labor resource assigned to the project task. -
TaskId: integer
(int64)
Title:
Task ID
Identifier of the task to which the labor resource is assigned. Value is mandatory when using POST. -
TaskLaborResourceAssignmentId: integer
(int64)
Title:
Labor Resource Assignment ID
Read Only:true
Unique identifier of the labor resource assignment for the project task. Value is auto-generated when using POST and mandatory when using PATCH.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to create an expense resource by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100124723999/child/TaskLaborResourceAssignments/
Request Body Example
The following shows an example of the request body in JSON format.
{ "TaskId" : 300100151729759, "ResourceEmail" : "prj_Chloe_Security_grp@oracle.com" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "ActualBillAmount" : 0, "ActualCostAmount" : 0, "CurrentBillAmount" : 0, "CurrentCostAmount" : 0, "LaborResourceId" : 300100045206643, "PlannedBillAmount" : null, "PlannedCostAmount" : null, "PlannedEffortinHours" : null, "PrimaryResourceFlag" : false, "RemainingBillAmount" : null, "RemainingCostAmount" : null, "ResourceAllocation" : 100.000000000000000, "ResourceName" : "Chloe Security", "ResourceEmail" : "prj_Chloe_Security_grp@oracle.com", "TaskId" : 300100124764034, "TaskLaborResourceAssignmentId" : 300100124762026 }