1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Workers
  4. Passports

Create a worker passport

post

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

Request

Path Parameters
  • 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
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : passportsDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFAEVO-item-post-request", "IN":"#/components/schemas/oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFINVO-item-post-request", "KW":"#/components/schemas/oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFKWVO-item-post-request" } }
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFAEVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFINVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFKWVO-item-post-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-passports-item-response
Type: object
Show Source
Nested Schema : passportsDDF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFAEVO-item-response", "IN":"#/components/schemas/oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFINVO-item-response", "KW":"#/components/schemas/oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFKWVO-item-response" } }
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFAEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFINVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFKWVO-item-response
Type: object
Show Source
Links
issuingCountriesLov
The hcmCountriesLov resource includes the list of values for countries.
passportTypesLov
Parameters:
  • finder: LegislationCodeFinder%3BLookupCode%3D{PassportType}%2CLookupType%3DPER_PASSPORT_TYPE%2CLegislationCode%3D{IssuingCountry}
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.
passportsDDF
Parameters:
  • PassportId: $request.path.PassportId
  • workersUniqID: $request.path.workersUniqID
Back to Top

Examples

The following example shows how to create a worker passport 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/passports"

Example of Payload

The following is an example of the payload.

{
 "IssuingCountry" : "US"
}

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.

{
    "PassportId": 300100187109795,
    "IssuingCountry": "US",
    "PassportType": null,
    "PassportNumber": null,
    "IssuingAuthority": null,
    "IssueDate": null,
    "ExpirationDate": null,
    "IssuingLocation": null,
    "Profession": null,
    "CreatedBy": "VMOSS",
    "CreationDate": "2019-05-16T12:36:30+00:00",
    "LastUpdatedBy": "VMOSS",
    "LastUpdateDate": "2019-05-16T12:36:30.577+00:00",
    "links": [
        {...
           }
   ]
}
Back to Top