Update a worker citizenship
patch
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}
Request
Path Parameters
-
CitizenshipId(required): integer(int64)
Surrogate identifier for the citizenship of a worker.
-
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
-
citizenshipsDFF: array
Citizenship Descriptive Flexfields
Title:
Citizenship Descriptive Flexfields
The citizenshipsDFF resource is a child of the citizenships resource. It provides all the citizenship descriptive flexfields of a worker as of the specified date. By default, the current date is retained. -
CitizenshipStatus: string
Title:
Citizenship Status
Maximum Length:30
Status of the citizenship. Valid values are defined in the commonLookupsLOV. -
FromDate: string
(date)
Title:
From Date
Date from when the citizenship is valid. -
ToDate: string
(date)
Title:
To Date
Date until when the citizenship is valid.
Nested Schema : Citizenship Descriptive Flexfields
Type:
array
Title:
Citizenship Descriptive Flexfields
The citizenshipsDFF resource is a child of the citizenships resource. It provides all the citizenship descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : workers-citizenships-citizenshipsDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield for citizenship. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
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 : workers-citizenships-item-response
Type:
Show Source
object
-
Citizenship: string
Title:
Citizenship
Maximum Length:30
Citizenship legislation code. Valid values are defined in the hcmCountriesLov. -
CitizenshipId: integer
(int64)
Title:
Citizenship ID
Read Only:true
-
CitizenshipMeaning: string
Title:
Citizenship
Read Only:true
Maximum Length:80
-
citizenshipsDFF: array
Citizenship Descriptive Flexfields
Title:
Citizenship Descriptive Flexfields
The citizenshipsDFF resource is a child of the citizenships resource. It provides all the citizenship descriptive flexfields of a worker as of the specified date. By default, the current date is retained. -
CitizenshipStatus: string
Title:
Citizenship Status
Maximum Length:30
Status of the citizenship. Valid values are defined in the commonLookupsLOV. -
CitizenshipStatusMeaning: string
Title:
Citizenship Status
Read Only:true
Maximum Length:80
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
-
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
-
FromDate: string
(date)
Title:
From Date
Date from when the citizenship is valid. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ToDate: string
(date)
Title:
To Date
Date until when the citizenship is valid.
Nested Schema : Citizenship Descriptive Flexfields
Type:
array
Title:
Citizenship Descriptive Flexfields
The citizenshipsDFF resource is a child of the citizenships resource. It provides all the citizenship descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workers-citizenships-citizenshipsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield for citizenship. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
CitizenshipId: integer
(int64)
Title:
Citizenship ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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
- citizenshipLov
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{Citizenship}%2CLookupType%3DNATIONALITY
The following properties are defined on the LOV link relation:- Source Attribute: Citizenship; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- citizenshipStatusLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{CitizenshipStatus}%2CLookupType%3DPER_CITIZENSHIP_STATUS%2CLegislationCode%3D{Citizenship}
The following properties are defined on the LOV link relation:- Source Attribute: CitizenshipStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- citizenshipsDFF
-
Parameters:
- CitizenshipId:
$request.path.CitizenshipId
- workersUniqID:
$request.path.workersUniqID
The citizenshipsDFF resource is a child of the citizenships resource. It provides all the citizenship descriptive flexfields of a worker as of the specified date. By default, the current date is retained. - CitizenshipId:
Examples
The following example shows how to update a worker citizenship 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/citizenships/300100188720322
Example of Payload
The following is an example of the payload.
{ "FromDate" : "2017-05-16" }
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.
{ "CitizenshipId": 300100188720322, "Citizenship": "CN", "FromDate": "2017-05-16", "ToDate": null, "CitizenshipStatus": "A", "CreatedBy": "VMOSS", "CreationDate": "2019-05-16T11:25:43+00:00", "LastUpdatedBy": "VMOSS", "LastUpdateDate": "2019-05-16T11:37:16+00:00", "links": [ {... } ] }