Update a document record

patch

/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}

Request

Path Parameters
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 : schema
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is a child of the documentRecords resource. It is used to add and view the attachments to a document record for a person.
Show Source
Nested Schema : Banner Override Messages
Type: array
Title: Banner Override Messages
The bannerOverrideMessages resource provides all the status information and related messages for an object.
Show Source
Nested Schema : Document Records Developer Descriptive Flexfields
Type: array
Title: Document Records Developer Descriptive Flexfields
The documentRecordsDDF resource is a child of the documentRecords resource. It is used to capture the legislative information of a document record.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "GLB_PAYSLIP":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFGLB__5FPAYSLIPVO-item-patch-request", "ORA_CH_AHV_AVS":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FAHV__5FAVSVO-item-patch-request", "ORA_CH_BUR":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FBURVO-item-patch-request", "ORA_CH_BVG_LPP":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FBVG__5FLPPVO-item-patch-request", "ORA_CH_FAK_CAF":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FFAK__5FCAFVO-item-patch-request", "ORA_CH_KTG_AMC":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FKTG__5FAMCVO-item-patch-request", "ORA_CH_QST_IS":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FQST__5FISVO-item-patch-request", "ORA_CH_ST_I":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FST__5FIVO-item-patch-request", "ORA_CH_UID_BFS":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUID__5FBFSVO-item-patch-request", "ORA_CH_UID_EHRA":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUID__5FEHRAVO-item-patch-request", "ORA_CH_UVGZ_LAAC":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUVGZ__5FLAACVO-item-patch-request", "ORA_CH_UVG_LAA":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUVG__5FLAAVO-item-patch-request", "ORA_HRX_BR_BIRTH_CERITIFICATE":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FBIRTH__5FCERITIFICATEVO-item-patch-request", "ORA_HRX_BR_ELECTORAL_CARD":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FELECTORAL__5FCARDVO-item-patch-request", "ORA_HRX_BR_MILITARY_CERTIFICATE":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FMILITARY__5FCERTIFICATEVO-item-patch-request", "ORA_HRX_BR_VACC_CERTIFICATE":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FVACC__5FCERTIFICATEVO-item-patch-request", "ORA_HRX_CA_ROE_PDF":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FCA__5FROE__5FPDFVO-item-patch-request", "ORA_HRX_GB_GENDER_REASSIGNMENT":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FGB__5FGENDER__5FREASSIGNMENTVO-item-patch-request", "ORA_HRX_GB_PS_CSP_ILL_HEALTH":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FGB__5FPS__5FCSP__5FILL__5FHEALTHVO-item-patch-request", "ORA_HRX_IE_GENDER_REASSIGNMENT":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FIE__5FGENDER__5FREASSIGNMENTVO-item-patch-request", "ORA_HRX_MX_CFDI":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FMX__5FCFDIVO-item-patch-request", "ORA_HRX_NL_END_EVALUATION":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FEND__5FEVALUATIONVO-item-patch-request", "ORA_HRX_NL_FIRST_YR_EVAL":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FFIRST__5FYR__5FEVALVO-item-patch-request", "ORA_HRX_NL_NOTES":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FNOTESVO-item-patch-request", "ORA_HRX_NL_PLAN_OF_APPROACH":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FPLAN__5FOF__5FAPPROACHVO-item-patch-request", "ORA_HRX_NL_PROBLEM_ANALYSIS":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FPROBLEM__5FANALYSISVO-item-patch-request", "ORA_HRX_NL_RETURN_TO_WORK":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FRETURN__5FTO__5FWORKVO-item-patch-request", "ORA_HRX_NL_UWV_SICK_RPT":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FUWV__5FSICK__5FRPTVO-item-patch-request" } }
Nested Schema : Document Records Descriptive Flexfields
Type: array
Title: Document Records Descriptive Flexfields
The documentRecordsDFF resource is a child of the documentRecords resource. It represents the extensible structure (descriptive flexfields) of a document record.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Attachment Previews
Type: array
Title: Attachment Previews
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : documentRecords-attachments-AttachmentsPreview-item-patch-request
Type: object
Show Source
Nested Schema : documentRecords-bannerOverrideMessages-item-patch-request
Type: object
Show Source
Nested 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__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
Nested Schema : schema
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 : documentRecords-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is a child of the documentRecords resource. It is used to add and view the attachments to a document record for a person.
Show Source
Nested Schema : Banner Override Messages
Type: array
Title: Banner Override Messages
The bannerOverrideMessages resource provides all the status information and related messages for an object.
Show Source
Nested Schema : Document Records Developer Descriptive Flexfields
Type: array
Title: Document Records Developer Descriptive Flexfields
The documentRecordsDDF resource is a child of the documentRecords resource. It is used to capture the legislative information of a document record.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "GLB_PAYSLIP":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFGLB__5FPAYSLIPVO-item-response", "ORA_CH_AHV_AVS":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FAHV__5FAVSVO-item-response", "ORA_CH_BUR":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FBURVO-item-response", "ORA_CH_BVG_LPP":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FBVG__5FLPPVO-item-response", "ORA_CH_FAK_CAF":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FFAK__5FCAFVO-item-response", "ORA_CH_KTG_AMC":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FKTG__5FAMCVO-item-response", "ORA_CH_QST_IS":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FQST__5FISVO-item-response", "ORA_CH_ST_I":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FST__5FIVO-item-response", "ORA_CH_UID_BFS":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUID__5FBFSVO-item-response", "ORA_CH_UID_EHRA":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUID__5FEHRAVO-item-response", "ORA_CH_UVGZ_LAAC":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUVGZ__5FLAACVO-item-response", "ORA_CH_UVG_LAA":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FCH__5FUVG__5FLAAVO-item-response", "ORA_HRX_BR_BIRTH_CERITIFICATE":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FBIRTH__5FCERITIFICATEVO-item-response", "ORA_HRX_BR_ELECTORAL_CARD":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FELECTORAL__5FCARDVO-item-response", "ORA_HRX_BR_MILITARY_CERTIFICATE":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FMILITARY__5FCERTIFICATEVO-item-response", "ORA_HRX_BR_VACC_CERTIFICATE":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FBR__5FVACC__5FCERTIFICATEVO-item-response", "ORA_HRX_CA_ROE_PDF":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FCA__5FROE__5FPDFVO-item-response", "ORA_HRX_GB_GENDER_REASSIGNMENT":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FGB__5FGENDER__5FREASSIGNMENTVO-item-response", "ORA_HRX_GB_PS_CSP_ILL_HEALTH":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FGB__5FPS__5FCSP__5FILL__5FHEALTHVO-item-response", "ORA_HRX_IE_GENDER_REASSIGNMENT":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FIE__5FGENDER__5FREASSIGNMENTVO-item-response", "ORA_HRX_MX_CFDI":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FMX__5FCFDIVO-item-response", "ORA_HRX_NL_END_EVALUATION":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FEND__5FEVALUATIONVO-item-response", "ORA_HRX_NL_FIRST_YR_EVAL":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FFIRST__5FYR__5FEVALVO-item-response", "ORA_HRX_NL_NOTES":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FNOTESVO-item-response", "ORA_HRX_NL_PLAN_OF_APPROACH":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FPLAN__5FOF__5FAPPROACHVO-item-response", "ORA_HRX_NL_PROBLEM_ANALYSIS":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FPROBLEM__5FANALYSISVO-item-response", "ORA_HRX_NL_RETURN_TO_WORK":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FRETURN__5FTO__5FWORKVO-item-response", "ORA_HRX_NL_UWV_SICK_RPT":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FNL__5FUWV__5FSICK__5FRPTVO-item-response" } }
Nested Schema : Document Records Descriptive Flexfields
Type: array
Title: Document Records Descriptive Flexfields
The documentRecordsDFF resource is a child of the documentRecords resource. It represents the extensible structure (descriptive flexfields) of a document record.
Show Source
Nested Schema : documentRecords-attachments-item-response
Type: object
Show Source
Nested Schema : Attachment Previews
Type: array
Title: Attachment Previews
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : documentRecords-attachments-AttachmentsPreview-item-response
Type: object
Show Source
Nested Schema : documentRecords-bannerOverrideMessages-item-response
Type: object
Show Source
Nested 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__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 : documentRecords-documentRecordsDFF-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to update 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> http://<host>:<port>/hcmRestApi/resources/11.13.18.05/documentRecords/300100184455604

