Update a religion
patch
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}
Request
Path Parameters
-
ReligionId(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=
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
PrimaryFlag: boolean
Title:
Primary
Maximum Length:30
Default Value:true
Indicates whether the religion is the contact's primary religion for this legislation. -
Religion: string
Title:
Religion
Maximum Length:30
Religion of the contact. Valid values are defined in the commonLookupsLOV. -
religionsDFF: array
religionsDFF
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__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:
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-religions-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the contact's religion information. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the contact's religion information was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the contact's religion information was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the contact's religion information. -
LegislationCode: string
Title:
Country
Maximum Length:30
Legislation code of the contact's religion. 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 religion is the contact's primary religion for this legislation. -
Religion: string
Title:
Religion
Maximum Length:30
Religion of the contact. Valid values are defined in the commonLookupsLOV. -
ReligionId: integer
(int64)
Title:
Religion ID
Read Only:true
Surrogate identifier for the contact's religion. -
ReligionMeaning: string
Title:
Religion
Read Only:true
Maximum Length:80
Meaning of the contact's religion code. -
religionsDFF: array
religionsDFF
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.
Nested Schema : hcmContacts-religions-religionsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReligionId: integer
(int64)
Title:
Religion ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- legislationCodesLov
-
The following properties are defined on the LOV link relation:
- Source Attribute: LegislationCode; Target Attribute: TerritoryCode
- Display Attribute: TerritoryCode, CountryName
- religionsDFF
-
Parameters:
- ReligionId:
$request.path.ReligionId
- hcmContactsUniqID:
$request.path.hcmContactsUniqID
- ReligionId:
- religionsLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{Religion}%2CLookupType%3DPER_RELIGION%2CLegislationCode%3D{LegislationCode}
The following properties are defined on the LOV link relation:- Source Attribute: Religion; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: