Create a citizenship
post
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships
Request
Path Parameters
-
hcmContactsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the HCM Contacts resource and used to uniquely identify an instance of HCM Contacts. The client should not generate the hash key value. Instead, the client should query on the HCM Contacts collection resource in order to navigate to a specific instance of HCM Contacts 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.
-
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
-
Citizenship(required): string
Title:
Citizenship
Maximum Length:30
Citizenship legislation code. Valid values are defined in the hcmCountriesLov. -
citizenshipsDFF: array
citizenshipsDFF
-
CitizenshipStatus(required): string
Title:
Citizenship Status
Maximum Length:30
Status of the contact citizenship. Valid values are defined in the commonLookupsLOV. -
FromDate: string
(date)
Title:
From Date
Date from when the contact citizenship is valid. -
ToDate: string
(date)
Title:
To Date
Date until when the contact citizenship is valid.
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
CitizenshipId: integer
(int64)
Title:
Citizenship ID
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 : hcmContacts-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
Surrogate identifier for the contact citizenship. -
CitizenshipMeaning: string
Title:
Citizenship
Read Only:true
Maximum Length:80
Name of the contact's citizenship legislation code. -
citizenshipsDFF: array
citizenshipsDFF
-
CitizenshipStatus: string
Title:
Citizenship Status
Maximum Length:30
Status of the contact citizenship. Valid values are defined in the commonLookupsLOV. -
CitizenshipStatusMeaning: string
Title:
Citizenship Status
Read Only:true
Maximum Length:80
Meaning of the contact's citizenship status code. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the contact citizenship record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the contact citizenship record was created. -
FromDate: string
(date)
Title:
From Date
Date from when the contact citizenship is valid. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the contact citizenship record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the contact citizenship record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ToDate: string
(date)
Title:
To Date
Date until when the contact citizenship is valid.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hcmContacts-citizenships-citizenshipsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__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
- hcmContactsUniqID:
$request.path.hcmContactsUniqID
- CitizenshipId: