Response from the endpoint

Main object

FieldData TypeDescription
StatusstringCurrent execution status. One of this options Queued, InProgress, Complete, InError, NotFound
ResultstringExecution result. Return ERROR if the Status is InError, otherwise OK
Successbooleanresult of the request
ErrorMessagestringif some problem happens and the success is false, this is the error message
Logsstringif the request parameter IncludeLogs set to true, this is a zip file base64 encoded. The zip can have multiple files with all the execution logs.
ZipFilestringif the request parameter IncludeFiles set to true and the execution is a export to file, this is a zip file base64 encoded. The zip file contains some system entity tables (files ossys_*), the entities metadata (files *_Struct.dmm) and the entities records (files *_Data.csv)
ReportReportif the request parameter IncludeReports set to true, this object will be with the execution report values
ErrorReportstringif the request parameter IncludeErrorReport set to true, this is a array of json object base64 encoded. For each entity with error, will be created a json with the following format
{
"FinalReportEntity": "Entity name",
"FinalReportError": "Error message",
"FinalReportStacktrace": "Exception stack trace",
"FinalReportTip": "Could have some tips in how to solve/understand the error",
"FinalReportMoment": "Time of the first error (yyyy-MM-dd HH:mm:ss)",
"Count": "Number of chunks with this error (in the same entity)"
}

Report object

FieldData TypeDescription
ConfigurationTypestringtype of the execution (Migration, Import, Export or Delete)
ExecutionDatestringStart time (yyyy-MM-dd HH:mm:ss)
ExecutionDurationstringExecution duration (HH:mm:ss)
BPTDataVolumeintegerTotal size of BPT records
DataVolumeintegerTotal size of entities records
NBPTRecordsintegerTotal number of BPT records
NInstructionsintegerTotal number of instructions
NRecordsintegerTotal number of entities records