Get all document records

get

/hcmRestApi/resources/11.13.18.05/documentRecords

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds all the document records that match the specified primary key criteria.
      Finder Variables
      • DocumentsOfRecordId; integer; System-generated unique identifier for the document record.
    • findByDocumentsOfRecordId Finds all the document records.
      Finder Variables
      • DocumentsOfRecordId; integer; Filter attribute to retrieve document records based on document records identifier.
      • TransactionChangesOnly; string; Filter attribute to retrieve document records that have a change in the record.
      • TransactionId; integer; Filter attribute to retrieve document records based on transaction identifier.
    • findByPersonId Finds all the document records for a person.
      Finder Variables
      • AssignmentId; integer; Filter attribute to retrieve document records based on assignment identifier.
      • DocumentTypeId; integer; Filter attribute to retrieve document records based on document type identifier.
      • PersonId; integer; Filter attribute to retrieve document records based on person identifier.
      • PublishDate; string; Filter attribute to retrieve document records based on the publish date.
      • RelatedObjectId; integer; Filter attribute to retrieve document records based on related object identifier.
      • RelatedObjectIdColumn; string; Filter attribute to retrieve document records based on related object column identifier.
      • RelatedObjectName; string; Filter attribute to retrieve document records based on related object name.
      • TransactionChangesOnly; string; Filter attribute to retrieve document records for a person that have a change in the record.
      • TransactionId; integer; Filter attribute to retrieve document records for a person based on transaction identifier.
    • findByPersonIdAfterReload Finds all the document records for a person after reloading pending records.
      Finder Variables
      • PersonId; integer; Filter attribute to retrieve document records for a person after reloading pending records based on person identifier.
      • TransactionChangesOnly; string; Filter attribute to retrieve document records for a person after reloading pending records based on transaction changes.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AssignmentId; integer; Assignment Identifier of the person assignment.
    • AssignmentName; string; Name of the person assignment.
    • AssignmentNumber; string; Assignment Number of the person assignment.
    • CategoryCode; string; Category for the document type.
    • Comments; string; Comments pertaining to the document record.
    • Country; string; Name of the country, if the document type is country specific.
    • CreatedBy; string; Name of the user who created the document.
    • CreationDate; string; Date on which the document record was created.
    • DateFrom; string; Date from which the document is valid.
    • DateTo; string; Last date up to which the document is valid.
    • DisplayName; string; Display name of the person the document record is for.
    • DocumentCode; string; Unique code that identifies the document record for the person and document type.
    • DocumentName; string; Name for the document record. Used to differentiate records when multiple documents are added for the same document type.
    • DocumentNumber; string; Number that legally identifies the document.
    • DocumentType; string; Document type for the document record.
    • DocumentTypeId; integer; Unique identifier for the document type.
    • DocumentsOfRecordId; integer; Surrogate identifier for the record. Applicable to existing records only.
    • FullName; string; Full name of the person the document record is for.
    • IssuedDate; string; Date on which the document was issued.
    • IssuingAuthority; string; Name of the issuing authority.
    • IssuingCountry; string; Legislation code of the issuing country.
    • IssuingCountryName; string; Name of the country that issued the document.
    • IssuingLocation; string; Location at which the document was issued.
    • LastUpdateDate; string; Date on which the document record was last updated.
    • LastUpdatedBy; string; Name of the user who last updated the document.
    • LegislationCode; string; Legislation code, if the document type for this document record is legislation specific.
    • ListName; string; Name of the person the document record is for.
    • PersonId; integer; Unique identifier for the person.
    • PersonNumber; string; Person number of the person the document record is for.
    • Publish; string; Option to determine whether or not to publish the document record on a specific date.
    • PublishDate; string; Date on which the document was published.
    • RelatedObjectId; integer; Unique identifier of the related object.
    • RelatedObjectIdColumn; string; Column details of the related object identifier.
    • RelatedObjectName; string; Name of the related object.
    • SubCategoryCode; string; Subcategory code for the document type.
    • SystemDocumentType; string; System-generated name that uniquely identifies the document type.
    • TagList; string; Tags to find document types.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : documentRecords-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Candidate Attachments
