ResponseListBatchProfileDto

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

📄 Description: Data transfer object representing a batch profile response, encapsulating multiple profile details and their associated statuses for streamlined processing and analysis in workforce management.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains the detailed message or notification related to the batch profile response, providing essential context for the user’s review and action.

defaultMessage

string

false

write-only

Default message to be displayed in the response when no specific message is provided, ensuring consistent communication with users.

debugMessage

string

false

write-only

Provides detailed information about any errors or issues encountered during the processing of the batch profile response.

errors

Errors

false

none

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

object

[BatchProfileDto]

false

none

Array of response list batch profiles, providing a collection of relevant data for efficient processing and analysis within the system.

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