Jump to

• Request
• Response

Submit HCM Data Loader

post

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

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

• contentId: string
  Unique identifier of the file on the Oracle WebCenter content server.
• dataSetName: string
  Name of the data set.
• deleteSourceFileFlag: string
  Indicates if the source file should be deleted after the data is imported into the staging tables.
• fileAction: string
  Action for the data set. Valid values are IMPORT_AND_LOAD and IMPORT_ONLY. The default is defined by the File Action parameter in the Configure HCM Data Loader task.
• 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.
• 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.
• verificationKey: string
  Verification key used for the source file encryption.

{
    "type":"object",
    "properties":{
        "deleteSourceFileFlag":{
            "type":"string",
            "description":"Indicates if the source file should be deleted after the data is imported into the staging tables.",
            "nullable":true
        },
        "dataSetName":{
            "type":"string",
            "description":"Name of the data set.",
            "nullable":true
        },
        "contentId":{
            "type":"string",
            "description":"Unique identifier of the file on the Oracle WebCenter content server.",
            "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
        },
        "verificationKey":{
            "type":"string",
            "description":"Verification key used for the source file encryption.",
            "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
        },
        "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 data set. Valid values are IMPORT_AND_LOAD and IMPORT_ONLY. The default is defined by the File Action parameter 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.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Returns the identifier of the data set creation request."
        }
    },
    "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."
}

Returns the identifier of the data set creation request.

Back to Top