Jump to

• Request
• Response

Update an ethnicity

patch

/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}

Request

Path Parameters

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

• ethnicitiesDFF: array Ethnicity Descriptive Flexfields
  Title: Ethnicity Descriptive Flexfields

  The ethnicitiesDFF resource is a child of the ethnicities resource. It provides all the ethnicity descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
• Ethnicity: string
  Title: Ethnicity

  Maximum Length: 30

  Ethnicity of the contact. Valid values are defined in the commonLookupsLOV.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 30

  Default Value: true

  Indicates whether the ethnicity is the primary ethnicity record for the contact.

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

Nested Schema : Ethnicity Descriptive Flexfields

Type: array

Title: Ethnicity Descriptive Flexfields

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

Show Source

• Array of: object hcmContacts-ethnicities-ethnicitiesDFF-item-patch-request

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

Nested Schema : hcmContacts-ethnicities-ethnicitiesDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield for contact's ethnicity.
• __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 ethnicity.",
            "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-ethnicities-item-response

Type: object

Show Source

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

  The ethnicitiesDFF resource is a child of the ethnicities resource. It provides all the ethnicity descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the contact's ethnicity record.",
            "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 ethnicity record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Ethnicity":{
            "title":"Ethnicity",
            "maxLength":30,
            "type":"string",
            "description":"Ethnicity of the contact. Valid values are defined in the commonLookupsLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "LegislationCode"
                ]
            },
            "x-queryable":true
        },
        "ethnicitiesDFF":{
            "title":"Ethnicity Descriptive Flexfields",
            "type":"array",
            "description":"The ethnicitiesDFF resource is a child of the ethnicities resource. It provides all the ethnicity descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.",
            "items":{
                "$ref":"#/components/schemas/hcmContacts-ethnicities-ethnicitiesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the contact's ethnicity record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LegislationCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"Legislation code of the ethnicity. 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 ethnicity is the primary ethnicity record for the contact.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EthnicityMeaning":{
            "title":"Ethnicity",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the contact's ethnicity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EthnicityId":{
            "title":"Ethnicity ID",
            "type":"integer",
            "description":"Surrogate identifier for the contact's ethnicity.",
            "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 ethnicity record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : Ethnicity Descriptive Flexfields

Type: array

Title: Ethnicity Descriptive Flexfields

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

Show Source

• Array of: object hcmContacts-ethnicities-ethnicitiesDFF-item-response

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

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 : hcmContacts-ethnicities-ethnicitiesDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield for contact's ethnicity.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• EthnicityId: integer (int64)
  Title: Ethnicity ID

  Descriptive flexfield for contact's ethnicity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EthnicityId":{
            "title":"Ethnicity ID",
            "type":"integer",
            "description":"Descriptive flexfield for contact's ethnicity.",
            "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 ethnicity.",
            "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"
    }
}

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."
        }
    }
}

Links

ethnicitiesDFF

Operation: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF

Parameters:

• EthnicityId: $request.path.EthnicityId
• hcmContactsUniqID: $request.path.hcmContactsUniqID

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

ethnicitiesLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

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

Back to Top