Create a labor resource assignment for a project task
post
/fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/LaborResourceAssignments
Request
Path Parameters
-
ProjectId(required): integer(int64)
Unique identifier of the project.
-
TasksUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Tasks resource and used to uniquely identify an instance of Tasks. The client should not generate the hash key value. Instead, the client should query on the Tasks collection resource in order to navigate to a specific instance of Tasks to get the hash key.
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
-
LaborBilledAmount: number
Title:
Planned Labor Bill Amount
Specifies the labor bill amount of the task. -
LaborCostAmount: number
Title:
Labor Cost
Specifies the labor cost of the task. -
LaborPrimaryResource: string
Title:
Primary Labor Resource ID
Indicates that the resource is the primary labor resource for the project task. -
LaborResourceEmail: string
Title:
Resource Email
E-mail address of the labor resource assigned to the task. Required if the resource type is Labor. -
LaborResourceId: integer
(int64)
Title:
Labor Resource ID
Unique identifier of the labor resource assigned to the project task. -
LaborResourceName: string
Title:
Labor Resource Name
Name of the labor resource assigned to the project task. -
ProjectResourceAssignId: integer
Title:
Project Resource Assignment ID
Unique identifier of the assignment of the labor resource in a project. -
ProjElementId: integer
(int64)
Title:
Task ID
Identifier of the task to which the labor resource is assigned. -
ResourceAllocationPercent: number
Title:
Labor Resource Allocation
Allocation percentage of the labor resource assigned to the task.
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 : projects-Tasks-LaborResourceAssignments-item-response
Type:
Show Source
object
-
LaborBilledAmount: number
Title:
Planned Labor Bill Amount
Specifies the labor bill amount of the task. -
LaborCostAmount: number
Title:
Labor Cost
Specifies the labor cost of the task. -
LaborPrimaryResource: string
Title:
Primary Labor Resource ID
Indicates that the resource is the primary labor resource for the project task. -
LaborResourceAssignmentId: integer
(int64)
Title:
Labor Resource Assignment ID
Read Only:true
Unique identifier of the labor resource assignment for the project task. -
LaborResourceEmail: string
Title:
Resource Email
E-mail address of the labor resource assigned to the task. Required if the resource type is Labor. -
LaborResourceId: integer
(int64)
Title:
Labor Resource ID
Unique identifier of the labor resource assigned to the project task. -
LaborResourceName: string
Title:
Labor Resource Name
Name of the labor resource assigned to the project task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectResourceAssignId: integer
Title:
Project Resource Assignment ID
Unique identifier of the assignment of the labor resource in a project. -
ProjElementId: integer
(int64)
Title:
Task ID
Identifier of the task to which the labor resource is assigned. -
ResourceAllocationPercent: number
Title:
Labor Resource Allocation
Allocation percentage of the labor resource assigned to the task.
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 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.0.0/projects/300100093207556/child/Tasks/300100093207564/child/LaborResourceAssignments/
Example of Request Body
The following example shows the request body to create a new labor resource assignment for the resource Abraham Mason with e-mail prj_wf_in_grp@oracle.com for the task with task ID 300100093207564 that belongs to the project with project ID 300100093207556.
{ "LaborResourceName":"Abraham Mason", "LaborResourceEmail":"prj_wf_in_grp@oracle.com", "LaborPrimaryResource":"Y" }
Example of Response Body
The following example shows the contents of the response body in JSON format, including the labor resource e-mail and name.
{ "LaborBilledAmount" : 200, "LaborCostAmount" : 100, "LaborPrimaryResource" : null, "LaborResourceAssignmentId" : 300100093207563, "LaborResourceEmail" : "prj_wf_in_grp@oracle.com", "LaborResourceId" : 300100024326751, "LaborResourceName" : "Abraham Mason", "ProjElementId" : 300100093207564, "ResourceAllocationPercent" : 300, "links" : [{ ... }] }