Intelligent Data Store
Version:2208.0.0-402
APIs to access data managed by the Intelligent Data Store.
API methods: IDS - Aggregation Events APIs
This resource provides APIs to access aggregation events generated by the rule engine.
GET /ids-data-api/v1/aggregation-events/bulk
Streams all the aggregated data for the specified time range
This API retrieves all the aggregated metrics in the specified time range. The response consists of a list of JSON formatted data, separated by newlines.
Responses
- 200
- AggregationEvent
- 400
Returned on invalid input parameters, like wrong date formats, range etc.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
GET /ids-data-api/v1/aggregation-events/history
Get all the aggregated metrics in specified time range
This API retrieves all the aggregated metrics. If rule and metric are specified in the query params then events will filtered based on those params.The query filters should appear in the order timeRange->ruleId->metric and other options for details.
Parameters
- pageSize(query)
Page size
type integer format int32 required false - pagingId(header)
Page ID
type string required false
Responses
- 200
Returned on success.
- Media types
- application/json
Schema type array items $ref AggregationEvent
- 400
Returned on invalid input parameters, like wrong date formats.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
API methods: IDS - Alert Events APIs
This resource provides APIs to access Alerts generated by the rule engine.
GET /ids-data-api/v1/alert-events/bulk
Streams all the alerts raised in the specified time range
This API retrieves all the alerts in the specified time range. The response consists of a list of JSON formatted data, separated by newlines.
Responses
- 200
- AlertEvent
- 400
Returned on invalid input parameters, like wrong date formats, range etc.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
GET /ids-data-api/v1/alert-events/history
Get all the alerts in specified time range
This API retrieves all the alert events. If rule and severity are specified in the query params then events will filtered based on those params.The query filters should appear in the order timeRange->deviceId->ruleId->severity.
Parameters
- pageSize(query)
Page size
type integer format int32 required false - pagingId(header)
Page ID
type string required false
Responses
- 200
Returned on success.
- Media types
- application/json
Schema type array items $ref AlertEvent
- 400
Returned on invalid input parameters, like wrong date formats.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
API methods: IDS - DJR Event Data APIs
This resource provides APIs to access DJR Events.
GET /ids-data-api/v1/djr-events/bulk
Streams all the DJR events in specified time range
This API retrieves all the events of all the devices in the specified time range. The response consists of a list of JSON formatted data, separated by newlines.
Responses
- 200
- DJREvent
- 400
Returned on invalid input parameters, like wrong date formats.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
GET /ids-data-api/v1/djr-events/current/{deviceId}
Get the recent djr events of a specific device.
This API retrieves the most recent DJR events of a device. If a specific jobPrimitive is specified as part of the request params then only the event with that jobPrimitives will be retrieved.
Parameters
- deviceId(path)
ID of the device.
type string required true - jobPrimitive(query)
Primitive Type of the Job.
type string required false
Responses
- 200
Returned on success.
- Media types
- application/json
Schema type array items $ref DJREvent
- 400
Returned when the request is invalid.
- 401
Returned when the user does not have access to the enterprise/group.
- 500
Returned on internal server errors.
GET /ids-data-api/v1/djr-events/history
Get all DJR events in specified time range.
This API retrieves all the DJR events of specified devices. If other parameters are specified, then only the events that matches these parameters will be retrieved.
Parameters
- pageSize(query)
Page size
type integer format int32 required false - pagingId(header)
Page ID
type string required false
Responses
- 200
Returned on success.
- Media types
- application/json
Schema type array items $ref DJREvent
- 400
Returned when the request is invalid.
- 401
Returned when the user does not have access to the enterprise/group.
- 500
Returned on internal server errors.
API methods: IDS - Lifecycle Event Data APIs
This resource provides APIs to access Life Cycle Event Data.
GET /ids-data-api/v1/life-cycle-events/bulk
Streams all the life cycle events in specified time range
This API retrieves all the events of all the devices in the specified time range. The response consists of a list of JSON formatted data, separated by newlines.
Responses
- 200
- LifeCycleEvent
- 400
Returned on invalid input parameters, like wrong date formats.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
GET /ids-data-api/v1/life-cycle-events/current/{deviceId}
Get the recent life cycle event of a device.
This API retrieves the most recent life cycle events of a device. If a specific eventType is specified in as part of the request params then only that specific event will be retrieved.
Parameters
- deviceId(path)
The deviceId.
type string required true - eventType(query)
The eventType
type string enum - REGISTRATION
- DEREGISTRATION
- EXPIRATION
- UPDATE
required false
Responses
- 200
Returned on success.
- Media types
- application/json
Schema type array items $ref LifeCycleEvent
- 400
Returned when specified enterprise / group are invalid.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when no value found for the specified deviceId/eventType.
- 500
Returned on internal server errors.
GET /ids-data-api/v1/life-cycle-events/history
Get all the life cycle events in specified time range
This API retrieves all the events of specified devices' eventTypes in the specified time range. If specific eventTypes are specified in as part of the request params then only those specific events will be retrieved.
Parameters
- pageSize(query)
Page size
type integer format int32 required false - pagingId(header)
Page ID
type string required false
Responses
- 200
Returned on success.
- Media types
- application/json
Schema type array items $ref LifeCycleEvent
- 400
Returned on invalid input parameters, like wrong date formats.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
API methods: IDS - MONTE Events Data APIs
This resource provides APIs to access MONTE Event data.
GET /ids-data-api/v1/monte-events/bulk
Streams all the MONTE events of the specified date range.
This API retrieves all the MONTE events of all the devices in the specified time range. The response consists of a list of JSON formatted data, separated by newlines.
Responses
- 200
- MonteEvent
- 400
Returned on invalid input parameters, like wrong date formats.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
GET /ids-data-api/v1/monte-events/current/{deviceId}
Get the recent MONTE events of a device.
This API retrieves the most recent values of a device's parameters. If a specific subscriptionId and/or eventType is specified as request params then only that specific subscription/eventType will be retrieved.
Parameters
- deviceId(path)
The ID of the device.
required true
Responses
- 200
Returned on success.
- Media types
- application/json
Schema type array items $ref MonteEvent
- 400
Returned when specified enterprise/group are invalid.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when no value found for the specified deviceId/parameter.
- 500
Returned on internal server errors.
GET /ids-data-api/v1/monte-events/history
Get all the monte events in the specified time range
This API retrieves monte events of specified devices' subscriptions in the specified time range. If specific subscriptions/eventTypes are specified in as part of the request params then only those specific parameters will be retrieved.
Parameters
- pageSize(query)
Page size
type integer format int32 required false - pagingId(header)
Page ID
type string required false
Responses
- 200
Returned on success.
- Media types
- application/json
Schema type array items $ref ObservationEvent
- 400
Returned on invalid input parameters, like wrong date formats.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
API methods: IDS - Observation Event Data APIs
This resource provides APIs to access Observation Event data.
GET /ids-data-api/v1/observation-events/bulk
Streams all the values of parameters in specified time range
This API retrieves all the observation events of all the devices in the specified time range. The response consists of a list of JSON formatted data, separated by newlines.
Responses
- 200
- ObservationEvent
- 400
Returned on invalid input parameters, like wrong date formats.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
GET /ids-data-api/v1/observation-events/current/{deviceId}
Get the most recent value of a device parameter
This API retrieves the most recent values of a device's parameters. If a specific parameter is specified in as part of the request params then only that specific parameter will be retrieved.
Parameters
- deviceId(path)
The ID of the device.
type string required true - param(query)
The name of the parameter
type string required false
Responses
- 200
Returned on success.
- Media types
- application/json
Schema type array items $ref ObservationEvent
- 400
Returned when specified enterprise/group are invalid.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when no value found for the specified deviceId/parameter.
- 500
Returned on internal server errors.
GET /ids-data-api/v1/observation-events/history
Get all the values of parameters in specified time range
This API retrieves all the values of specified devices' parameters in the specified time range. If specific parameters are specified in as part of the request params then only those specific parameters will be retrieved.
Parameters
- pageSize(query)
Page size
type integer format int32 required false - pagingId(header)
Page ID
type string required false
Responses
- 200
Returned on success.
- Media types
- application/json
Schema type array items $ref ObservationEvent
- 400
Returned on invalid input parameters, like wrong date formats.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
API methods: IDS - Response Event Data APIs
This resource provides APIs to access Response Event data.
GET /ids-data-api/v1/response-events/bulk
Streams all the response event values of parameters in specified time range
This API retrieves all the response events of all the devices in the specified time range for all the response event type. The response consists of a list of JSON formatted data, separated by newlines.
Responses
- 200
- ResponseEvent
- 400
Returned on invalid input parameters, like wrong date formats.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
GET /ids-data-api/v1/response-events/current/{deviceId}
Get the most recent value of a device parameter
This API retrieves the most recent values for the queried response event of a device's parameters. Response event is a parameter which should be specified to decide the event type as part of the request params then only that specific parameter and event type will be retrieved.
Parameters
- deviceId(path)
The ID of the device.
type string required true - param(query)
The name of the parameter
type string required false - responseType(query)
The name of the parameter for response type
type string enum - read
- write
- exec
- delete
required true
Responses
- 200
Returned on success.
- Media types
- application/json
Schema type array items $ref ResponseEvent
- 400
Returned when specified enterprise/group are invalid.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when no value found for the specified deviceId/parameter.
- 500
Returned on internal server errors.
GET /ids-data-api/v1/response-events/history
Get all the Response Event values of parameters in specified time range for a specific event type
This API retrieves all the response event values of specified devices' parameters and event type in the specified time range. If specific parameters are specified in as part of the request params then only those specific parameters will be retrieved.
Parameters
- pageSize(query)
Page size
type integer format int32 required false - pagingId(header)
Page ID
type string required false
Responses
- 200
Returned on success.
- Media types
- application/json
Schema type array items $ref ResponseEvent
- 400
Returned on invalid input parameters, like wrong date formats.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
API methods: IDS - SMS Delivery Receipt Event Data APIs
This resource provides APIs to access SMS Delivery Receipts Event data.
GET /ids-data-api/v1/sms-dr-events/bulk
Streams all the sms delivery receipt events in specified time range
This API retrieves all the sms delivery receipt events of all the devices in the specified time range. The response consists of a list of JSON formatted data, separated by newlines.
Responses
- 200
- SMSDeliveryReceiptEvent
- 400
Returned on invalid input parameters, like wrong date formats.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
GET /ids-data-api/v1/sms-dr-events/current/{deviceId}
Get the most recent sms delivery receipt for a device
This API retrieves the most recent sms delivery receipts for a device.
Parameters
- deviceId(path)
The ID of the device.
required true
Responses
- 200
Returned on success.
- Media types
- application/json
Schema type array items $ref SMSDeliveryReceiptEvent
- 400
Returned when specified enterprise/group are invalid.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when no value found for the specified deviceId/parameter.
- 500
Returned on internal server errors.
GET /ids-data-api/v1/sms-dr-events/history
Get all the SMS delivery receipts in specified time range
This API retrieves all the SMS delivery receipts in the specified time range. If specific requestId and status are specified as part of the request params then only those specific parameters will be retrieved. Query order requestId -> status.
Parameters
- pageSize(query)
Page size
type integer format int32 required false - pagingId(header)
Page ID
type string required false
Responses
- 200
Returned on success.
- Media types
- application/json
Schema type array items $ref SMSDeliveryReceiptEvent
- 400
Returned on invalid input parameters, like wrong date formats.
- 401
Returned when the user does not have access to the enterprise/group.
- 404
Returned when specified enterprise/group are invalid.
- 500
Returned on internal server errors.
Components
Schemas
AggregationEvent
- Properties
groupName stringdeviceId stringserverTime string(date-time)ruleName stringruleId stringdetails objectadditionalProperties stringmetric stringvalue number(double)windowStartTime string(date-time)windowEndTime string(date-time)
type | object |
AlertEvent
- Properties
groupName stringdeviceId stringserverTime string(date-time)ruleName stringruleId stringdetails objectadditionalProperties stringseverity string
type | object |
DJREvent
- Properties
groupName stringdeviceId stringserverTime string(date-time)requestId stringsubscriberId stringnetworkId stringmake stringmodel stringgroupId stringjobId stringjobName stringjobType stringjobPrimitive stringjobNBICorrelator stringjobGroupId stringjobGroupName stringstartedOn string(date-time)endedOn string(date-time)retries integer(int32)status stringsubStatus stringfaultString stringnativeClientTargeted booleanjobInitiator stringresolvedVariables stringresponse objectadditionalProperties string
type | object |
LifeCycleEvent
- Properties
groupName stringdeviceId stringserverTime string(date-time)deviceType stringmake stringmodel stringfirmwareVersion stringimsi stringaddress stringprotocol stringtags stringsubscriptionId stringdeviceProps objectadditionalProperties stringcustomAttributes objectadditionalProperties stringeventType stringenum - REGISTRATION
- DEREGISTRATION
- EXPIRATION
- UPDATE
type | object |
MonteEvent
- Properties
groupName stringdeviceId stringserverTime string(date-time)subscriptionId stringcreatedTime string(date-time)eventType stringdetails objectadditionalProperties string
type | object |
ObservationEvent
- Properties
groupName stringdeviceId stringserverTime string(date-time)param stringvalue stringsubscriptionId stringcustomAttributes objectadditionalProperties string
type | object |
ResponseEvent
- Properties
groupName stringdeviceId stringserverTime string(date-time)param stringvalue stringrequestId stringresultCode stringresultSubCode stringresultReason stringresponseType stringenum - read
- write
- exec
- delete
type | object |
SMSDeliveryReceiptEvent
- Properties
groupName stringdeviceId stringserverTime string(date-time)imsi stringsubscriberId stringrequestId stringstatus stringenum - DELIVERED
- EXPIRED
- FAILED
errorReason stringframes arrayitems objectadditionalProperties string
type | object |