Create an ethnicity
post
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities
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
-
ethnicitiesDFF: array
ethnicitiesDFF
-
Ethnicity: string
Title:
Ethnicity
Maximum Length:30
Ethnicity of the contact. Valid values are defined in the commonLookupsLOV. -
LegislationCode(required): string
Title:
Country
Maximum Length:30
Legislation code of the ethnicity. Valid values are defined in the hcmCountriesLov. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:30
Default Value:true
Indicates whether the ethnicity is the primary ethnicity record for the contact.
Nested Schema : hcmContacts-ethnicities-ethnicitiesDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
EthnicityId: integer
(int64)
Title:
Ethnicity 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-ethnicities-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the contact's ethnicity record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the contact's ethnicity record was created. -
ethnicitiesDFF: array
ethnicitiesDFF
-
Ethnicity: string
Title:
Ethnicity
Maximum Length:30
Ethnicity of the contact. Valid values are defined in the commonLookupsLOV. -
EthnicityId: integer
(int64)
Title:
Ethnicity ID
Read Only:true
Surrogate identifier for the contact's ethnicity. -
EthnicityMeaning: string
Title:
Ethnicity
Read Only:true
Maximum Length:80
Meaning of the contact's ethnicity. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the contact's ethnicity record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the contact's ethnicity record. -
LegislationCode: string
Title:
Country
Maximum Length:30
Legislation code of the ethnicity. Valid values are defined in the hcmCountriesLov. -
LegislationName: string
Title:
Country
Read Only:true
Maximum Length:80
Name of the contact's legislation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:30
Default Value:true
Indicates whether the ethnicity is the primary ethnicity record for the contact.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hcmContacts-ethnicities-ethnicitiesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
EthnicityId: integer
(int64)
Title:
Ethnicity 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
- ethnicitiesDFF
-
Parameters:
- EthnicityId:
$request.path.EthnicityId
- hcmContactsUniqID:
$request.path.hcmContactsUniqID
- EthnicityId:
- ethnicitiesLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{Ethnicity}%2CLookupType%3DPER_ETHNICITY%2CLegislationCode%3D{LegislationCode}
The following properties are defined on the LOV link relation:- Source Attribute: Ethnicity; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- legislationCodesLov
-
The following properties are defined on the LOV link relation:
- Source Attribute: LegislationCode; Target Attribute: TerritoryCode
- Display Attribute: TerritoryCode, CountryName