Job State Object
Property | Data Type | Description |
---|---|---|
jobId | UUID v4 | Created Job ID |
userId | number | User id |
jobType | string | Job Type can have the following possible values: IMPORT EXPORT |
jobState | string | Current Job State: CREATED IN PROGRESS COMPLETED FAILED |
startedAt | date | Date when the job was created. Format is ISO8601. |
endedAt | date | Date when the job ended. Format is ISO8601. |
progress | number | percent of completion |
stage | string | completion stage |
errorMessage | string | Error description |
metadata | object | Additional information about process |
Metadata object
property | Data type | Description |
---|---|---|
transactionId | UUID v4 | Request ID |
languageId | number | Language ID |
languageDisplayName | string | Reserved |
finalReport | array | Detailed report |
fileType | string | File Type: XLIFF EXCEL RESJSON |
assetId | string | Asset ID |
Report object
isErrorMessage | boolean | Does report contain failure or success result | Required |
message | string | Contains result text about executed import operation | Required |
status | string | Processed items status (“saved” or “skipped”) | Required |
scope | string | Scope of occurred error | Optional |
exceptionType | string | Error or warning | Optional |
userLanguageId | number | Language identifier | Optional |
relatedObjectId | number | Regular translation item's property | Optional |
languagePartType | string | Regular translation item's property | Optional |
translationKey | string | Wysiwyg translation item's property | Optional |
contextId | string | Wysiwyg translation item's property | Optional |
propertyName | string | Name of translated field | Optional |
contextLabel | string | Wysiwyg translation item's property | Optional |