Jump to

• Request
• Response

Submit data set processing

post

/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/action/submit

Submits a request to load or rollback a data set. Roll back is only initiated for business objects that support the roll back action.

Request

Path Parameters

• RequestId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• fileAction: string
  Action to perform for the data set. Valid values are LOAD and ROLLBACK. Default value is LOAD.
• loadConcurrentThreads: number
  Maximum number of concurrent threads to assign to the load process.

{
    "type":"object",
    "properties":{
        "loadConcurrentThreads":{
            "type":"number",
            "description":"Maximum number of concurrent threads to assign to the load process.",
            "nullable":true
        },
        "fileAction":{
            "type":"string",
            "description":"Action to perform for the data set. Valid values are LOAD and ROLLBACK. Default value is LOAD.",
            "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

  Status of the submit request. Returns the request identifier of the parent process when the request was submitted successfully. It's used to identify the processes submitted to process the business objects within the data set.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Status of the submit request. Returns the request identifier of the parent process when the request was submitted successfully. It's used to identify the processes submitted to process the business objects within the data set."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Status of the submit request. Returns the request identifier of the parent process when the request was submitted successfully. It's used to identify the processes submitted to process the business objects within the data set."
}

Status of the submit request. Returns the request identifier of the parent process when the request was submitted successfully. It's used to identify the processes submitted to process the business objects within the data set.

Back to Top