1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. HCM Data Loader Data Sets

Get all data sets

get

/hcmRestApi/resources/11.13.18.05/dataLoadDataSets

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 data sets that match the primary key criteria specified.
      Finder Variables
      • DataSetId; integer; Unique identifier of the data set.
    • findByRequestId Finds all the data sets that match the specified criteria.
      Finder Variables
      • RequestId; integer; System-generated identifier for the request.
  • 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:
    • ContentId; string; Oracle WebCenter content server identifier for the file.
    • DataSetId; integer; System-generated unique identifier for the data set.
    • DataSetName; string; Name of the data set.
    • DataSetStatusCode; string; Overall data set status derived from the transfer, import and load statuses.
    • DataSetStatusMeaning; string; Description of the data set status.
    • ImportStatusCode; string; Code for the import status of the data set.
    • ImportStatusMeaning; string; Description of the import status of the data set.
    • IntegrationTypeCode; string; Code for the integration type.
    • IntegrationTypeMeaning; string; Description of the integration type of the data set.
    • LoadStatusCode; string; Code for the status of loading staging table data into the application tables.
    • LoadStatusMeaning; string; Description of load status of the data set.
    • RequestId; integer; System-generated primary key for the request used to create the data set.
    • SourceTypeCode; string; Code for the source type of the data set.
    • SourceTypeMeaning; string; Description of the source type of the data set.
    • SpreadsheetTemplateCode; string; Code of the spreadsheet template used to create the data set.
    • SpreadsheetTemplateName; string; Name of the spreadsheet template used to create the data set.
    • TransferStatusCode; string; Code for the file data transfer status from the Oracle WebCenter Content server for the data set.
    • TransferStatusMeaning; string; Description of the transfer status for the data set.
  • 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 : dataLoadDataSets
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : dataLoadDataSets-item-response
Type: object
Show Source
Nested Schema : Data Set Business Objects
Type: array
Title: Data Set Business Objects
The businessObjects resource is a child of the dataLoadDataSets resource. It's used to view details of the business objects included in the data set.
Show Source
Nested Schema : Messages
Type: array
Title: Messages
The messages resource is a child of the dataLoadDataSets resource. It's used to view details of the messages raised for a data set, including the details of the record the message was raised against.
Show Source
Nested Schema : Submitted Processes
Type: array
Title: Submitted Processes
The processes resource is a child of the dataLoadDataSets resource. It's used to view details of the processes submitted to action the data set.
Show Source
Nested Schema : dataLoadDataSets-businessObjects-item-response
Type: object
Show Source
Nested Schema : dataLoadDataSets-messages-item-response
Type: object
Show Source
Nested Schema : dataLoadDataSets-processes-item-response
Type: object
Show Source
Links
createFileDataSet
Submits a previously loaded compressed file to the Oracle WebCenter content server for processing by the HCM Data Loader. Specify whether to only import the file data into staging tables, or import and load valid objects into the application tables. The identifier for the data set creation request is returned. Use this to get the current data set status and perform additional actions.
createSpreadsheetDataSet
Submits a file previously loaded to the Oracle WebCenter content server for processing by Oracle Fusion Cloud HCM Spreadsheet Data Loader. Specify the template code and whether to only import the file into the staging tables, or to import and load valid objects into the application tables. When you import and load data, the application returns the identifier for the data set creation request. Use this identifier to get the current data set status and perform other actions. When you only import the file into the staging tables, the application returns the data set name. You'll then need to manually load the data set from a spreadsheet generated using the same template. You can't initiate the load using REST service, if you've only imported the data to the staging tables.
findByAdvancedSearchQuery
Finds all data sets using the specified advanced search query criteria.
uploadFile
Uploads file to the HCM Data Loader import account of the Oracle WebCenter content server for processing by HCM Data Loader or HCM Spreadsheet Data Loader.
Back to Top