Jump to

• Request
• Response

Update a religion

patch

/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}

Request

Path Parameters

• ReligionId(required): integer(int64)
  Surrogate identifier for the contact's religion.
• 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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 Religion Descriptive Flexfields
  Title: Religion Descriptive Flexfields

  The religionsDFF resource is a child of the contacts resource. It provides all the religion descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.

{
    "type":"object",
    "properties":{
        "Religion":{
            "title":"Religion",
            "maxLength":30,
            "type":"string",
            "description":"Religion of the contact. Valid values are defined in the commonLookupsLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "LegislationCode"
                ]
            }
        },
        "religionsDFF":{
            "title":"Religion Descriptive Flexfields",
            "type":"array",
            "description":"The religionsDFF resource is a child of the contacts resource. It provides all the religion descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.",
            "items":{
                "$ref":"#/components/schemas/hcmContacts-religions-religionsDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the religion is the contact's primary religion for this legislation.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : Religion Descriptive Flexfields

Type: array

Title: Religion Descriptive Flexfields

The religionsDFF resource is a child of the contacts resource. It provides all the religion descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.

Show Source

• Array of: object schema

{
    "title":"Religion Descriptive Flexfields",
    "type":"array",
    "description":"The religionsDFF resource is a child of the contacts resource. It provides all the religion descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.",
    "items":{
        "$ref":"#/components/schemas/hcmContacts-religions-religionsDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield for contact's religions.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield for contact's religions.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : hcmContacts-religions-item-response

Type: object

Show Source

• 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 religiion. 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 Religion Descriptive Flexfields
  Title: Religion Descriptive Flexfields

  The religionsDFF resource is a child of the contacts resource. It provides all the religion descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the contact's religion information.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the contact's religion information was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the contact's religion information.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LegislationCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"Legislation code of the contact's religiion. Valid values are defined in the hcmCountriesLov.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the religion is the contact's primary religion for this legislation.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Religion":{
            "title":"Religion",
            "maxLength":30,
            "type":"string",
            "description":"Religion of the contact. Valid values are defined in the commonLookupsLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "LegislationCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "religionsDFF":{
            "title":"Religion Descriptive Flexfields",
            "type":"array",
            "description":"The religionsDFF resource is a child of the contacts resource. It provides all the religion descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.",
            "items":{
                "$ref":"#/components/schemas/hcmContacts-religions-religionsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ReligionMeaning":{
            "title":"Religion",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the contact's religion code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReligionId":{
            "title":"Religion ID",
            "type":"integer",
            "description":"Surrogate identifier for the contact's religion.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LegislationName":{
            "title":"Country",
            "maxLength":80,
            "type":"string",
            "description":"Name of the contact's legislation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the contact's religion information was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Religion Descriptive Flexfields

Type: array

Title: Religion Descriptive Flexfields

The religionsDFF resource is a child of the contacts resource. It provides all the religion descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.

Show Source

• Array of: object hcmContacts-religions-religionsDFF-item-response

{
    "title":"Religion Descriptive Flexfields",
    "type":"array",
    "description":"The religionsDFF resource is a child of the contacts resource. It provides all the religion descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.",
    "items":{
        "$ref":"#/components/schemas/hcmContacts-religions-religionsDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : hcmContacts-religions-religionsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield for contact's religions.
• __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

  Descriptive flexfield for contact's religions.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReligionId":{
            "title":"Religion ID",
            "type":"integer",
            "description":"Descriptive flexfield for contact's religions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield for contact's religions.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

legislationCodesLov

Operation: /hcmRestApi/resources/11.13.18.05/hcmCountriesLov

The following properties are defined on the LOV link relation:

• Source Attribute: LegislationCode; Target Attribute: TerritoryCode
• Display Attribute: TerritoryCode, CountryName

religionsDFF

Operation: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}/child/religionsDFF

Parameters:

• ReligionId: $request.path.ReligionId
• hcmContactsUniqID: $request.path.hcmContactsUniqID

The religionsDFF resource is a child of the contacts resource. It provides all the religion descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.

religionsLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

Back to Top