Lifecycle Events

This section provides examples for Lifecycle event types.

Current APIs

URI Method Description 
ids-data-api/v1/life-cycle-events/current/{deviceId}?<eventType>=<eventType>
 GET This API retrieves the most recent lifecycle events of the specified device. It also provides an option to further filter the data for a specific eventType by providing a query eventType. The supported eventTypes include REGISTRATION, DEREGISTRATION, EXPIRATION, UPDATE.

Method: GET

URI: http://<<IDShostname>>/ids-data-api/v1/life-cycle-events/current/impact30082018?eventType=DEREGISTRATION

Response: 200 OK:


[
    {
        "groupName": "enterprise_auto1",
        "serialNumber": "impact30082018",
        "serverTime": "2018-08-30T10:19:52.802+0000",
        "deviceProps": {},
        "customAttributes": {},
        "eventType": "DEREGISTRATION"
    }
]

Historical APIs

URI Method Description 
/ids-data-api/v1/life-cycle-events/history?
fromTime=<fromTime>&toTime=<toTime>&deviceId=<deviceIds>&
<eventType>=<eventTypes>
 GET

This API retrieves all the lifecycle events of the specified list of devices in the specified time range. It also provides an option to further filter the data for a list of specific eventTypes by providing a query eventType. The supported eventTypes include REGISTRATION, DEREGISTRATION, EXPIRATION, UPDATE.

Method: GET

URI: 
http://<<IDShostname>>/ids-data-api/v1/life-cycle-events
/history?fromTime=2015-05-22T00:00:00&toTime=2020-06-30T23:00:00
&deviceId=impact30082018&eventType=DEREGISTRATION&pageSize=1&tenant=enterprise_auto1

Response: 200 OK


       [
    {
        "groupName": "enterprise_auto1",
        "serialNumber": "impact30082018",
        "serverTime": "2018-08-30T10:19:52.802+0000",
        "deviceProps": {},
        "customAttributes": {},
        "eventType": "DEREGISTRATION"
    }
]

Bulk APIs

URI Method Description 
/ids-data-api/v1/life-cycle-events/bulk?fromTime=<fromTime>&toTime=<toTime>
 GET This API retrieves data across all devices in the specified time range and streams it to the client.

Method:: GET

URI: 
http://<<IDShostname>>/ids-data-api/v1/life-cycle-events/bulk?fromTime=2017-01-25T00:00:00&toTime=2020-06-17T23:00:00
Response: 200 OK

{"groupName":"enterprise_auto1","serialNumber":"impact30082018", "serverTime":"2018-08-30T10:19:52.802+0000", "deviceProps":{},"customAttributes":{}, "eventType":"DEREGISTRATION"}
{"groupName":"enterprise_auto1","serialNumber":"impact30082019", "serverTime":"2018-09-30T10:19:52.802+0000", "deviceProps":{},"customAttributes":{}, "eventType":"DEREGISTRATION"}
{"groupName":"enterprise_auto1","serialNumber":"impact30082017", "serverTime":"2019-08-30T10:19:52.802+0000", "deviceProps":{},"customAttributes":{}, "eventType":"EXPIRATION"}
{"groupName":"enterprise_auto1","serialNumber":"impact30082018", "serverTime":"2019-09-30T10:19:52.802+0000", "deviceProps":{},"customAttributes":{}, "eventType":"UPDATE"}