Create a direct assignment request
post
/fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanDirectAssignmentRequests
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CompensationPlanId: integer
(int64)
The unique identifier of the base compensation plan.
-
EndDate: string
(date)
The date when the direct assignment request becomes inactive.
-
ErrorReason: string
Maximum Length:
240
The reason why Deploy Compensation Plans process rejected the request. This attribute is not populated if the record has been processed. -
ParticipantId: integer
(int64)
The unique identifier of the participant.
-
RequestCreateFlag: boolean
Indicates whether a direct assignment request should be created.
-
RequestDeleteFlag: boolean
Indicates whether a direct assignment request should be deleted. If the flag is set Y and the delete does not work, then you must set the flag to True.
-
RequestEditFlag: boolean
Indicates whether a direct assignment request should be edited.
-
SrpCompPlanId: integer
(int64)
The unique identifier of the compensation plan.
-
StartDate: string
(date)
The date when the direct assignment request becomes active.
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-CompensationPlanDirectAssignmentRequests-item-response
Type:
Show Source
object
-
CompensationPlanId: integer
(int64)
The unique identifier of the base compensation plan.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the direct assignment request. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the direct assignment request was created. -
EndDate: string
(date)
The date when the direct assignment request becomes inactive.
-
ErrorReason: string
Maximum Length:
240
The reason why Deploy Compensation Plans process rejected the request. This attribute is not populated if the record has been processed. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the direct assignment request was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the direct assignment request. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantId: integer
(int64)
The unique identifier of the participant.
-
ParticipantName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the participant. -
ParticipantPlanNumber: string
Read Only:
true
Maximum Length:30
The alternate key identifier of the participant plan. -
PlanDirectAssignmentRequestId: integer
(int64)
Read Only:
true
The unique identifier of the direct assignment request. -
ProcessingStatus: string
Read Only:
true
The processing status of the participant direct assignment request specifying the stage the request is in, such as Create requested, Create request completed, Create request failed, Edit requested, Update request completed, Update request failed, Delete requested, Delete request completed, or Delete request failed. A list of acceptable values is defined in the lookup ORA_CN_PRT_DRCT_ASGN_RQ_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
ProcessRequestId: integer
(int64)
Read Only:
true
The unique identifier of the request of the Deploy Compensation Plan process that picked up the request. -
RequestCreateFlag: boolean
Indicates whether a direct assignment request should be created.
-
RequestDeleteFlag: boolean
Indicates whether a direct assignment request should be deleted. If the flag is set Y and the delete does not work, then you must set the flag to True.
-
RequestEditFlag: boolean
Indicates whether a direct assignment request should be edited.
-
SrpCompPlanId: integer
(int64)
The unique identifier of the compensation plan.
-
StartDate: string
(date)
The date when the direct assignment request becomes active.
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
- CnLookupProcessingStatus
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_CN_PRT_DRCT_ASGN_RQ_STATUS
The list of values indicating the processing status of the participant direct assignment request.
The following properties are defined on the LOV link relation:- Source Attribute: ProcessingStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CompensationPlanAssignments
-
The list of values containing the unique identifiers of the participant compensation plan.
The following properties are defined on the LOV link relation:- Source Attribute: SrpCompPlanId; Target Attribute: SrpCompPlanId
- Display Attribute: AnalystName, ParticipantName, ParticipantId, SrpCompPlanId, StartDate, EndDate
- ParticipantVO
-
Parameters:
- finder:
SearchActiveParticipant
The list of values containing the unique identifiers of the participant.
The following properties are defined on the LOV link relation:- Source Attribute: ParticipantId; Target Attribute: ParticipantId
- Display Attribute: ParticipantName, PersonNumber, AnalystName
- finder: