Jump to

• Request
• Response

Submit HCM Spreadsheet Data Loader

post

/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/action/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.

Request

Header Parameters

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• attributeDelimiter: string
  Characters used to separate values in the file. The default is comma.
• contentId: string
  Unique identifier for the file on the Oracle WebCenter content server to be processed.
• dataSetName: string
  Name of the data set.
• dateFormat: string
  Date format used for attributes with the date data type. The default format is YYYY/MM/DD.
• deleteSourceFileFlag: string
  Indicates if the file generated by the template for HCM Data Loader processing should be deleted after the data is imported into the staging tables. The default value is Y.
• escapeIndicator: string
  Characters used to escape the delimiter characters within an attribute value. The default is backslash.
• fileAction: string
  Action for the spreadsheet data. Valid values are IMPORT_AND_LOAD and IMPORT_ONLY. The default is IMPORT_AND_LOAD.
• fileEncryption: string
  Encryption used for the source file. The default is defined by the File Encryption parameter found in the Configure HCM Data Loader task.
• headerIncludedFlag: string
  Indicates if a header is included in the source file to name the attributes included in the file. The default value is Y.
• importConcurrentThreads: number
  Maximum number of concurrent threads to assign to the import process. The default is defined by the Maximum Concurrent Threads for Import parameter in the Configure HCM Data Loader task.
• importMaxErrorPercentage: number
  Maximum percentage of records in error before the import ceases. The default is defined by the Maximum Percentage of Import Errors parameter found in the Configure HCM Data Loader task.
• loadConcurrentThreads: number
  Maximum number of concurrent threads to assign to the load process. The default is defined by the Maximum Concurrent Threads for Load parameter in the Configure HCM Data Loader task.
• loadMaxErrorPercentage: number
  Maximum percentage of records in error before the load ceases. The default is defined by the Maximum Percentage of Load Errors parameter found in the Configure HCM Data Loader task.
• newLineIndicator: string
  Characters used to indicate a new line. The default value is n, prefixed with the escape character.
• templateCode: string
  Spreadsheet template code to load data.
• verificationKey: string
  Verification key used for the source file encryption.

{
    "type":"object",
    "properties":{
        "newLineIndicator":{
            "type":"string",
            "description":"Characters used to indicate a new line. The default value is n, prefixed with the escape character.",
            "nullable":true
        },
        "deleteSourceFileFlag":{
            "type":"string",
            "description":"Indicates if the file generated by the template for HCM Data Loader processing should be deleted after the data is imported into the staging tables. The default value is Y.",
            "nullable":true
        },
        "dateFormat":{
            "type":"string",
            "description":"Date format used for attributes with the date data type. The default format is YYYY/MM/DD.",
            "nullable":true
        },
        "dataSetName":{
            "type":"string",
            "description":"Name of the data set.",
            "nullable":true
        },
        "contentId":{
            "type":"string",
            "description":"Unique identifier for the file on the Oracle WebCenter content server to be processed.",
            "nullable":true
        },
        "templateCode":{
            "type":"string",
            "description":"Spreadsheet template code to load data.",
            "nullable":true
        },
        "verificationKey":{
            "type":"string",
            "description":"Verification key used for the source file encryption.",
            "nullable":true
        },
        "fileEncryption":{
            "type":"string",
            "description":"Encryption used for the source file. The default is defined by the File Encryption parameter found in the Configure HCM Data Loader task.",
            "nullable":true
        },
        "fileAction":{
            "type":"string",
            "description":"Action for the spreadsheet data. Valid values are IMPORT_AND_LOAD and IMPORT_ONLY. The default is IMPORT_AND_LOAD.",
            "nullable":true
        },
        "headerIncludedFlag":{
            "type":"string",
            "description":"Indicates if a header is included in the source file to name the attributes included in the file. The default value is Y.",
            "nullable":true
        },
        "attributeDelimiter":{
            "type":"string",
            "description":"Characters used to separate values in the file. The default is comma.",
            "nullable":true
        },
        "escapeIndicator":{
            "type":"string",
            "description":"Characters used to escape the delimiter characters within an attribute value. The default is backslash.",
            "nullable":true
        },
        "loadConcurrentThreads":{
            "type":"number",
            "description":"Maximum number of concurrent threads to assign to the load process. The default is defined by the Maximum Concurrent Threads for Load parameter in the Configure HCM Data Loader task.",
            "nullable":true
        },
        "importMaxErrorPercentage":{
            "type":"number",
            "description":"Maximum percentage of records in error before the import ceases. The default is defined by the Maximum Percentage of Import Errors parameter found in the Configure HCM Data Loader task.",
            "nullable":true
        },
        "loadMaxErrorPercentage":{
            "type":"number",
            "description":"Maximum percentage of records in error before the load ceases. The default is defined by the Maximum Percentage of Load Errors parameter found in the Configure HCM Data Loader task.",
            "nullable":true
        },
        "importConcurrentThreads":{
            "type":"number",
            "description":"Maximum number of concurrent threads to assign to the import process. The default is defined by the Maximum Concurrent Threads for Import parameter in the Configure HCM Data Loader task.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Returns the identifier of the data set creation request, or the data set name when only importing data into the staging tables.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Returns the identifier of the data set creation request, or the data set name when only importing data into the staging tables."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Returns the identifier of the data set creation request, or the data set name when only importing data into the staging tables."
}

Returns the identifier of the data set creation request, or the data set name when only importing data into the staging tables.

Back to Top