Create a role
post
/fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanRoles
Request
Path Parameters
-
CompensationPlanId(required): integer(int64)
The unique identifier of the compensation plan.
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
-
CompensationPlanId: integer
(int64)
The unique identifier for a compensation plan.
-
EndDate: string
(date)
Title:
End Date
The date when the role assignment in a compensation plan becomes inactive. The acceptable format is yyyy-mm-dd. Once a date has been assigned, it cannot be updated to null. -
RoleId: integer
(int64)
The unique identifier for a role.
-
RolePlanId: integer
(int64)
The unique identifier for the role associated with a plan.
-
StartDate: string
(date)
Title:
Start Date
The date when the role assignment in a compensation plan becomes active. The acceptable format is yyyy-mm-dd.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : compensationPlans-CompensationPlanRoles-item-response
Type:
Show Source
object
-
CompensationPlanId: integer
(int64)
The unique identifier for a compensation plan.
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
EndDate: string
(date)
Title:
End Date
The date when the role assignment in a compensation plan becomes inactive. The acceptable format is yyyy-mm-dd. Once a date has been assigned, it cannot be updated to null. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RoleDescription: string
Title:
Role Description
Read Only:true
Maximum Length:120
The description of the role entered by the user while creating the role. -
RoleId: integer
(int64)
The unique identifier for a role.
-
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:60
The name of the role. -
RolePlanId: integer
(int64)
The unique identifier for the role associated with a plan.
-
StartDate: string
(date)
Title:
Start Date
The date when the role assignment in a compensation plan becomes active. The acceptable format is yyyy-mm-dd.
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.
Links
- RoleVO
-
The list of values containing the unique identifiers for roles.
The following properties are defined on the LOV link relation:- Source Attribute: RoleId; Target Attribute: RoleId
- Display Attribute: AccessType, RoleName, RoleDescription
Examples
The following example shows how to create a role by submitting a POST request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/compensationPlans/300100090306794/child/CompensationPlanRoles
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "RoleId" : 100000015115351, "StartDate" : "2016-01-01", "EndDate" : "2016-12-31" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "RolePlanId": 300100090480296, "RoleId": 100000015115351, "StartDate": "2016-01-01", "EndDate": "2016-12-31", "RoleDescription": "US Sales Executive", "RoleName": "US Sales Executive", "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-06-07T08:07:38-07:00", "LastUpdateLogin": "5160681C1C454D39E0532DD6F00A08CA", "LastUpdateDate": "2017-06-07T08:07:38.794-07:00", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CompensationPlanId": 300100090306794, "links": [ ... ] }