Create a worker visa permit
post
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits
Request
Path Parameters
-
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
-
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.
-
Upsert-Mode:
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
- application/json
Root Schema : schema
Type:
Show Source
object-
EffectiveEndDate(required): string
(date)
Title:
Effective End DateEnd date of the date-effective changes to the record. -
EffectiveStartDate(required): string
(date)
Title:
Effective Start DateStart date of the date-effective changes to the record. -
EntryDate: string
(date)
Title:
Entry DateEntry date of the person into the country. -
ExpirationDate: string
(date)
Title:
Expiration DateExpiration date of the visa or permit. -
IssueDate: string
(date)
Title:
Issue DateDate of issue of the visa or permit. -
IssuingAuthority: string
Title:
Issuing AuthorityMaximum Length:100Issuing authority for the visa or permit. -
IssuingCountry(required): string
Title:
Issuing CountryMaximum Length:30Country in which the visa or permit was issued. Valid values are defined in the hcmCountriesLov. -
IssuingLocation: string
Title:
Place of IssueMaximum Length:100Location where the visa or permit was issued. -
Profession: string
Title:
ProfessionMaximum Length:30Profession of the visa or permit holder. -
VisaPermitCategory: string
Title:
CategoryMaximum Length:30Category of the visa or permit. Valid values are defined in the commonLookupsLOV. -
VisaPermitNumber: string
Title:
NumberMaximum Length:30Visa or permit number. -
VisaPermitStatus: string
Title:
StatusMaximum Length:30Indicates if the visa or permit is current. Valid values are defined in the commonLookupsLOV. -
VisaPermitStatusDate: string
(date)
Title:
Status Change DateDate from when the permit status is effective. -
VisaPermitType: string
Title:
TypeMaximum Length:30Visa or permit type. Valid values are defined in the commonLookupsLOV. -
visasPermitsDDF: array
visasPermitsDDF
-
visasPermitsDFF: array
visasPermitsDFF
Nested Schema : visasPermitsDDF
Type:
Show Source
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-post-request", "CH":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFCHVO-item-post-request", "KW":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFKWVO-item-post-request", "ORA_HRX_BH":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FBHVO-item-post-request", "ORA_HRX_OM":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FOMVO-item-post-request", "ORA_HRX_QA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FQAVO-item-post-request", "SA":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSAVO-item-post-request", "SG":"#/components/schemas/oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSGVO-item-post-request" } }
Nested Schema : Discriminator: __FLEX_Context
Type:
objectDiscriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
-
AE -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFAEVO-item-post-request
-
CH -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFCHVO-item-post-request
-
KW -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFKWVO-item-post-request
-
ORA_HRX_BH -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FBHVO-item-post-request
-
ORA_HRX_OM -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FOMVO-item-post-request
-
ORA_HRX_QA -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FQAVO-item-post-request
-
SA -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSAVO-item-post-request
-
SG -
object
oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSGVO-item-post-request
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFAEVO-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default Value:AE -
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category -
_EMIRATE: string
Title:
EmirateMaximum Length:150 -
_PREVIOUS_OCCUPATION: string
Title:
Previous OccupationMaximum Length:150 -
_PREVIOUS_OCCUPATION_Display: string
Title:
Previous Occupation -
_SPONSOR_NAME: string
Title:
Sponsor NameMaximum Length:150 -
_SPONSOR_NATIONALITY: string
Title:
Sponsor NationalityMaximum Length:150 -
_SPONSOR_NATIONALITY_Display: string
Title:
Sponsor Nationality -
_SPONSOR_NUMBER: string
Title:
Sponsor NumberMaximum Length:150 -
_SPONSOR_RELATIONSHIP: string
Title:
Sponsor RelationshipMaximum Length:150 -
_SPONSOR_RELATIONSHIP_Display: string
Title:
Sponsor Relationship -
_SPONSOR_TYPE: string
Title:
Sponsor TypeMaximum Length:150 -
_SPONSOR_TYPE_Display: string
Title:
Sponsor Type -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFCHVO-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default 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 TypeMaximum 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 -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFKWVO-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default Value:KW -
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category -
_ACCOMPANY_PERSON: number
Title:
Number of Accompanying Persons -
_SPONSOR_NAME: string
Title:
Sponsor NameMaximum Length:150 -
_SPONSOR_NATIONALITY: string
Title:
Sponsor NationalityMaximum Length:150 -
_SPONSOR_NATIONALITY_Display: string
Title:
Sponsor Nationality -
_SPONSOR_NUMBER: number
Title:
Sponsor Number -
_SPONSOR_RELATIONSHIP: string
Title:
Sponsor RelationshipMaximum Length:150 -
_SPONSOR_RELATIONSHIP_Display: string
Title:
Sponsor Relationship -
_SPONSOR_TYPE: string
Title:
Sponsor TypeMaximum Length:150 -
_SPONSOR_TYPE_Display: string
Title:
Sponsor Type -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FBHVO-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default 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 OccupationMaximum Length:150 -
oraHrxBhJobDescriptions_Display: string
Title:
Previous Occupation -
oraHrxBhSponsorName: string
Title:
Sponsor NameMaximum Length:150 -
oraHrxBhSponsorNtnlty: string
Title:
Sponsor NationalityMaximum Length:150 -
oraHrxBhSponsorNtnlty_Display: string
Title:
Sponsor Nationality -
oraHrxBhSponsorNumber: string
Title:
Sponsor NumberMaximum Length:150 -
oraHrxBhSponsorRelation: string
Title:
Sponsor RelationshipMaximum Length:150 -
oraHrxBhSponsorRelation_DisplayValue: string
Title:
Sponsor Relationship -
oraHrxBhSponsorType: string
Title:
Sponsor TypeMaximum Length:150 -
oraHrxBhSponsorType_DisplayValue: string
Title:
Sponsor Type -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FOMVO-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default 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 OccupationMaximum Length:150 -
oraHrxOmJobDescriptions_Display: string
Title:
Previous Occupation -
oraHrxOmSponsorName: string
Title:
Sponsor NameMaximum Length:150 -
oraHrxOmSponsorNtnlty: string
Title:
Sponsor NationalityMaximum Length:150 -
oraHrxOmSponsorNtnlty_Display: string
Title:
Sponsor Nationality -
oraHrxOmSponsorNumber: string
Title:
Sponsor NumberMaximum Length:150 -
oraHrxOmSponsorRelation: string
Title:
Sponsor RelationshipMaximum Length:150 -
oraHrxOmSponsorRelation_DisplayValue: string
Title:
Sponsor Relationship -
oraHrxOmSponsorType: string
Title:
Sponsor TypeMaximum Length:150 -
oraHrxOmSponsorType_DisplayValue: string
Title:
Sponsor Type -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FQAVO-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default 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 NameMaximum Length:150 -
oraHrxQaSponsorNtnlty: string
Title:
Sponsor NationalityMaximum Length:150 -
oraHrxQaSponsorNtnlty_Display: string
Title:
Sponsor Nationality -
oraHrxQaSponsorNum: number
Title:
Sponsor Number -
oraHrxQaSponsorRltn: string
Title:
Sponsor RelationshipMaximum Length:150 -
oraHrxQaSponsorRltn_DisplayValue: string
Title:
Sponsor Relationship -
oraHrxQaSponsorType: string
Title:
Sponsor TypeMaximum Length:150 -
oraHrxQaSponsorType_DisplayValue: string
Title:
Sponsor Type -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSAVO-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default Value:SA -
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category -
_HIJRAH_EXP_DATE: string
Title:
Hijri Expiration DateMaximum Length:150 -
_HIJRAH_ISSUE_DATE: string
Title:
Hijri Issue DateMaximum Length:150 -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSGVO-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default Value:SG -
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category -
_CATEGORY: string
Title:
FWL CategoryMaximum Length:150 -
_CATEGORY_Display: string
Title:
FWL Category -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30 -
__FLEX_Context_DisplayValue: string
Title:
Context Value -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
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 : workers-visasPermits-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the visa information. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the visa information was created. -
EffectiveEndDate: string
(date)
Title:
Effective End DateEnd date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start DateStart date of the date-effective changes to the record. -
EntryDate: string
(date)
Title:
Entry DateEntry date of the person into the country. -
ExpirationDate: string
(date)
Title:
Expiration DateExpiration date of the visa or permit. -
IssueDate: string
(date)
Title:
Issue DateDate of issue of the visa or permit. -
IssuingAuthority: string
Title:
Issuing AuthorityMaximum Length:100Issuing authority for the visa or permit. -
IssuingCountry: string
Title:
Issuing CountryMaximum Length:30Country in which the visa or permit was issued. Valid values are defined in the hcmCountriesLov. -
IssuingCountryName: string
Title:
Issuing CountryRead Only:trueMaximum Length:80Name of the country issuing the person's visa. -
IssuingLocation: string
Title:
Place of IssueMaximum Length:100Location where the visa or permit was issued. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate and time when the visa information was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the visa information. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Profession: string
Title:
ProfessionMaximum Length:30Profession of the visa or permit holder. -
VisaPermitCategory: string
Title:
CategoryMaximum Length:30Category of the visa or permit. Valid values are defined in the commonLookupsLOV. -
VisaPermitCategoryMeaning: string
Title:
CategoryRead Only:trueMaximum Length:80Meaning of the person's visa permit category. -
VisaPermitId: integer
(int64)
Title:
Visa Permit IDRead Only:trueSurrogate identifier for the visa or permit. -
VisaPermitNumber: string
Title:
NumberMaximum Length:30Visa or permit number. -
VisaPermitStatus: string
Title:
StatusMaximum Length:30Indicates if the visa or permit is current. Valid values are defined in the commonLookupsLOV. -
VisaPermitStatusDate: string
(date)
Title:
Status Change DateDate from when the permit status is effective. -
VisaPermitStatusMeaning: string
Title:
StatusRead Only:trueMaximum Length:80Meaning of the person's visa permit status. -
VisaPermitType: string
Title:
TypeMaximum Length:30Visa or permit type. Valid values are defined in the commonLookupsLOV. -
VisaPermitTypeMeaning: string
Title:
TypeRead Only:trueMaximum Length:80Meaning of the person's visa permit type. -
visasPermitsDDF: array
visasPermitsDDF
-
visasPermitsDFF: array
visasPermitsDFF
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : visasPermitsDDF
Type:
Show Source
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" } }
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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:
objectDiscriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
-
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
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFAEVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default Value:AE -
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category -
_EMIRATE: string
Title:
EmirateMaximum Length:150 -
_PREVIOUS_OCCUPATION: string
Title:
Previous OccupationMaximum Length:150 -
_PREVIOUS_OCCUPATION_Display: string
Title:
Previous Occupation -
_SPONSOR_NAME: string
Title:
Sponsor NameMaximum Length:150 -
_SPONSOR_NATIONALITY: string
Title:
Sponsor NationalityMaximum Length:150 -
_SPONSOR_NATIONALITY_Display: string
Title:
Sponsor Nationality -
_SPONSOR_NUMBER: string
Title:
Sponsor NumberMaximum Length:150 -
_SPONSOR_RELATIONSHIP: string
Title:
Sponsor RelationshipMaximum Length:150 -
_SPONSOR_RELATIONSHIP_Display: string
Title:
Sponsor Relationship -
_SPONSOR_TYPE: string
Title:
Sponsor TypeMaximum 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:
LinksThe link relations associated with the resource instance. -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFCHVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default 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 TypeMaximum 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:
LinksThe link relations associated with the resource instance. -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFKWVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default Value:KW -
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category -
_ACCOMPANY_PERSON: number
Title:
Number of Accompanying Persons -
_SPONSOR_NAME: string
Title:
Sponsor NameMaximum Length:150 -
_SPONSOR_NATIONALITY: string
Title:
Sponsor NationalityMaximum Length:150 -
_SPONSOR_NATIONALITY_Display: string
Title:
Sponsor Nationality -
_SPONSOR_NUMBER: number
Title:
Sponsor Number -
_SPONSOR_RELATIONSHIP: string
Title:
Sponsor RelationshipMaximum Length:150 -
_SPONSOR_RELATIONSHIP_Display: string
Title:
Sponsor Relationship -
_SPONSOR_TYPE: string
Title:
Sponsor TypeMaximum 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:
LinksThe link relations associated with the resource instance. -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FBHVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default 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:
LinksThe link relations associated with the resource instance. -
oraHrxBhJobDescriptions: string
Title:
Previous OccupationMaximum Length:150 -
oraHrxBhJobDescriptions_Display: string
Title:
Previous Occupation -
oraHrxBhSponsorName: string
Title:
Sponsor NameMaximum Length:150 -
oraHrxBhSponsorNtnlty: string
Title:
Sponsor NationalityMaximum Length:150 -
oraHrxBhSponsorNtnlty_Display: string
Title:
Sponsor Nationality -
oraHrxBhSponsorNumber: string
Title:
Sponsor NumberMaximum Length:150 -
oraHrxBhSponsorRelation: string
Title:
Sponsor RelationshipMaximum Length:150 -
oraHrxBhSponsorRelation_DisplayValue: string
Title:
Sponsor Relationship -
oraHrxBhSponsorType: string
Title:
Sponsor TypeMaximum Length:150 -
oraHrxBhSponsorType_DisplayValue: string
Title:
Sponsor Type -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FOMVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default 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:
LinksThe link relations associated with the resource instance. -
oraHrxOmJobDescriptions: string
Title:
Previous OccupationMaximum Length:150 -
oraHrxOmJobDescriptions_Display: string
Title:
Previous Occupation -
oraHrxOmSponsorName: string
Title:
Sponsor NameMaximum Length:150 -
oraHrxOmSponsorNtnlty: string
Title:
Sponsor NationalityMaximum Length:150 -
oraHrxOmSponsorNtnlty_Display: string
Title:
Sponsor Nationality -
oraHrxOmSponsorNumber: string
Title:
Sponsor NumberMaximum Length:150 -
oraHrxOmSponsorRelation: string
Title:
Sponsor RelationshipMaximum Length:150 -
oraHrxOmSponsorRelation_DisplayValue: string
Title:
Sponsor Relationship -
oraHrxOmSponsorType: string
Title:
Sponsor TypeMaximum Length:150 -
oraHrxOmSponsorType_DisplayValue: string
Title:
Sponsor Type -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FQAVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default 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:
LinksThe link relations associated with the resource instance. -
oraHrxQaSponsorName: string
Title:
Sponsor NameMaximum Length:150 -
oraHrxQaSponsorNtnlty: string
Title:
Sponsor NationalityMaximum Length:150 -
oraHrxQaSponsorNtnlty_Display: string
Title:
Sponsor Nationality -
oraHrxQaSponsorNum: number
Title:
Sponsor Number -
oraHrxQaSponsorRltn: string
Title:
Sponsor RelationshipMaximum Length:150 -
oraHrxQaSponsorRltn_DisplayValue: string
Title:
Sponsor Relationship -
oraHrxQaSponsorType: string
Title:
Sponsor TypeMaximum Length:150 -
oraHrxQaSponsorType_DisplayValue: string
Title:
Sponsor Type -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSAVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default Value:SA -
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category -
_HIJRAH_EXP_DATE: string
Title:
Hijri Expiration DateMaximum Length:150 -
_HIJRAH_ISSUE_DATE: string
Title:
Hijri Issue DateMaximum Length:150 -
EffectiveEndDate: string
(date)
Title:
Effective End Date -
EffectiveStartDate: string
(date)
Title:
Effective Start Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSGVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Visa Information CategoryMaximum Length:30Default Value:SG -
__FLEX_Context_DisplayValue: string
Title:
Visa Information Category -
_CATEGORY: string
Title:
FWL CategoryMaximum 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:
LinksThe link relations associated with the resource instance. -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : workers-visasPermits-visasPermitsDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum 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:
LinksThe link relations associated with the resource instance. -
VisaPermitId: integer
(int64)
Title:
Visa Permit ID
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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
- 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 example shows how to create a worker visa permit 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" -H "Effective-Of:RangeStartDate=2018-01-01" -X POST -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED0005770800005AF3116303090000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016ABDF0400078/child/visasPermits"
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.
{
"VisaPermitId": 300100186928126,
"EffectiveStartDate": "2018-01-01",
"EffectiveEndDate": "4712-12-31",
"IssuingCountry": "US",
"VisaPermitType": null,
"VisaPermitCategory": null,
"VisaPermitNumber": null,
"VisaPermitStatus": null,
"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:18:45.954+00:00",
"links": [
{...
}
]
}