End a worker assignment
post
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/action/endAssignment
Ends an assignment of a worker.
Request
Path Parameters
-
PeriodOfServiceId(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=
-
assignmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AssignmentId, EffectiveStartDate, EffectiveEndDate, EffectiveSequence and EffectiveLatestChange ---for the Assignments resource and used to uniquely identify an instance of Assignments. The client should not generate the hash key value. Instead, the client should query on the Assignments collection resource with a filter on the primary key values in order to navigate to a specific instance of Assignments.
For example: assignments?q=AssignmentId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>;EffectiveSequence=<value4>;EffectiveLatestChange=<value5> -
workersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Workers resource and used to uniquely identify an instance of Workers. The client should not generate the hash key value. Instead, the client should query on the Workers collection resource in order to navigate to a specific instance of Workers to get the hash key.
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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/vnd.oracle.adf.action+json
Root Schema : schema
Type:
Show Source
object
-
actionCode: string
Action being performed on the assignment, such as Termination. Valid values are defined in the actionsLOV.
-
effectiveDate: string
(date)
Start date of the date-effective changes to the record.
-
reasonCode: string
Reason for the action being performed on the record. Valid values are defined in the actionReasonsLOV.
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): boolean
Internal identifier that indicates the success status of the custom method.
Examples
The following example shows how to end a worker's assignment by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" -H "REST-Framework-Version: 4" -X POST -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED00057708000110F086BB19F10000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001627E80E80078/child/workRelationships/300100215314932/child/assignments/00020000000EACED00057708000110F086BB19FB0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001627E80E80078/action/endAssignment"
Example of Payload
The following is an example of the payload.
{ "effectiveDate":"2018-09-01", "actionCode":"END_ASG" }
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK Content-Type : application/vnd.oracle.adf.actionresult+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "returnValue":"true" }