Update a worker external identifier
patch
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/externalIdentifiers/{ExternalIdentifierId}
Request
Path Parameters
-
ExternalIdentifierId(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=
-
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
-
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
-
AssignmentId: integer
(int64)
Title:
Assignment ID
Unique identifier of the assignment to which this external identifier relates. -
AssignmentNumber: string
Title:
Assignment Number
Maximum Length:30
Assignment number to which the external identifier belongs. -
Comments: string
Title:
Identifier Comments
Maximum Length:2048
Comments for the external identifier. -
ExternalIdentifierNumber: string
Title:
Identifier
Maximum Length:256
External identifier number. -
ExternalIdentifierType: string
Title:
Identifier Type
Maximum Length:30
Type of external identifier, such as Third-Party Payroll ID. Valid values are defined in the commonLookupsLOV. -
FromDate: string
(date-time)
Title:
From Date
Date and time from when the external identifier is valid. -
ToDate: string
(date-time)
Title:
To Date
Date and time until when the external identifier is valid.
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 : workers-externalIdentifiers-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Title:
Assignment ID
Unique identifier of the assignment to which this external identifier relates. -
AssignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Name of the person's assignment. -
AssignmentNumber: string
Title:
Assignment Number
Maximum Length:30
Assignment number to which the external identifier belongs. -
Comments: string
Title:
Identifier Comments
Maximum Length:2048
Comments for the external identifier. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the external identifier. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the external identifier was created. -
ExternalIdentifierId: integer
(int64)
Title:
External Identifier ID
Read Only:true
Surrogate identifier for the external identifier. -
ExternalIdentifierNumber: string
Title:
Identifier
Maximum Length:256
External identifier number. -
ExternalIdentifierSequence: integer
(int32)
Title:
Sequence
Sequence of the external identifier. -
ExternalIdentifierType: string
Title:
Identifier Type
Maximum Length:30
Type of external identifier, such as Third-Party Payroll ID. Valid values are defined in the commonLookupsLOV. -
ExternalIdentifierTypeMeaning: string
Title:
Identifier Type
Read Only:true
Maximum Length:80
Meaning of the person's external identifier. -
FromDate: string
(date-time)
Title:
From Date
Date and time from when the external identifier is valid. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the external identifier was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the external identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ToDate: string
(date-time)
Title:
To Date
Date and time until when the external identifier is valid.
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
- externalIdentifierTypesLov
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_PER_EXT_IDENTIFIER_TYPES
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
Examples
The following example shows how to update a worker external identifier by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -X PATCH -d <payload>"https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED0005770800005AF3116303090000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016ABDF0400078/child/externalIdentifiers/300100188720811"
Example of Payload
The following is an example of the payload.
{ "Comments": "External identifier for the employee." }
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.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "ExternalIdentifierId": 300100188720811, "ExternalIdentifierSequence": 1, "ExternalIdentifierNumber": "A{{xs}}", "ExternalIdentifierType": "ORA_3RD_PARTY_PAY_ADD_ID", "AssignmentId": null, "FromDate": "2019-01-01T00:00:00+00:00", "ToDate": null, "Comments": "External identifier for the employee.", "CreatedBy": "VMOSS", "CreationDate": "2019-05-16T13:57:36+00:00", "LastUpdatedBy": "VMOSS", "LastUpdateDate": "2019-05-16T14:05:21+00:00", "AssignmentNumber": null, "links": [ {... } ] }