Jump to

• Request
• Response
• Examples

Update a worker external identifier

patch

/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/externalIdentifiers/{ExternalIdentifierId}

Request

Path Parameters

• ExternalIdentifierId(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:
  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

• AssignmentId: integer (int64)
  Title: Assignment ID

  Unique identifier of the assignment to which this external identifier relates.
• AssignmentNumber: string
  Title: Assignment Number

  Maximum Length: 30

  Assignment number to which the external identifier belongs.
• Comments: string
  Title: Identifier Comments

  Maximum Length: 2048

  Comments for the external identifier.
• ExternalIdentifierNumber: string
  Title: Identifier

  Maximum Length: 256

  External identifier number.
• ExternalIdentifierType: string
  Title: Identifier Type

  Maximum Length: 30

  Type of external identifier, such as Third-Party Payroll ID. Valid values are defined in the commonLookupsLOV.
• FromDate: string (date-time)
  Title: From Date

  Date and time from when the external identifier is valid.
• ToDate: string (date-time)
  Title: To Date

  Date and time until when the external identifier is valid.

{
    "type":"object",
    "properties":{
        "ExternalIdentifierNumber":{
            "title":"Identifier",
            "maxLength":"256",
            "type":"string",
            "description":"External identifier number.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Comments":{
            "title":"Identifier Comments",
            "maxLength":"2048",
            "type":"string",
            "description":"Comments for the external identifier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the assignment to which this external identifier relates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":"30",
            "type":"string",
            "description":"Assignment number to which the external identifier belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date and time from when the external identifier is valid.",
            "format":"date-time",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"Date and time until when the external identifier is valid.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ExternalIdentifierType":{
            "title":"Identifier Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of external identifier, such as Third-Party Payroll ID. Valid values are defined in the commonLookupsLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        }
    }
}

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-externalIdentifiers-item-response

Type: object

Show Source

• AssignmentId: integer (int64)
  Title: Assignment ID

  Unique identifier of the assignment to which this external identifier relates.
• AssignmentName: string
  Title: Assignment Name

  Read Only: true

  Maximum Length: 80

  Name of the person's assignment.
• AssignmentNumber: string
  Title: Assignment Number

  Maximum Length: 30

  Assignment number to which the external identifier belongs.
• Comments: string
  Title: Identifier Comments

  Maximum Length: 2048

  Comments for the external identifier.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Date and time when the external identifier was created.
• ExternalIdentifierId: integer (int64)
  Title: External Identifier ID

  Read Only: true

  Surrogate identifier for the external identifier.
• ExternalIdentifierNumber: string
  Title: Identifier

  Maximum Length: 256

  External identifier number.
• ExternalIdentifierSequence: integer (int32)
  Title: Sequence

  Sequence of the external identifier.
• ExternalIdentifierType: string
  Title: Identifier Type

  Maximum Length: 30

  Type of external identifier, such as Third-Party Payroll ID. Valid values are defined in the commonLookupsLOV.
• ExternalIdentifierTypeMeaning: string
  Title: Identifier Type

  Read Only: true

  Maximum Length: 80

  Meaning of the person's external identifier.
• FromDate: string (date-time)
  Title: From Date

  Date and time from when the external identifier is valid.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  User who last updated the external identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ToDate: string (date-time)
  Title: To Date

  Date and time until when the external identifier is valid.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the external identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the external identifier 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 external identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ExternalIdentifierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"Sequence of the external identifier.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"4"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Identifier Comments",
            "maxLength":"2048",
            "type":"string",
            "description":"Comments for the external identifier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ExternalIdentifierTypeMeaning":{
            "title":"Identifier Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the person's external identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalIdentifierType":{
            "title":"Identifier Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of external identifier, such as Third-Party Payroll ID. Valid values are defined in the commonLookupsLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ExternalIdentifierId":{
            "title":"External Identifier ID",
            "type":"integer",
            "description":"Surrogate identifier for the external identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentName":{
            "title":"Assignment Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the person's assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalIdentifierNumber":{
            "title":"Identifier",
            "maxLength":"256",
            "type":"string",
            "description":"External identifier number.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the assignment to which this external identifier relates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":"30",
            "type":"string",
            "description":"Assignment number to which the external identifier belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date and time from when the external identifier is valid.",
            "format":"date-time",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"Date and time until when the external identifier is valid.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the external identifier 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 : 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

externalIdentifierTypesLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_PER_EXT_IDENTIFIER_TYPES

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.

Back to Top

Examples

The following example shows how to update a worker external 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/externalIdentifiers/300100188720811"

Example of Payload

The following is an example of the payload.

{
"Comments": "External identifier for the employee."
}

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.

{
    "ExternalIdentifierId": 300100188720811,
    "ExternalIdentifierSequence": 1,
    "ExternalIdentifierNumber": "A{{xs}}",
    "ExternalIdentifierType": "ORA_3RD_PARTY_PAY_ADD_ID",
    "AssignmentId": null,
    "FromDate": "2019-01-01T00:00:00+00:00",
    "ToDate": null,
    "Comments": "External identifier for the employee.",
    "CreatedBy": "VMOSS",
    "CreationDate": "2019-05-16T13:57:36+00:00",
    "LastUpdatedBy": "VMOSS",
    "LastUpdateDate": "2019-05-16T14:05:21+00:00",
    "AssignmentNumber": null,
    "links": [
        {...
           }
   ]
}

Back to Top