Get business object
GET/v2/illuminate/business-objects/:id
Returns details for a specific business object.
Request
Example
{
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"createdBy": "string",
"updatedBy": "string",
"id": "string",
"name": "string",
"isActive": false,
"description": "string",
"fields": [
{
"id": "string",
"name": "string",
"jsonPath": "string",
"jsonFieldType": "TEXT",
"isKeyset": false,
"source": "JSONPATH",
"derivation": {
"operation": "TIME_DIFF",
"params": {}
}
}
],
"accountId": "string",
"subkeys": [
"string"
],
"metrics": [
{
"id": "string",
"name": "string",
"measureId": "string",
"businessObjectId": "string",
"evaluationWindow": 0,
"function": "string",
"dimensionIds": [
"string"
],
"dimensions": [
{}
],
"filters": [
{}
]
}
],
"decisions": [
{
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"createdBy": "string",
"updatedBy": "string",
"id": "string",
"name": "string",
"description": "string",
"accountId": "string",
"businessObjectId": "string",
"sourceType": "BUSINESSOBJECT",
"sourceId": "string",
"hitType": "SINGLE",
"enabled": false,
"activeFrom": "2024-01-01T00:00:00.000Z",
"activeUntil": "2024-01-01T00:00:00.000Z",
"executeOnce": false,
"executionFrequency": 0,
"inputFields": [
{}
],
"outputFields": [
{}
],
"rules": [
{}
],
"actions": [
{}
],
"metric": {
"id": "string",
"name": "string",
"measureId": "string",
"businessObjectId": "string",
"evaluationWindow": 0,
"function": "string",
"dimensionIds": [],
"dimensions": [],
"filters": []
},
"query": {
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"createdBy": "string",
"updatedBy": "string",
"decisions": [],
"customer": {},
"businessObjects": [],
"id": "string",
"name": "string",
"description": "string",
"definition": {},
"template": "string",
"accountId": "string"
},
"customer": {
"id": "string",
"name": "string"
}
}
],
"dashboards": [
{
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"createdBy": "string",
"updatedBy": "string",
"id": "string",
"name": "string",
"accountId": "string",
"dateRange": "30 minutes",
"startDate": "2024-01-01T00:00:00.000Z",
"endDate": "2024-01-01T00:00:00.000Z",
"charts": [
{}
],
"customer": {
"id": "string",
"name": "string"
}
}
],
"queries": [
{
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"createdBy": "string",
"updatedBy": "string",
"decisions": [
{}
],
"customer": {
"id": "string",
"name": "string"
},
"businessObjects": [],
"id": "string",
"name": "string",
"description": "string",
"definition": {
"version": "string",
"pipeline": {},
"meta": {}
},
"template": "string",
"accountId": "string"
}
],
"customers": [
{
"id": "string",
"name": "string"
}
]
}