Jump to

• Request
• Response
• Examples

Create a worker ethnicity

post

/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities

Request

Path Parameters

• workersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Workers resource and used to uniquely identify an instance of Workers. The client should not generate the hash key value. Instead, the client should query on the Workers collection resource in order to navigate to a specific instance of Workers 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

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 of a worker as of the specified date. By default, the current date is retained.
• Ethnicity: string
  Title: Ethnicity

  Maximum Length: 30

  Person's ethnicity. 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 person.

{
    "required":[
        "LegislationCode"
    ],
    "type":"object",
    "properties":{
        "Ethnicity":{
            "title":"Ethnicity",
            "maxLength":30,
            "type":"string",
            "description":"Person's ethnicity. 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 of a worker as of the specified date. By default, the current date is retained.",
            "items":{
                "$ref":"#/components/schemas/workers-ethnicities-ethnicitiesDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "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
            }
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the ethnicity is the primary ethnicity record for the person.",
            "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 of a worker as of the specified date. By default, the current date is retained.

Show Source

• Array of: object schema

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

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

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

  Descriptive flexfield for ethnicity.

{
    "type":"object",
    "properties":{
        "EthnicityId":{
            "title":"Ethnicity ID",
            "type":"integer",
            "description":"Descriptive flexfield for ethnicity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield for 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 : workers-ethnicities-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• ethnicitiesDFF: array ethnicitiesDFF
• Ethnicity: string
  Title: Ethnicity

  Maximum Length: 30

  Person's ethnicity. Valid values are defined in the commonLookupsLOV.
• EthnicityId: integer (int64)
  Title: Ethnicity ID

  Read Only: true
• EthnicityMeaning: string
  Title: Ethnicity

  Read Only: true

  Maximum Length: 80
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64
• 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
• 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 person.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Ethnicity":{
            "title":"Ethnicity",
            "maxLength":30,
            "type":"string",
            "description":"Person's ethnicity. Valid values are defined in the commonLookupsLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "LegislationCode"
                ]
            },
            "x-queryable":true
        },
        "ethnicitiesDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workers-ethnicities-ethnicitiesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "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 person.",
            "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",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EthnicityId":{
            "title":"Ethnicity ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LegislationName":{
            "title":"Country",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : ethnicitiesDFF

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workers-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 : workers-ethnicities-ethnicitiesDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

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

  Descriptive flexfield for 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 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 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/workers/{workersUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF

Parameters:

• EthnicityId: $request.path.EthnicityId
• workersUniqID: $request.path.workersUniqID

The ethnicitiesDFF resource is a child of the ethnicities resource. It provides all the ethnicity descriptive flexfields of a worker 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 common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility.

legislationCodesLov

Operation: /hcmRestApi/resources/11.13.18.05/hcmCountriesLov

The hcmCountriesLov resource includes the list of values for countries.

Back to Top

Examples

The following example shows how to create a worker ethnicity by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -X POST -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED0005770800005AF3116303090000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016ABDF0400078/child/ethnicities/300100188720764"

Example of Payload

The following is an example of the payload.

{
"Ethnicity": "7"
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 201 Created
Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "EthnicityId": 300100188720764,
  "PrimaryFlag": true,
  "LegislationCode": "US",
  "Ethnicity": "7",
  "CreatedBy": "VMOSS",
  "CreationDate": "2019-05-16T13:32:25+00:00",
  "LastUpdatedBy": "VMOSS",
  "LastUpdateDate": "2019-05-16T13:45:34+00:00",
  "links": [
     {...
        }
  ]
}

Back to Top