Update a worker visa permit
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}
Request
-
visasPermitsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Visa Permits resource and used to uniquely identify an instance of Visa Permits. The client should not generate the hash key value. Instead, the client should query on the Visa Permits collection resource in order to navigate to a specific instance of Visa Permits to get the hash key.
-
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.
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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.
- application/json
object
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
EntryDate: string
(date)
Title:
Entry Date
Entry date of the person into the country. -
ExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the visa or permit. -
IssueDate: string
(date)
Title:
Issue Date
Date of issue of the visa or permit. -
IssuingAuthority: string
Title:
Issuing Authority
Maximum Length:100
Issuing authority for the visa or permit. -
IssuingLocation: string
Title:
Place of Issue
Maximum Length:100
Location where the visa or permit was issued. -
Profession: string
Title:
Profession
Maximum Length:30
Profession of the visa or permit holder. -
VisaPermitCategory: string
Title:
Category
Maximum Length:30
Category of the visa or permit. Valid values are defined in the commonLookupsLOV. -
VisaPermitNumber: string
Title:
Number
Maximum Length:30
Visa or permit number. -
VisaPermitStatus: string
Title:
Status
Maximum Length:30
Indicates if the visa or permit is current. Valid values are defined in the commonLookupsLOV. -
VisaPermitType: string
Title:
Type
Maximum Length:30
Visa or permit type. Valid values are defined in the commonLookupsLOV. -
visasPermitsDDF: array
visasPermitsDDF
-
visasPermitsDFF: array
visasPermitsDFF
array
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFAEVO-item-patch-request", "CH":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFCHVO-item-patch-request", "KW":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFKWVO-item-patch-request", "ORA_HRX_BH":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FBHVO-item-patch-request", "ORA_HRX_OM":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FOMVO-item-patch-request", "ORA_HRX_QA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FQAVO-item-patch-request", "SA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSAVO-item-patch-request", "SG":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSGVO-item-patch-request" } }
object
Discriminator Values
-
AE -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFAEVO-item-patch-request
-
CH -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFCHVO-item-patch-request
-
KW -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFKWVO-item-patch-request
-
ORA_HRX_BH -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FBHVO-item-patch-request
-
ORA_HRX_OM -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FOMVO-item-patch-request
-
ORA_HRX_QA -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FQAVO-item-patch-request
-
SA -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSAVO-item-patch-request
-
SG -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSGVO-item-patch-request
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:AE
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
_EMIRATE: string
Title:
Emirate
Maximum Length:150
-
_PREVIOUS_OCCUPATION: string
Title:
Previous Occupation
Maximum Length:150
-
_PREVIOUS_OCCUPATION_Display: string
Title:
Previous Occupation
-
_SPONSOR_NAME: string
Title:
Sponsor Name
Maximum Length:150
-
_SPONSOR_NATIONALITY: string
Title:
Sponsor Nationality
Maximum Length:150
-
_SPONSOR_NATIONALITY_Display: string
Title:
Sponsor Nationality
-
_SPONSOR_NUMBER: string
Title:
Sponsor Number
Maximum Length:150
-
_SPONSOR_RELATIONSHIP: string
Title:
Sponsor Relationship
Maximum Length:150
-
_SPONSOR_RELATIONSHIP_Display: string
Title:
Sponsor Relationship
-
_SPONSOR_TYPE: string
Title:
Sponsor Type
Maximum Length:150
-
_SPONSOR_TYPE_Display: string
Title:
Sponsor Type
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:CH
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
_CROSS_BORDER_FREQUENCY: number
Title:
Cross Border Frequency
-
_CROSS_BORDER_FREQUENCY_TYPE: string
Title:
Cross Border Frequency Type
Maximum Length:150
-
_CROSS_BORDER_FREQUENCY_TYPE_Display: string
Title:
Cross Border Frequency Type
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:KW
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
_ACCOMPANY_PERSON: number
Title:
Number of Accompanying Persons
-
_SPONSOR_NAME: string
Title:
Sponsor Name
Maximum Length:150
-
_SPONSOR_NATIONALITY: string
Title:
Sponsor Nationality
Maximum Length:150
-
_SPONSOR_NATIONALITY_Display: string
Title:
Sponsor Nationality
-
_SPONSOR_NUMBER: number
Title:
Sponsor Number
-
_SPONSOR_RELATIONSHIP: string
Title:
Sponsor Relationship
Maximum Length:150
-
_SPONSOR_RELATIONSHIP_Display: string
Title:
Sponsor Relationship
-
_SPONSOR_TYPE: string
Title:
Sponsor Type
Maximum Length:150
-
_SPONSOR_TYPE_Display: string
Title:
Sponsor Type
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:ORA_HRX_BH
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
oraHrxBhJobDescriptions: string
Title:
Previous Occupation
Maximum Length:150
-
oraHrxBhJobDescriptions_Display: string
Title:
Previous Occupation
-
oraHrxBhSponsorName: string
Title:
Sponsor Name
Maximum Length:150
-
oraHrxBhSponsorNtnlty: string
Title:
Sponsor Nationality
Maximum Length:150
-
oraHrxBhSponsorNtnlty_Display: string
Title:
Sponsor Nationality
-
oraHrxBhSponsorNumber: string
Title:
Sponsor Number
Maximum Length:150
-
oraHrxBhSponsorRelation: string
Title:
Sponsor Relationship
Maximum Length:150
-
oraHrxBhSponsorRelation_DisplayValue: string
Title:
Sponsor Relationship
-
oraHrxBhSponsorType: string
Title:
Sponsor Type
Maximum Length:150
-
oraHrxBhSponsorType_DisplayValue: string
Title:
Sponsor Type
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:ORA_HRX_OM
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
oraHrxOmJobDescriptions: string
Title:
Previous Occupation
Maximum Length:150
-
oraHrxOmJobDescriptions_Display: string
Title:
Previous Occupation
-
oraHrxOmSponsorName: string
Title:
Sponsor Name
Maximum Length:150
-
oraHrxOmSponsorNtnlty: string
Title:
Sponsor Nationality
Maximum Length:150
-
oraHrxOmSponsorNtnlty_Display: string
Title:
Sponsor Nationality
-
oraHrxOmSponsorNumber: string
Title:
Sponsor Number
Maximum Length:150
-
oraHrxOmSponsorRelation: string
Title:
Sponsor Relationship
Maximum Length:150
-
oraHrxOmSponsorRelation_DisplayValue: string
Title:
Sponsor Relationship
-
oraHrxOmSponsorType: string
Title:
Sponsor Type
Maximum Length:150
-
oraHrxOmSponsorType_DisplayValue: string
Title:
Sponsor Type
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:ORA_HRX_QA
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
oraHrxQaSponsorName: string
Title:
Sponsor Name
Maximum Length:150
-
oraHrxQaSponsorNtnlty: string
Title:
Sponsor Nationality
Maximum Length:150
-
oraHrxQaSponsorNtnlty_Display: string
Title:
Sponsor Nationality
-
oraHrxQaSponsorNum: number
Title:
Sponsor Number
-
oraHrxQaSponsorRltn: string
Title:
Sponsor Relationship
Maximum Length:150
-
oraHrxQaSponsorRltn_DisplayValue: string
Title:
Sponsor Relationship
-
oraHrxQaSponsorType: string
Title:
Sponsor Type
Maximum Length:150
-
oraHrxQaSponsorType_DisplayValue: string
Title:
Sponsor Type
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:SA
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
_HIJRAH_EXP_DATE: string
Title:
Hijri Expiration Date
Maximum Length:150
-
_HIJRAH_ISSUE_DATE: string
Title:
Hijri Issue Date
Maximum Length:150
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:SG
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
_CATEGORY: string
Title:
FWL Category
Maximum Length:150
-
_CATEGORY_Display: string
Title:
FWL Category
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Response
- application/json
Default Response
-
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.
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the visa information. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the visa information was created. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
EntryDate: string
(date)
Title:
Entry Date
Entry date of the person into the country. -
ExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the visa or permit. -
IssueDate: string
(date)
Title:
Issue Date
Date of issue of the visa or permit. -
IssuingAuthority: string
Title:
Issuing Authority
Maximum Length:100
Issuing authority for the visa or permit. -
IssuingCountry: string
Title:
Issuing Country
Maximum Length:30
Country in which the visa or permit 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 person's visa. -
IssuingLocation: string
Title:
Place of Issue
Maximum Length:100
Location where the visa or permit was issued. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the visa information was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the visa information. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Profession: string
Title:
Profession
Maximum Length:30
Profession of the visa or permit holder. -
VisaPermitCategory: string
Title:
Category
Maximum Length:30
Category of the visa or permit. Valid values are defined in the commonLookupsLOV. -
VisaPermitCategoryMeaning: string
Title:
Category
Read Only:true
Maximum Length:80
Meaning of the person's visa permit category. -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Read Only:true
Surrogate identifier for the visa or permit. -
VisaPermitNumber: string
Title:
Number
Maximum Length:30
Visa or permit number. -
VisaPermitStatus: string
Title:
Status
Maximum Length:30
Indicates if the visa or permit is current. Valid values are defined in the commonLookupsLOV. -
VisaPermitStatusDate: string
(date)
Title:
Status Change Date
Date from when the permit status is effective. -
VisaPermitStatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
Meaning of the person's visa permit status. -
VisaPermitType: string
Title:
Type
Maximum Length:30
Visa or permit type. Valid values are defined in the commonLookupsLOV. -
VisaPermitTypeMeaning: string
Title:
Type
Read Only:true
Maximum Length:80
Meaning of the person's visa permit type. -
visasPermitsDDF: array
visasPermitsDDF
-
visasPermitsDFF: array
visasPermitsDFF
array
Links
array
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFAEVO-item-response", "CH":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFCHVO-item-response", "KW":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFKWVO-item-response", "ORA_HRX_BH":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FBHVO-item-response", "ORA_HRX_OM":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FOMVO-item-response", "ORA_HRX_QA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FQAVO-item-response", "SA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSAVO-item-response", "SG":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSGVO-item-response" } }
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
Discriminator Values
-
AE -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFAEVO-item-response
-
CH -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFCHVO-item-response
-
KW -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFKWVO-item-response
-
ORA_HRX_BH -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FBHVO-item-response
-
ORA_HRX_OM -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FOMVO-item-response
-
ORA_HRX_QA -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FQAVO-item-response
-
SA -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSAVO-item-response
-
SG -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSGVO-item-response
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:AE
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
_EMIRATE: string
Title:
Emirate
Maximum Length:150
-
_PREVIOUS_OCCUPATION: string
Title:
Previous Occupation
Maximum Length:150
-
_PREVIOUS_OCCUPATION_Display: string
Title:
Previous Occupation
-
_SPONSOR_NAME: string
Title:
Sponsor Name
Maximum Length:150
-
_SPONSOR_NATIONALITY: string
Title:
Sponsor Nationality
Maximum Length:150
-
_SPONSOR_NATIONALITY_Display: string
Title:
Sponsor Nationality
-
_SPONSOR_NUMBER: string
Title:
Sponsor Number
Maximum Length:150
-
_SPONSOR_RELATIONSHIP: string
Title:
Sponsor Relationship
Maximum Length:150
-
_SPONSOR_RELATIONSHIP_Display: string
Title:
Sponsor Relationship
-
_SPONSOR_TYPE: string
Title:
Sponsor Type
Maximum Length:150
-
_SPONSOR_TYPE_Display: string
Title:
Sponsor Type
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:CH
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
_CROSS_BORDER_FREQUENCY: number
Title:
Cross Border Frequency
-
_CROSS_BORDER_FREQUENCY_TYPE: string
Title:
Cross Border Frequency Type
Maximum Length:150
-
_CROSS_BORDER_FREQUENCY_TYPE_Display: string
Title:
Cross Border Frequency Type
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:KW
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
_ACCOMPANY_PERSON: number
Title:
Number of Accompanying Persons
-
_SPONSOR_NAME: string
Title:
Sponsor Name
Maximum Length:150
-
_SPONSOR_NATIONALITY: string
Title:
Sponsor Nationality
Maximum Length:150
-
_SPONSOR_NATIONALITY_Display: string
Title:
Sponsor Nationality
-
_SPONSOR_NUMBER: number
Title:
Sponsor Number
-
_SPONSOR_RELATIONSHIP: string
Title:
Sponsor Relationship
Maximum Length:150
-
_SPONSOR_RELATIONSHIP_Display: string
Title:
Sponsor Relationship
-
_SPONSOR_TYPE: string
Title:
Sponsor Type
Maximum Length:150
-
_SPONSOR_TYPE_Display: string
Title:
Sponsor Type
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:ORA_HRX_BH
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
oraHrxBhJobDescriptions: string
Title:
Previous Occupation
Maximum Length:150
-
oraHrxBhJobDescriptions_Display: string
Title:
Previous Occupation
-
oraHrxBhSponsorName: string
Title:
Sponsor Name
Maximum Length:150
-
oraHrxBhSponsorNtnlty: string
Title:
Sponsor Nationality
Maximum Length:150
-
oraHrxBhSponsorNtnlty_Display: string
Title:
Sponsor Nationality
-
oraHrxBhSponsorNumber: string
Title:
Sponsor Number
Maximum Length:150
-
oraHrxBhSponsorRelation: string
Title:
Sponsor Relationship
Maximum Length:150
-
oraHrxBhSponsorRelation_DisplayValue: string
Title:
Sponsor Relationship
-
oraHrxBhSponsorType: string
Title:
Sponsor Type
Maximum Length:150
-
oraHrxBhSponsorType_DisplayValue: string
Title:
Sponsor Type
-
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:ORA_HRX_OM
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
oraHrxOmJobDescriptions: string
Title:
Previous Occupation
Maximum Length:150
-
oraHrxOmJobDescriptions_Display: string
Title:
Previous Occupation
-
oraHrxOmSponsorName: string
Title:
Sponsor Name
Maximum Length:150
-
oraHrxOmSponsorNtnlty: string
Title:
Sponsor Nationality
Maximum Length:150
-
oraHrxOmSponsorNtnlty_Display: string
Title:
Sponsor Nationality
-
oraHrxOmSponsorNumber: string
Title:
Sponsor Number
Maximum Length:150
-
oraHrxOmSponsorRelation: string
Title:
Sponsor Relationship
Maximum Length:150
-
oraHrxOmSponsorRelation_DisplayValue: string
Title:
Sponsor Relationship
-
oraHrxOmSponsorType: string
Title:
Sponsor Type
Maximum Length:150
-
oraHrxOmSponsorType_DisplayValue: string
Title:
Sponsor Type
-
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:ORA_HRX_QA
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
oraHrxQaSponsorName: string
Title:
Sponsor Name
Maximum Length:150
-
oraHrxQaSponsorNtnlty: string
Title:
Sponsor Nationality
Maximum Length:150
-
oraHrxQaSponsorNtnlty_Display: string
Title:
Sponsor Nationality
-
oraHrxQaSponsorNum: number
Title:
Sponsor Number
-
oraHrxQaSponsorRltn: string
Title:
Sponsor Relationship
Maximum Length:150
-
oraHrxQaSponsorRltn_DisplayValue: string
Title:
Sponsor Relationship
-
oraHrxQaSponsorType: string
Title:
Sponsor Type
Maximum Length:150
-
oraHrxQaSponsorType_DisplayValue: string
Title:
Sponsor Type
-
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:SA
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
_HIJRAH_EXP_DATE: string
Title:
Hijri Expiration Date
Maximum Length:150
-
_HIJRAH_ISSUE_DATE: string
Title:
Hijri Issue Date
Maximum Length:150
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
object
-
__FLEX_Context: string
Title:
Visa Information Category
Maximum Length:30
Default Value:SG
-
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category
-
_CATEGORY: string
Title:
FWL Category
Maximum Length:150
-
_CATEGORY_Display: string
Title:
FWL Category
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
array
Links
array
Links
array
Links
array
Links
array
Links
array
Links
array
Links
array
Links
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
array
Links
- issuingCountriesLov
-
The following properties are defined on the LOV link relation:
- Source Attribute: IssuingCountry; Target Attribute: TerritoryCode
- Display Attribute: TerritoryCode, CountryName
- visaPermitStatusLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{VisaPermitStatus}%2CLookupType%3DPER_VISA_PERMIT_STATUS%2CLegislationCode%3D{IssuingCountry}
The following properties are defined on the LOV link relation:- Source Attribute: VisaPermitStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- visaPermitTypesLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{VisaPermitType}%2CLookupType%3DPER_VISA_PERMIT_TYPE%2CLegislationCode%3D{IssuingCountry}
The following properties are defined on the LOV link relation:- Source Attribute: VisaPermitType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- visasPermitsDDF
-
Parameters:
- visasPermitsUniqID:
$request.path.visasPermitsUniqID
- workersUniqID:
$request.path.workersUniqID
- visasPermitsUniqID:
- visasPermitsDFF
-
Parameters:
- visasPermitsUniqID:
$request.path.visasPermitsUniqID
- workersUniqID:
$request.path.workersUniqID
- visasPermitsUniqID:
Examples
The following examples shows how to update a worker visa permit by submitting a PATCH request on the REST resource using cURL.
Correction
For a correction operation:
RangeMode
,RangeStartDate
, andRangeEndDate
are required parameters.RangeStartDate
the same as theEffectiveStartDate
of the record.RangeEndDate
must be the same as theEffectiveEndDate
of the record.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H 'REST-Framework-Version: 4' -H "Effective-Of: RangeMode=CORRECTION;RangeStartDate=2018-01-01;RangeEndDate=4712-12-31" -X PATCH -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED0005770800005AF3116303090000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000160AF04900078/child/visasPermits/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000160AF049000780000000EACED00057708000110F08509F3FE"
Example of Payload
The following is an example of the payload.
{ "VisaPermitStatus": "A" }
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.
{ "VisaPermitId": 300100186928126, "EffectiveStartDate": "2018-01-01", "EffectiveEndDate": "4712-12-31", "IssuingCountry": "US", "VisaPermitType": null, "VisaPermitCategory": null, "VisaPermitNumber": null, "VisaPermitStatus": "A", "IssuingAuthority": null, "IssuingLocation": null, "IssueDate": null, "EntryDate": null, "ExpirationDate": null, "VisaPermitStatusDate": null, "Profession": null, "CreatedBy": "VMOSS", "CreationDate": "2019-05-16T09:18:45+00:00", "LastUpdatedBy": "VMOSS", "LastUpdateDate": "2019-05-16T09:36:18+00:00", "links": [ {... } ] }
Update
For an update operation:
RangeMode
,RangeStartDate
, andRangeEndDate
are required parameters.RangeStartDate
must be betweenEffectiveStartDate
andEffectiveEndDate
of the record.RangeEndDate
must be the same as theEffectiveEndDate
of the record.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H 'REST-Framework-Version: 4' -H "Effective-Of: RangeMode=UPDATE;RangeStartDate=2018-01-01;RangeEndDate=4712-12-31" -X PATCH -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED0005770800005AF3116303090000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000160AF04900078/child/visasPermits/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000160AF049000780000000EACED00057708000110F08509F3FE"
Example of Payload
The following is an example of the payload.
{ "IssuingAuthority": "US CONSULT" }
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.
{ "VisaPermitId": 300100186928126, "EffectiveStartDate": "2018-01-01", "EffectiveEndDate": "4712-12-31", "IssuingCountry": "US", "VisaPermitType": null, "VisaPermitCategory": null, "VisaPermitNumber": null, "VisaPermitStatus": "A", "IssuingAuthority": "US CONSULT", "IssuingLocation": null, "IssueDate": null, "EntryDate": null, "ExpirationDate": null, "VisaPermitStatusDate": null, "Profession": null, "CreatedBy": "VMOSS", "CreationDate": "2019-05-16T09:18:45+00:00", "LastUpdatedBy": "VMOSS", "LastUpdateDate": "2019-05-16T09:36:18+00:00", "links": [ {... } ] }