DownloadThis POST API allows for the creation or updation of ORG entities in Quantum, generating a Batch ID. The data will be processed in the background.
URL Format: https://<Instance>/leo-centraldata-orgstructurebulkservice/api/v1/BulkUpload/orgentities
{
"batchId": "string",
"entityName": "string",
"entityCode": "string",
"entityDescription": "string",
"entityType": "string",
"lobCode": "string",
"parentEntity": "string",
"isActive": true,
"parentEntityCodes": [
"string"
],
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"city": "string",
"state": "string",
"country": "string",
"zipCode": "string",
"fax": "string",
"phone1": "string",
"phone2": "string",
"county": "string",
"poBoxNumber": "string",
"email": "string",
"url": "string",
"parentEntityCodeDelta": [
{
"entityCode": "string",
"isActive": true
}
]
}{
"statusCode": 202,
"url": null,
"batchId": "3ea9eb53-cc13-4bfc-9ef7-e774a485ef70",
"errorDetails": null,
"receivedCount": 1
}Request Payload | ||||
Property | Required? | Data type | Description | Validations / Exceptions |
entityName | Yes | String | Name of the Entity | · Max Length for entity name is 100 · Entity name cannot be null or empty |
entityCode | Yes | String | Code of the Entity | · Max Length for entity code is 50 · Entity code cannot be null or empty |
entityDescription | Optional | String | Entity Description | |
entityType | Yes | String | Entity Type. Validates with Org Structure | · Max Length for entity type is 50 · Invalid Entity Type · Entity type cannot be null or empty |
lobCode | Yes | String | Line Of Business Code. Validates with Org Structure | · Invalid Lob Code · Lob code cannot be null or empty |
parentEntity | Yes | String | Parent Entity Type. Validates with Org Structure | · Max Length for parent entity type is 50 · Parent entity type cannot be null or empty · Invalid Parent Entity Type |
isActive | Yes | Boolean | Status of the Entity if Active or inactive (true/false) | |
parentEntityCodes | Optional | List of String | Parent Entity Code. This will override existing parents for an entity. Validates if provide value exists in system. | · Max Length for parent entity code is 50 · No parent entity codes specified for org entity |
addressLine1 | Optional | String | Address Information | |
addressLine2 | Optional | String | Address Information | |
addressLine3 | Optional | String | Address Information | |
city | Optional | String | City Information | |
state | Optional | String | State Information | |
country | Optional | String | Country Information | |
zipCode | Optional | String | Zip Code | |
fax | Optional | String | Fax | |
phone1 | Optional | String | Phone Number 1 | |
phone2 | Optional | String | Phone Number 2 | |
poBoxNumber | Optional | String | PO Box Number | |
Optional | String | Email Address | ||
url | Optional | String | URL | |
parentEntityCodeDelta | Optional | List of parentEntityCodeDelta Object | Parent Entity Code delta will add/ remove parent for an entity based on isActive true/false. Provided entityCode will be validated in the system. | · EntityCode is mandatory for all ParentEntityCodeDelta items. · IsActive flag is mandatory for all ParentEntityCodeDelta items. |
Response | |||
Property | Required? | Data type | Description |
statusCode | Int | Status Code of the response. Success 200. Failure 500 | |
batchId | String | Batch Id of provided payload. | |
receivedCount | Int | Number of records in payload. | |
ParentEntityCodeDelta | ||||
Property | Required? | Data type | Description | Validations / Exceptions |
entityCode | Optional | String | Entity Code of a Parent | · Max length is 50 · No parent entity codes specified for org entity · EntityCode is mandatory for all ParentEntityCodeDelta items. |
isActive | Optional | Boolean | Status of the Entity if Active or inactive (true/false) | · IsActive flag is mandatory for all ParentEntityCodeDelta items. |