Run a Data Load

post/datamart.rundataload

Schedules a Data Load for immediate (but asynchronous) execution.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
object
version
number
typedId
required
string non-empty

Use the typedId to run calculations. For other types (flush, refresh or truncate), use targetName (and sourceName).

label
string non-empty
type
string non-empty

The Data Load Type.

Possible values: "CALCULATION" "DM_REFRESH" "DM_SIMULATION" "DS_CUSTOMERS" "DS_DEFAULTCA" "DS_FLUSH" "DS_PRODUCTSL" "TRUNCATE"
targetName
required
string non-empty

Use the typedId to run calculations. For other types (flush, refresh or truncate), use targetName (and sourceName).

sourceName
required
string non-empty
withTargetSnapshot
boolean
schedules
Array of objects
numberOfItems
number
object
feederInputParams
Array of objects
inputParams
Array of objects
mappingParams
Array of objects
outputElements
Array of objects
requestTime
number
lastUpdateTime
number
createDate
string non-empty
createdBy
number
lastUpdateDate
string non-empty
lastUpdateBy
number
status
string non-empty
isDefault
boolean
incremental
boolean
distributed
boolean
continuous
boolean
valid
boolean
isPlasma
boolean
Responses
200

OK

Response Schema: application/json
object
node
string non-empty
Array of objects non-empty unique
Array (non-empty)
version
number
typedId
string non-empty
targetDate
any
label
required
string non-empty
locale
any
type
string non-empty
targetName
string non-empty
sourceName
string non-empty
loadMode
any
sortBy
any
sourceSortBy
any
dtoFilter
any
dtoSourceFilter
any
withTargetSnapshot
boolean
calculationContext
any
allowBatching
any
validationLogic
any
calcItemsLookupTableId
any
schedules
any
jstId
required
number
progressInfo
any
numberOfItems
required
number
actionUUID
any
testRow
any
testResult
any
resultTableUniqueName
any
pre80CalculationConfig
any
object
requestTime
number
lastUpdateTime
number
loadCompleteTime
any
adhocDataLoadDefinition
any
createDate
string non-empty
createdBy
number
lastUpdateDate
string non-empty
lastUpdateBy
number
status
string non-empty
calculationStartDate
any
calculationDate
any
isDefault
boolean
incremental
boolean
distributed
boolean
continuous
boolean
valid
boolean
isPlasma
boolean
incLoadDate
any
status
number
Request samples
application/json
{
  • "data": {
    • "version": 0,
    • "typedId": "2147483666.DMDL",
    • "label": "Product",
    • "type": "DS_FLUSH",
    • "targetName": "DMDS.Product",
    • "sourceName": "DMF.Product",
    • "withTargetSnapshot": false,
    • "schedules": [ ],
    • "numberOfItems": 0,
    • "calculationConfig": {
      • "feederInputParams": [ ],
      • "inputParams": [ ],
      • "mappingParams": [ ],
      • "outputElements": [ ]
      },
    • "requestTime": 1488985402000,
    • "lastUpdateTime": 1488985402000,
    • "createDate": "2017-03-08T15:03:22",
    • "createdBy": 2147483649,
    • "lastUpdateDate": "2017-03-08T15:03:22",
    • "lastUpdateBy": 2147483649,
    • "status": "DRAFT",
    • "isDefault": true,
    • "incremental": true,
    • "distributed": false,
    • "continuous": false,
    • "valid": true,
    • "isPlasma": false,
    • "incLoadDate": "2021-12-09T11:08:01.600Z"
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "string",
        • "targetDate": null,
        • "label": "string",
        • "locale": null,
        • "type": "string",
        • "targetName": "string",
        • "sourceName": "string",
        • "loadMode": null,
        • "sortBy": null,
        • "sourceSortBy": null,
        • "dtoFilter": null,
        • "dtoSourceFilter": null,
        • "withTargetSnapshot": true,
        • "calculationContext": null,
        • "allowBatching": null,
        • "validationLogic": null,
        • "calcItemsLookupTableId": null,
        • "schedules": null,
        • "jstId": 0,
        • "progressInfo": null,
        • "numberOfItems": 0,
        • "actionUUID": null,
        • "testRow": null,
        • "testResult": null,
        • "resultTableUniqueName": null,
        • "pre80CalculationConfig": null,
        • "calculationConfig": {
          },
        • "requestTime": 0,
        • "lastUpdateTime": 0,
        • "loadCompleteTime": null,
        • "adhocDataLoadDefinition": null,
        • "createDate": "string",
        • "createdBy": 0,
        • "lastUpdateDate": "string",
        • "lastUpdateBy": 0,
        • "status": "string",
        • "calculationStartDate": null,
        • "calculationDate": null,
        • "isDefault": true,
        • "incremental": true,
        • "distributed": true,
        • "continuous": true,
        • "valid": true,
        • "isPlasma": true,
        • "incLoadDate": null
        }
      ],
    • "status": 0
    }
}