Example of Payload

The following is an example of the payload.

{
  "IssuingCountryName": "United States"
}

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": 300100184455604,
  "DocumentTypeId": 100100001749964,
  "SystemDocumentType": "GLB_BIRTH",
  "DocumentType": "Birth",
  "Country": null,
  "CategoryCode": "LEGAL_DOC",
  "SubCategoryCode": "LEGAL_DOC_PERSONAL",
  "PersonId": 300100085568892,
  "PersonNumber": "966169008889103",
  "ListName": "CHID EMP O87 CHID EMP O87, CHID EMP O87",
  "DisplayName": "CHID EMP O87 CHID EMP O87 CHID EMP O87",
  "FullName": "CHID EMP O87, CHID EMP O87 CHID EMP O87",
  "DocumentCode": "GLB_BIRTH_2019-5-20-8-17-27",
  "DocumentName": "GLB_BIRTH_2019-5-20-8-17-27",
  "DocumentNumber": null,
  "DateFrom": null,
  "DateTo": null,
  "IssuingAuthority": null,
  "IssuingCountryName": "United States",
  "IssuedDate": null,
  "IssuingLocation": null,
  "Comments": null,
  "Publish": null,
  "PublishDate": null,
  "RelatedObjectId": null,
  "RelatedObjectIdColumn": null,
  "RelatedObjectName": null,
  "CreatedBy": "VMOSS",
  "CreationDate": "2019-05-30T06:49:24.001+00:00",
  "LastUpdatedBy": "VMOSS",
  "LastUpdateDate": "2019-05-30T09:02:39+00:00",
  "links": [2]
     {
       ...}
  ]
}
Back to Top