ResponseBatchProfileDto

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    "name": "string",
 20    "principalPositionType": "LESSEE",
 21    "erpSystemFilterType": "ALL",
 22    "erpSystems": [
 23      {
 24        "id": 0,
 25        "displayId": "string",
 26        "status": "CREATED",
 27        "name": "string"
 28      }
 29    ],
 30    "leaseAreaFilterType": "ALL",
 31    "leaseAreas": [
 32      {
 33        "id": 0,
 34        "displayId": "string",
 35        "status": "CREATED",
 36        "name": "string"
 37      }
 38    ],
 39    "businessUnitFilterType": "ALL",
 40    "businessUnits": [
 41      {
 42        "id": 0,
 43        "displayId": "string",
 44        "status": "CREATED",
 45        "name": "string"
 46      }
 47    ],
 48    "companyFilterType": "ALL",
 49    "companyCodes": [
 50      {
 51        "id": 0,
 52        "displayId": "string",
 53        "status": "CREATED",
 54        "erpSystemId": 0,
 55        "erpSystemDisplayId": "string",
 56        "countryId": 0,
 57        "countryDisplayId": "string",
 58        "name": "string"
 59      }
 60    ],
 61    "departmentFilterType": "ALL",
 62    "leaseDepartments": [
 63      {
 64        "id": 0,
 65        "displayId": "string",
 66        "status": "CREATED",
 67        "name": "string"
 68      }
 69    ],
 70    "leaseGroupFilterType": "ALL",
 71    "leaseGroups": [
 72      {
 73        "id": 0,
 74        "displayId": "string",
 75        "status": "CREATED",
 76        "name": "string"
 77      }
 78    ],
 79    "costCenterFilterType": "ALL",
 80    "costCenters": [
 81      {
 82        "id": 0,
 83        "displayId": "string",
 84        "status": "CREATED",
 85        "name": "string"
 86      }
 87    ],
 88    "profitCenterFilterType": "ALL",
 89    "profitCenters": [
 90      {
 91        "id": 0,
 92        "displayId": "string",
 93        "status": "CREATED",
 94        "name": "string",
 95        "validTo": "2019-08-24",
 96        "erpSystemId": 0,
 97        "erpSystemDisplayId": "string"
 98      }
 99    ],
100    "workBreakdownStructureFilterType": "ALL",
101    "workBreakdownStructures": [
102      {
103        "id": 0,
104        "displayId": "string",
105        "status": "CREATED",
106        "name": "string"
107      }
108    ],
109    "objectStatus": "CREATED",
110    "securityProfileId": 0,
111    "businessAreaFilterType": "ALL",
112    "businessAreas": [
113      {
114        "id": 0,
115        "displayId": "string",
116        "status": "CREATED",
117        "name": "string"
118      }
119    ],
120    "functionalAreaFilterType": "ALL",
121    "functionalAreas": [
122      {
123        "id": 0,
124        "displayId": "string",
125        "status": "CREATED",
126        "name": "string"
127      }
128    ],
129    "filterObjectDto": {
130      "id": 0,
131      "profileId": 0,
132      "displayId": "string",
133      "objectType": "string"
134    },
135    "assetClassFilterType": "ALL",
136    "assetClasses": [
137      {
138        "id": 0,
139        "displayId": "string"
140      }
141    ],
142    "cpiCategoryFilterType": "ALL",
143    "cpiCategories": [
144      {
145        "id": 0,
146        "displayId": "string"
147      }
148    ],
149    "scriptProfile": true
150  }
151}

📄 Description: Data transfer object representing a batch of responses associated with a specific profile, including relevant metadata for tracking and analysis within the business context.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains the informational message related to the response batch profile, providing context or details pertinent to the transaction.

defaultMessage

string

false

write-only

Default message to be displayed in response batches, providing users with a standardized communication template.

debugMessage

string

false

write-only

Provides detailed information about any errors or issues encountered during the processing of the batch profile, aiding in troubleshooting and resolution.

errors

Errors

false

none

Collection of error messages encountered during the processing of the batch profile request, providing insights for troubleshooting and resolution.

object

BatchProfileDto

false

none

Represents a collection of response batch profiles, providing essential data for managing and analyzing batch processing activities.

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