Create a labor resource assignment for a task
post
/fscmRestApi/resources/11.13.18.05/workPlanTemplates/{WorkPlanTemplateId}/child/TaskLaborResourceAssignments
Request
Path Parameters
-
WorkPlanTemplateId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
CostAmount: number
Title:
Planned Labor Resource Cost Amount
The planned cost amount of the labor resource for the task. -
EffortInHours: number
Title:
Planned Labor Resource Effort in Hours
Planned effort in hours of the labor resource for the task. -
LaborBillAmount: number
Title:
Planned Labor Resource Bill Amount
The planned bill amount of the labor resource for the task. -
LaborResourceId: integer
(int64)
Title:
Labor Resource ID
Unique identifier of the labor resource assigned to the task. -
PrimaryResourceFlag: boolean
Title:
Primary Resource
Indicates whether the resource is the primary labor resource for the task. The value is True if the resource is the primary labor resource. The value is False if the resource isn't the primary labor resource. -
ResourceAllocation: number
Title:
Labor Resource Allocation
Allocation percentage of the labor resource for the task. -
ResourceEmail: string
Title:
Labor Resource Email
Email address of the labor resource assigned to the task. -
ResourceName: string
Title:
Labor Resource Name
Name of the labor resource assigned to the task. -
TaskId: integer
(int64)
Title:
Task ID
Unique identifier of the task to which the labor resource is assigned. -
TemplateResourceAssignmentId: integer
Title:
Template Resource Assignment ID
Unique identifier of the assignment of the labor resource.
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 : workPlanTemplates-TaskLaborResourceAssignments-item-response
Type:
Show Source
object
-
CostAmount: number
Title:
Planned Labor Resource Cost Amount
The planned cost amount of the labor resource for the task. -
EffortInHours: number
Title:
Planned Labor Resource Effort in Hours
Planned effort in hours of the labor resource for the task. -
LaborBillAmount: number
Title:
Planned Labor Resource Bill Amount
The planned bill amount of the labor resource for the task. -
LaborResourceId: integer
(int64)
Title:
Labor Resource ID
Unique identifier of the labor resource assigned to the task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryResourceFlag: boolean
Title:
Primary Resource
Indicates whether the resource is the primary labor resource for the task. The value is True if the resource is the primary labor resource. The value is False if the resource isn't the primary labor resource. -
ResourceAllocation: number
Title:
Labor Resource Allocation
Allocation percentage of the labor resource for the task. -
ResourceEmail: string
Title:
Labor Resource Email
Email address of the labor resource assigned to the task. -
ResourceName: string
Title:
Labor Resource Name
Name of the labor resource assigned to the task. -
TaskId: integer
(int64)
Title:
Task ID
Unique identifier of the task to which the labor resource is assigned. -
TaskLaborResourceAssignmentId: integer
(int64)
Title:
Labor Resource Assignment ID
Read Only:true
Unique identifier of the labor resource assignment for the task. Value is auto-generated. -
TemplateResourceAssignmentId: integer
Title:
Template Resource Assignment ID
Unique identifier of the assignment of the labor resource.
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 a labor resource assignment for a task 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/workPlanTemplates/100100148369454/child/TaskLaborResourceAssignments
Request Body Example
The following shows an example of the request body in JSON format.
{ "TaskId": 100100148369456, "LaborResourceId": 300100024326655, "ResourceName": "Connor Horton", "ResourceEmail": "prj_connor_horton_grp@oracle.com }
Response Body Example
The following shows an example of the response body in JSON format.
{ "TaskLaborResourceAssignmentId": 100100148369467, "TaskId": 100100148369456, "LaborResourceId": 300100024326655, "ResourceName": "Connor Horton", "ResourceEmail": "prj_connor_horton_grp@oracle.com", "PrimaryResourceFlag": true, "ResourceAllocation": 100, "LaborBillAmount": 0, "CostAmount": 0, "EffortInHours": 0, "TemplateResourceAssignmentId": 100100148369483, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/TaskLaborResourceAssignments/100100148369467", "name": "TaskLaborResourceAssignments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/TaskLaborResourceAssignments/100100148369467", "name": "TaskLaborResourceAssignments", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454", "name": "workPlanTemplates", "kind": "item" } ] }