REST API for Initiating and Monitoring Bulk Data Loads

You can now automate the HCM Data Loader (HDL) and HCM Spreadsheet Data Loader (HSDL) integrations using the dataLoadDataSets REST resource to upload files to the Oracle WebCenter Content server and initiate HDL and HSDL and monitor the progress and status of your data sets.

All the REST API custom actions are as follows:

Action	Method	Description
Upload a File	POST	Uploads a file to the HDL import directory of the Oracle WebCenter Content server (UCM).
Create a File Data Set	POST	Creates a file based data set for a file preloaded to the UCM, importing valid data into staging tables. Optionally loading valid objects into the application.
Create a Spreadsheet Data Set	POST	Creates a spreadsheet based data set, transferring the UCM file and importing valid data into staging tables using the named template code. Optionally loading valid objects into the application.
Get all Data Sets	GET	Provides summary information for HCM Data Loader and HCM Spreadsheet Data Loader data sets available in the staging tables.
Get an individual Data Set	GET	Requests the staging table data for data sets identified by the parameter values supplied.
Get Business Object Information	GET	Provides summary information for business objects within a data set.
Get Data Set Messages	GET	Provides details of the processes submitted to upload a specific data set.
Get Data Set Process Information	GET	Provides details of the processes submitted to upload a specific data set.
Stop a running Data Set	POST	Requests that processing of the data set be ceased.
Submit Load or Rollback for a Data Set	POST	Submits the load or rollback processing of a data set.
Delete a Data Set's Staging Table Data	POST	Deletes the staging table data of a non-processing data sets identified by the input parameters.
Stop a running Data Set Business Object	POST	Stops the processing of an in-progress data set
Submit Load or Rollback for a Business Object within a Data Set	POST	Submits the load or rollback of a business object within a data set.

The REST resource provides custom actions to upload files to the Oracle WebCenter Content server and initiate HDL and HSDL and monitor the progress and status of your data sets using a user account with bulk-loading access. It also allows the secure loading of all objects supported by HSDL.

Steps to Enable

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.

Set up access to the HCM Data Loader REST API using the steps listed in the Configure Access to HCM Data Loader tutorial.

Use the HCM Data Loader REST API tutorial and execute the REST API actions to:

• Upload a file
• Initiate HDL
• Initiate HSDL
• Get the data set status of the business object within the data set
• Get the process status
• Get the message details
• Stop the processing of a data set or a business object
• Submit load and roll back (where supported) for a data set or a business object
• Delete the staging table data for a data set

Tips And Considerations

Due to the Base64 encoding of the files, the uploadFile action is suitable for uploading smaller files.