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

Update a worker visa permit

patch

/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}

Request

Path Parameters
  • 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.
  • 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
  • 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.
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : visasPermitsDDF
Type: array
Show Source
  • 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" } }
Nested Schema : visasPermitsDFF
Type: array
Show Source
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_personVisaLegDDF_view_PersonVisaLegDDFAEVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFCHVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFKWVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FBHVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FOMVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FQAVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSAVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSGVO-item-patch-request
Type: object
Show Source
Nested Schema : workers-visasPermits-visasPermitsDFF-item-patch-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-visasPermits-item-response
Type: object
Show Source
Nested Schema : visasPermitsDDF
Type: array
Show Source
  • 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 : visasPermitsDFF
Type: array
Show Source
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_personVisaLegDDF_view_PersonVisaLegDDFAEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFCHVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFKWVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FBHVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FOMVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFORA__5FHRX__5FQAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personVisaLegDDF_view_PersonVisaLegDDFSGVO-item-response
Type: object
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 : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workers-visasPermits-visasPermitsDFF-item-response
Type: object
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
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
visasPermitsDDF
Parameters:
  • visasPermitsUniqID: $request.path.visasPermitsUniqID
  • workersUniqID: $request.path.workersUniqID
visasPermitsDFF
Parameters:
  • visasPermitsUniqID: $request.path.visasPermitsUniqID
  • workersUniqID: $request.path.workersUniqID
Back to Top

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, and RangeEndDate are required parameters.
  • RangeStartDate the same as the EffectiveStartDate of the record.
  • RangeEndDate must be the same as the EffectiveEndDate 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, and RangeEndDate are required parameters.
  • RangeStartDate must be between EffectiveStartDate and EffectiveEndDateof the record.
  • RangeEndDate must be the same as the EffectiveEndDate 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": [
         {...
             }
   ]
}
Back to Top