Type: array
Title: Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
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 : documentRecordsDDF
Type: array
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_IN_FORM16_DOCS":"#/components/schemas/oracle_apps_hcm_documentsOfRecord_core_flex_documentsOfRecordDDF_view_DocumentsOfRecordLegDDFORA__5FHRX__5FIN__5FFORM16__5FDOCSVO-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 : documentRecordsDFF
Type: array
Show Source
Nested Schema : HR Document Types
Type: array
Title: HR Document Types
The hrDocumentTypes resource includes all the document types based on which document records are created for a person.
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-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__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 : documentRecords-documentRecordsDFF-item-response
Type: object
Show Source
Nested Schema : documentRecords-hrDocumentTypes-item-response
Type: object
Show Source
  • Title: Active
    Maximum Length: 30
    Default Value: true
    Indicates whether the document type is active. The default value is Yes.
  • Title: Archive Criteria Basis
    Maximum Length: 30
    Criteria for archiving document records based on the document type.
  • Title: Archive After Days
    Number of days after which document records are archived based on the document type.
  • Title: Approval Required
    Maximum Length: 1
    Default Value: false
    Indicates whether approval is required for the document type. The default value is No.
  • Title: Report Path
    Maximum Length: 2000
    URL or path where the report is available.
  • Title: Category
    Maximum Length: 30
    Category of the document type.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Category meaning of the document type.
  • Title: New Label for Issuing Comments
    Maximum Length: 200
    Label for the field that the user defines for the issuing comments.
  • Title: Issuing Comments Applicable
    Maximum Length: 30
    Default Value: Y
    Indicates whether comments are relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • Title: Territory Name
    Read Only: true
    Maximum Length: 80
    Name of the country for the document type.
  • Read Only: true
    Maximum Length: 64
    Name of the user who created the document type.
  • Read Only: true
    Date on which the document type was created.
  • Title: New Label for From Date
    Maximum Length: 200
    Label for the field that the user defines for the from date.
  • Title: From Date Applicable
    Maximum Length: 30
    Default Value: Y
    Indicates whether date from is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • Title: New Label for To Date
    Maximum Length: 200
    Label for the field that the user defines for the to date.
  • Title: To Date Applicable
    Maximum Length: 30
    Default Value: Y
    Indicates whether date to is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • Title: Description
    Maximum Length: 4000
    Description for the document type.
  • Title: Default Value for Context Segment
    Maximum Length: 120
    Default value for the document records flexfield context segment.
  • Title: Display Preference for Context Segment
    Maximum Length: 30
    Display preference for the document records flexfield context segment.
  • Title: Display Preference for Global Segment
    Maximum Length: 30
    Display preference for the document records flexfield global segment.
  • Title: New Label for Name
    Maximum Length: 200
    Label for the field that the user defines for the document name.
  • Title: Document Name Applicable
    Maximum Length: 30
    Default Value: Y
    Indicates whether document name is relevant (Y) or required (R) or not relevant (N). The default setting is relevant (Y).
  • Title: New Label for Number
    Maximum Length: 200
    Label for the field that the user defines for the document number.
  • Title: Document Number Applicable
    Maximum Length: 30
    Default Value: Y
    Indicates whether document number is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • Title: Type
    Maximum Length: 80
    Unique name to identify the document type.
  • Title: Type
    Surrogate ID for the document type which is available only when updating existing records.
  • Title: Document Type Level
    Maximum Length: 30
    Default Value: ORA_P
    Indicates whether the document type applies to a person or an individual assignment. The default value is Person.
  • documentTypesDDF
  • documentTypesDFF
  • Title: Override Hierarchy
    Maximum Length: 30
    Hierarchy code to support delivery preferences on this document type.
  • Title: New Label for Issued Date
    Maximum Length: 200
    Label for the field that the user defines for the issued date.
  • Title: Issued on Applicable
    Maximum Length: 30
    Default Value: Y
    Indicates whether issued date is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • Title: New Label for Issuing Authority
    Maximum Length: 200
    Label for the field that the user defines for the issuing authority.
  • Title: Issuing Authority Applicable
    Maximum Length: 30
    Default Value: Y
    Indicates whether issuing authority is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • Title: New Label for Issuing Country
    Maximum Length: 200
    Label for the field that the user defines for the issuing country.
  • Title: Issuing Country Applicable
    Maximum Length: 30
    Default Value: Y
    Indicates whether issuing country is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • Title: New Label for Issuing Location
    Maximum Length: 200
    Label for the field that the user defines for the issuing location.
  • Title: Issuing Location Applicable
    Maximum Length: 30
    Default Value: Y
    Indicates whether issuing location is relevant (Y) or required (R) or not relevant (N). The default value is relevant (Y).
  • Read Only: true
    Date the document type was last updated.
  • Read Only: true
    Maximum Length: 64
    User who last updated the document type.
  • Title: Country
    Maximum Length: 30
    Legislation code if this is a legislation specific document type.
  • Links
  • Title: Restrict Create
    Maximum Length: 30
    Default Value: false
    Indicates whether it restricts or allows creating document records of this document type. The default value is No
  • Title: Roles Excluded from Restriction
    Maximum Length: 4000
    List of roles that can create document records based on the document type.
  • Title: Restrict Delete
    Maximum Length: 30
    Default Value: false
    Indicates whether it restricts or allows deleting document records of this document type. The default value is No.
  • Title: Roles Excluded from Restriction
    Maximum Length: 4000
    List of roles allowed to delete document records based on the document type.
  • Title: Restrict Update
    Maximum Length: 30
    Default Value: false
    Indicates whether it restricts or allows updating document records of this document type. The default value is No.
  • Title: Roles Excluded from Restriction
    Maximum Length: 4000
    List of roles allowed to update document records based on the document type.
  • Title: Minimum Attachments
    Default Value: 0
    Minimum number of attachments that a user must attach for a specific document type.
  • Title: Allow multiple occurrences
    Maximum Length: 30
    Default Value: true
    Indicates whether multiple occurrences of this document type are allowed. The default value is Yes.
  • Title: Publish Required
    Maximum Length: 30
    Default Value: false
    Indicates whether document records of this document type must be published. The default value is No.
  • Title: Purge After Days
    Number of days after which archived document records will be purged.
  • Title: Subcategory
    Maximum Length: 30
    Code of the subcategory for the document type.
  • Read Only: true
    Maximum Length: 80
    Subcategory meaning of the document type.
  • Title: System Document Type
    Maximum Length: 120
    System-generated name that uniquely identifies the document type.
  • Title: Tags
    Maximum Length: 2000
    Lookup code of the tag used for the document type derived from the lookup ORA_PER_DOC_TYPE_TAGS.
  • Title: Expiration Notification Period
    Number of days in advance to generate an alert when a document record based on this document type is about to expire.
