Jump to

• Request
• Response
• Examples

Update a worker national identifier

patch

/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}

Request

Path Parameters

• NationalIdentifierId(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=
• 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: string
  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: string
  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

• ExpirationDate: string (date)
  Title: Expiration Date

  Expiration date of the national identifier.
• IssueDate: string (date)
  Title: Issue Date

  Issue date of the national identifier.
• NationalIdentifierNumber: string
  Title: National ID

  Maximum Length: 30

  National identification number.
• nationalIdentifiersDFF: array nationalIdentifiersDFF
• NationalIdentifierType: string
  Title: National ID Type

  Maximum Length: 30

  Type of national identifier. Valid values are defined in the commonLookupsLOV.
• PlaceOfIssue: string
  Title: Place of Issue

  Maximum Length: 30

  Place where the national identifier was issued.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 255

  Indicates whether the national identifier is the person's primary national identifier.

{
    "type":"object",
    "properties":{
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the national identifier.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"Issue date of the national identifier.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "NationalIdentifierNumber":{
            "title":"National ID",
            "maxLength":30,
            "type":"string",
            "description":"National identification number.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "NationalIdentifierType":{
            "title":"National ID Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of national identifier. Valid values are defined in the commonLookupsLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "LegislationCode"
                ]
            }
        },
        "PlaceOfIssue":{
            "title":"Place of Issue",
            "maxLength":30,
            "type":"string",
            "description":"Place where the national identifier was issued.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the national identifier is the person's primary national identifier.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "nationalIdentifiersDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workers-nationalIdentifiers-nationalIdentifiersDFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : nationalIdentifiersDFF

Type: array

Show Source

• Array of: object workers-nationalIdentifiers-nationalIdentifiersDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workers-nationalIdentifiers-nationalIdentifiersDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : workers-nationalIdentifiers-nationalIdentifiersDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value

{
    "type":"object",
    "properties":{
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "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"
                }
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : workers-nationalIdentifiers-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the national identifier record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the national identifier record was created.
• ExpirationDate: string (date)
  Title: Expiration Date

  Expiration date of the national identifier.
• IssueDate: string (date)
  Title: Issue Date

  Issue date of the national identifier.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time when the national identifier record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the national identifier record.
• LegislationCode: string
  Title: Country

  Maximum Length: 30

  Legislation code of the national identifier. Valid values are defined in the hcmCountriesLov.
• LegislationName: string
  Title: Country

  Read Only: true

  Maximum Length: 80

  Name of the person's legislation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NationalIdentifierId: integer (int64)
  Title: National Identifier ID

  Read Only: true

  Surrogate identifier for the national identifier record.
• NationalIdentifierNumber: string
  Title: National ID

  Maximum Length: 30

  National identification number.
• nationalIdentifiersDFF: array nationalIdentifiersDFF
• NationalIdentifierType: string
  Title: National ID Type

  Maximum Length: 30

  Type of national identifier. Valid values are defined in the commonLookupsLOV.
• NationalIdentifierTypeMeaning: string
  Title: National ID Type

  Read Only: true

  Maximum Length: 80

  Meaning of the person's national identifier type.
• PlaceOfIssue: string
  Title: Place of Issue

  Maximum Length: 30

  Place where the national identifier was issued.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 255

  Indicates whether the national identifier is the person's primary national identifier.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the national identifier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the national identifier record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the national identifier.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"Issue date of the national identifier.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the national identifier record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the national identifier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LegislationCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"Legislation code of the national identifier. Valid values are defined in the hcmCountriesLov.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LegislationName":{
            "title":"Country",
            "maxLength":80,
            "type":"string",
            "description":"Name of the person's legislation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NationalIdentifierId":{
            "title":"National Identifier ID",
            "type":"integer",
            "description":"Surrogate identifier for the national identifier record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "NationalIdentifierNumber":{
            "title":"National ID",
            "maxLength":30,
            "type":"string",
            "description":"National identification number.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "NationalIdentifierType":{
            "title":"National ID Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of national identifier. Valid values are defined in the commonLookupsLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "LegislationCode"
                ]
            },
            "x-queryable":true
        },
        "NationalIdentifierTypeMeaning":{
            "title":"National ID Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the person's national identifier type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlaceOfIssue":{
            "title":"Place of Issue",
            "maxLength":30,
            "type":"string",
            "description":"Place where the national identifier was issued.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the national identifier is the person's primary national identifier.",
            "nullable":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"
            }
        },
        "nationalIdentifiersDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workers-nationalIdentifiers-nationalIdentifiersDFF-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 : nationalIdentifiersDFF

Type: array

Show Source

• Array of: object workers-nationalIdentifiers-nationalIdentifiersDFF-item-response

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

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NationalIdentifierId: integer (int64)
  Title: National Identifier ID

{
    "type":"object",
    "properties":{
        "NationalIdentifierId":{
            "title":"National Identifier ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

nationalIdentifierTypesLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LegislationCodeFinder%3BLookupCode%3D{NationalIdentifierType}%2CLookupType%3DPER_NATIONAL_IDENTIFIER_TYPE%2CLegislationCode%3D{LegislationCode}

The following properties are defined on the LOV link relation:

• Source Attribute: NationalIdentifierType; Target Attribute: LookupCode
• Display Attribute: Meaning

nationalIdentifiersDFF

Operation: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF

Parameters:

• NationalIdentifierId: $request.path.NationalIdentifierId
• workersUniqID: $request.path.workersUniqID

Back to Top

Examples

The following example shows how to update a worker national identifier by submitting a PATCH 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 PATCH -d <payload>"https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers//00020000000EACED0005770800005AF3116303090000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016ABDF0400078/child/nationalIdentifiers/300100188720867"

Example of Payload

The following is an example of the payload.

{
"PlaceOfIssue": "Santa Clara"
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
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.

{
    "NationalIdentifierId": 300100188720867,
    "LegislationCode": "US",
    "NationalIdentifierType": "ORA_TIN",
    "NationalIdentifierNumber": "123456789",
    "IssueDate": null,
    "ExpirationDate": null,
    "PlaceOfIssue": "Santa Clara",
    "CreatedBy": "VMOSS",
    "CreationDate": "2019-05-16T16:52:21+00:00",
    "LastUpdatedBy": "VMOSS",
    "LastUpdateDate": "2019-05-16T17:05:29+00:00",
    "PrimaryFlag": true,
    "links": [
        {...
           }
   ]
}

Back to Top