Update a passport
patch
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}
Request
Path Parameters
-
PassportId(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=
-
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
Root Schema : schema
Type:
Show Source
object
-
ExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the contact's passport. -
IssueDate: string
(date)
Title:
Issue Date
Issue date of the contact's passport. -
IssuingAuthority: string
Title:
Issuing Authority
Maximum Length:100
Issuing authority for the contact's passport. -
IssuingLocation: string
Title:
Issuing Location
Maximum Length:100
Location where the contact's passport was issued. -
PassportNumber: string
Title:
Number
Maximum Length:30
Passport number of the contact. -
passportsDDF: array
passportsDDF
-
passportsDFF: array
passportsDFF
-
PassportType: string
Title:
Type
Maximum Length:30
Type or category of the contact's passport. Valid values are defined in the commonLookupsLOV. -
Profession: string
Title:
Profession
Maximum Length:30
Profession of the passport holder.
Nested Schema : passportsDDF
Type:
Show Source
array
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFAEVO-item-patch-request", "IN":"#/components/schemas/oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFINVO-item-patch-request", "KW":"#/components/schemas/oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFKWVO-item-patch-request" } }
Nested Schema : Discriminator: __FLEX_Context
Type:
object
Discriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
-
AE -
object
oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFAEVO-item-patch-request
-
IN -
object
oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFINVO-item-patch-request
-
KW -
object
oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFKWVO-item-patch-request
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFAEVO-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Passport Information Category
Maximum Length:30
Default Value:AE
-
__FLEX_Context_DisplayValue: string
Title:
Passport Information Category
-
_ACCOMPANYING_PERSONS: number
Title:
Number of Accompanying Persons
-
_ALTERNATE_ISSUE_PLACE: string
Title:
Place of Issue-Alternate Language
Maximum Length:150
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFINVO-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Passport Information Category
Maximum Length:30
Default Value:IN
-
__FLEX_Context_DisplayValue: string
Title:
Passport Information Category
-
_ECNR_REQUIRED: string
Title:
ECNR Required
Maximum Length:150
-
_NAME: string
Title:
Name as in Passport
Maximum Length:150
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFKWVO-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Passport Information Category
Maximum Length:30
Default Value:KW
-
__FLEX_Context_DisplayValue: string
Title:
Passport Information Category
-
_ACCOMPANY_PERSON: number
Title:
Number of Accompanying Persons
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
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.
Root Schema : hcmContacts-passports-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the contact's passport information. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the contact's passport information was created. -
ExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the contact's passport. -
IssueDate: string
(date)
Title:
Issue Date
Issue date of the contact's passport. -
IssuingAuthority: string
Title:
Issuing Authority
Maximum Length:100
Issuing authority for the contact's passport. -
IssuingCountry: string
Title:
Issuing Country
Maximum Length:30
Country in which the contact's passport was issued. Valid values are defined in the hcmCountriesLov. -
IssuingCountryName: string
Title:
Issuing Country
Read Only:true
Maximum Length:80
Name of the country issuing the contact's passport. -
IssuingLocation: string
Title:
Issuing Location
Maximum Length:100
Location where the contact's passport was issued. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the contact's passport information was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the contact's passport information. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PassportId: integer
(int64)
Title:
Passport ID
Read Only:true
Surrogate identifier for the contact's passport. -
PassportNumber: string
Title:
Number
Maximum Length:30
Passport number of the contact. -
passportsDDF: array
passportsDDF
-
passportsDFF: array
passportsDFF
-
PassportType: string
Title:
Type
Maximum Length:30
Type or category of the contact's passport. Valid values are defined in the commonLookupsLOV. -
PassportTypeMeaning: string
Title:
Type
Read Only:true
Maximum Length:80
Meaning of the contact's passport type. -
Profession: string
Title:
Profession
Maximum Length:30
Profession of the passport holder.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : passportsDDF
Type:
Show Source
array
-
Array of:
object 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 : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : Discriminator: __FLEX_Context
Type:
object
Discriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
-
AE -
object
oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFAEVO-item-response
-
IN -
object
oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFINVO-item-response
-
KW -
object
oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFKWVO-item-response
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFAEVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Passport Information Category
Maximum Length:30
Default Value:AE
-
__FLEX_Context_DisplayValue: string
Title:
Passport Information Category
-
_ACCOMPANYING_PERSONS: number
Title:
Number of Accompanying Persons
-
_ALTERNATE_ISSUE_PLACE: string
Title:
Place of Issue-Alternate Language
Maximum Length:150
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PassportId: integer
(int64)
Title:
Passport ID
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFINVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Passport Information Category
Maximum Length:30
Default Value:IN
-
__FLEX_Context_DisplayValue: string
Title:
Passport Information Category
-
_ECNR_REQUIRED: string
Title:
ECNR Required
Maximum Length:150
-
_NAME: string
Title:
Name as in Passport
Maximum Length:150
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PassportId: integer
(int64)
Title:
Passport ID
Nested Schema : oracle_apps_hcm_people_core_flex_personPassportLegDDF_view_PersonPassportLegDDFKWVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Passport Information Category
Maximum Length:30
Default Value:KW
-
__FLEX_Context_DisplayValue: string
Title:
Passport Information Category
-
_ACCOMPANY_PERSON: number
Title:
Number of Accompanying Persons
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PassportId: integer
(int64)
Title:
Passport ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hcmContacts-passports-passportsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PassportId: integer
(int64)
Title:
Passport ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- issuingCountriesLov
-
The following properties are defined on the LOV link relation:
- Source Attribute: IssuingCountry; Target Attribute: TerritoryCode
- Display Attribute: TerritoryCode, CountryName
- passportTypesLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{PassportType}%2CLookupType%3DPER_PASSPORT_TYPE%2CLegislationCode%3D{IssuingCountry}
The following properties are defined on the LOV link relation:- Source Attribute: PassportType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- passportsDDF
-
Parameters:
- PassportId:
$request.path.PassportId
- hcmContactsUniqID:
$request.path.hcmContactsUniqID
- PassportId:
- passportsDFF
-
Parameters:
- PassportId:
$request.path.PassportId
- hcmContactsUniqID:
$request.path.hcmContactsUniqID
- PassportId: