ResponseFosExportJobDto

Example Json Object

 1{
 2  "code": "UPDATED",
 3  "message": "string",
 4  "defaultMessage": "string",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "errorMessage": "string",
11        "source": {},
12        "field": "string",
13        "errorKey": "string"
14      }
15    ]
16  },
17  "object": {
18    "id": 0,
19    "taskCount": 0,
20    "failedTaskCount": 0,
21    "doneTaskCount": 0,
22    "inProgressTaskCount": 0,
23    "cancelledTaskCount": 0,
24    "errorMessage": "string",
25    "batchSize": 1000,
26    "totalObjectCount": 0,
27    "queueTime": "2019-08-24T14:15:22Z",
28    "startTime": "2019-08-24T14:15:22Z",
29    "endTime": "2019-08-24T14:15:22Z",
30    "status": "CREATED",
31    "fileStorageId": "string",
32    "generatingExportFile": true,
33    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
34    "version": 0,
35    "readOnly": true,
36    "docStoreId": 0,
37    "erpSystemId": 0,
38    "category": "NON_ERP",
39    "items": [
40      "INTERNAL_ASSET_CLASS"
41    ]
42  }
43}

📄 Description: Data transfer object representing the details of a financial organization structure export job, including its status and associated metadata, facilitating the management of hierarchical relationships within financial entities.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains a descriptive message related to the status or outcome of the financial organization structure export job.

defaultMessage

string

false

write-only

Default message to be displayed for the financial organization structure export job, providing context for the hierarchy and organization of financial entities.

debugMessage

string

false

write-only

Provides detailed information regarding any issues encountered during the export of financial organization structure jobs, aiding in troubleshooting and ensuring data integrity.

errors

Errors

false

none

Value for errors field

object

FosExportJobDto

false

none

Value for object field

Enumerated Values

Attribute

Value

code

API_CALL_FAILED, ATTACHED, BAD_REQUEST, DATA_VALIDATION_ERROR, DELETED, DETACHED, INTERNAL_SYSTEM_ERROR, NULL_RESPONSE, OK, OK_BUT_RESPONSE_INVALID, REQUEST_VALIDATION_ERROR, SERVICE_VALIDATION_ERROR, UPDATED