1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Document Records
  4. Developer Descriptive Flexfields for Document Records

Update

patch

/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDDF/{DocumentsOfRecordId2}

Request

Path Parameters
  • 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=
  • 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=
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.
Supported Media Types
Request Body - application/json ()
Root Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFGLB__5FPAYSLIPVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FAHV__5FAVSVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FBURVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FBVG__5FLPPVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FFAK__5FCAFVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FKTG__5FAMCVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FQST__5FISVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FST__5FIVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUID__5FBFSVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUID__5FEHRAVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUVGZ__5FLAACVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUVG__5FLAAVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FBIRTH__5FCERITIFICATEVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FELECTORAL__5FCARDVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FMILITARY__5FCERTIFICATEVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FVACC__5FCERTIFICATEVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FCA__5FROE__5FPDFVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FGB__5FGENDER__5FREASSIGNMENTVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FGB__5FPS__5FCSP__5FILL__5FHEALTHVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FIE__5FGENDER__5FREASSIGNMENTVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FIN__5FFORM16__5FDOCSVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FMX__5FCFDIVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FEND__5FEVALUATIONVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FFIRST__5FYR__5FEVALVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FNOTESVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FPLAN__5FOF__5FAPPROACHVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FPROBLEM__5FANALYSISVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FRETURN__5FTO__5FWORKVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FUWV__5FSICK__5FRPTVO-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 : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFGLB__5FPAYSLIPVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FAHV__5FAVSVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FBURVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FBVG__5FLPPVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FFAK__5FCAFVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FKTG__5FAMCVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FQST__5FISVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FST__5FIVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUID__5FBFSVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUID__5FEHRAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUVGZ__5FLAACVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUVG__5FLAAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FBIRTH__5FCERITIFICATEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FELECTORAL__5FCARDVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FMILITARY__5FCERTIFICATEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FVACC__5FCERTIFICATEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FCA__5FROE__5FPDFVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FGB__5FGENDER__5FREASSIGNMENTVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FGB__5FPS__5FCSP__5FILL__5FHEALTHVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FIE__5FGENDER__5FREASSIGNMENTVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FIN__5FFORM16__5FDOCSVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FMX__5FCFDIVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FEND__5FEVALUATIONVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FFIRST__5FYR__5FEVALVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FNOTESVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FPLAN__5FOF__5FAPPROACHVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FPROBLEM__5FANALYSISVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FRETURN__5FTO__5FWORKVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FUWV__5FSICK__5FRPTVO-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 : 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 : 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 : 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 : 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 : 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 : 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 : 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 : 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 : 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
Links
LVVO_V___FLEX_Context
Parameters:
  • finder: ValidValuesFinder%3BBind_ApplicationId%3D800%2CBind_DescriptiveFlexfieldCode%3DPER_DOC_OF_RECORD_LEG_DDF
The following properties are defined on the LOV link relation:
  • Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Name
  • Display Attribute: Name, Description
LVVO___FLEX_Context
Parameters:
  • finder: ValidValuesFinder%3BBind_ApplicationId%3D800%2CBind_DescriptiveFlexfieldCode%3DPER_DOC_OF_RECORD_LEG_DDF
The following properties are defined on the LOV link relation:
  • Source Attribute: __FLEX_Context; Target Attribute: ContextCode
  • Display Attribute: Name
Back to Top

Examples

The following example shows how to update a developer descriptive flexfield of a document record by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "Effective-Of:RangeStartDate=2019-05-12" -X PATCH -d <payload> https://<host>:<port>/hcmRestApi/resources/11.13.18.05/documentRecords/300100185079196/child/documentRecordsDDF/300100185079196

Example of Payload

The following is an example of the payload.

{
  "lastVacCertPres": "2019-05-11"
}

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourcecollection+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "DocumentsOfRecordId": 300100185079196,
  "__FLEX_Context": "ORA_HRX_BR_VACC_CERTIFICATE",
  "__FLEX_Context_DisplayValue": "Brazil Vaccination Certificate",
  "lastVacCertPres": "2019-05-11",
  "links":[
     {
      ...}
  ]
}
Back to Top