Nested Schema : documentTypesDDF
Type: array
Show Source
Nested Schema : documentTypesDFF
Type: array
Show Source
Nested Schema : documentRecords-hrDocumentTypes-documentTypesDDF-item-response
Type: object
Show Source
Nested Schema : documentRecords-hrDocumentTypes-documentTypesDFF-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all the document records by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET http://<host>:<port>/hcmRestApi/resources/11.13.18.05/documentRecords

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.

"items": [
{
  "DocumentsOfRecordId": 300100009471608,
  "DocumentTypeId": 100100001749964,
  "SystemDocumentType": "GLB_BIRTH",
  "DocumentType": "Birth",
  "Country": null,
  "CategoryCode": "LEGAL_DOC",
  "SubCategoryCode": "LEGAL_DOC_PERSONAL",
  "PersonId": 300100009471199,
  "PersonNumber": "300100009471199",
  "ListName": "ZHRX_SG02_emp002__, ZHRX",
  "DisplayName": "ZHRX ZHRX_SG02_emp002__",
  "FullName": "ZHRX_SG02_emp002__, ZHRX",
  "DocumentCode": "fff ",
  "DocumentName": "fff",
  "DocumentNumber": null,
  "DateFrom": null,
  "DateTo": null,
  "IssuingAuthority": null,
  "IssuingCountryName": null,
  "IssuedDate": null,
  "IssuingLocation": null,
  "Comments": null,
  "Publish": null,
  "PublishDate": null,
  "RelatedObjectId": null,
  "RelatedObjectIdColumn": null,
  "RelatedObjectName": null,
  "CreatedBy": "ZBEN-USER-117",
  "CreationDate": "2012-04-28T00:35:20.332+00:00",
  "LastUpdatedBy": "ZBEN-USER-117",
  "LastUpdateDate": "2012-04-28T00:36:17.071+00:00",
  "links": [2]
     {
       ...}
},
{
  "DocumentsOfRecordId": 300100137357366,
  "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_2018-1-19-8-17-27",
  "DocumentName": "GLB_BIRTH_2018-1-19-8-17-27",
  "DocumentNumber": null,
  "DateFrom": null,
  "DateTo": null,
  "IssuingAuthority": "GLB_BIRTH_2018-1-19-8-17-27",
  "IssuingCountryName": "Algeria",
  "IssuedDate": "2015-01-01",
  "IssuingLocation": "GLB_BIRTH_2018-1-19-8-17-27",
  "Comments": "GLB_BIRTH_2018-1-19-8-17-27",
  "Publish": null,
  "PublishDate": null,
  "RelatedObjectId": null,
  "RelatedObjectIdColumn": null,
  "RelatedObjectName": null,
  "CreatedBy": "HCM_USER2",
  "CreationDate": "2018-01-19T08:17:15.001+00:00",
  "LastUpdatedBy": "HCM_USER2",
  "LastUpdateDate": "2018-01-19T08:18:24.451+00:00",
  "links": [2]
     {
       ...}
},
{
  "DocumentsOfRecordId": 300100180279489,
  "DocumentTypeId": 100100001749960,
  "SystemDocumentType": "GLB_APPLICATION",
  "DocumentType": "Application",
  "Country": null,
  "CategoryCode": "EMPMNT",
  "SubCategoryCode": null,
  "PersonId": 100010034148145,
  "PersonNumber": "GBI257",
  "ListName": "Moss, Veda",
  "DisplayName": "Veda Moss",
  "FullName": "Veda Moss",
  "DocumentCode": "GLB_APPLICATION_2019-5-23-4-55-1",
  "DocumentName": null,
  "DocumentNumber": null,
  "DateFrom": null,
  "DateTo": null,
  "IssuingAuthority": null,
  "IssuingCountryName": null,
  "IssuedDate": null,
  "IssuingLocation": null,
  "Comments": "TestApp",
  "Publish": null,
  "PublishDate": null,
  "RelatedObjectId": null,
  "RelatedObjectIdColumn": null,
  "RelatedObjectName": null,
  "CreatedBy": "VMOSS",
  "CreationDate": "2019-05-23T04:54:23.001+00:00",
  "LastUpdatedBy": "VMOSS",
  "LastUpdateDate": "2019-05-23T05:12:15.937+00:00",
  "links": [2]
     {
       ...}
},
{
  "DocumentsOfRecordId": 300100184437298,
  "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": "MY_APPLICATION_FIFTYFOUR",
  "DocumentName": "MY_APPLICATION_FIFTYFOUR",
  "DocumentNumber": null,
  "DateFrom": null,
  "DateTo": null,
  "IssuingAuthority": null,
  "IssuingCountryName": null,
  "IssuedDate": null,
  "IssuingLocation": null,
  "Comments": null,
  "Publish": null,
  "PublishDate": null,
  "RelatedObjectId": null,
  "RelatedObjectIdColumn": null,
  "RelatedObjectName": null,
  "CreatedBy": "VMOSS",
  "CreationDate": "2019-05-30T06:42:39+00:00",
  "LastUpdatedBy": "VMOSS",
  "LastUpdateDate": "2019-05-30T06:42:43.991+00:00",
  "links": [2]
     {
       ...}
},
{
  "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": null,
  "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-30T06:49:24.094+00:00",
  "links":
     {
       ...}
  ]
}
Back to Top