Device Job Result Events

This section provides examples for Device Job Result (DJR) Event types.

Current API

URI Method Description 
/ids-data-api/v1/djr-events/current/{deviceId}?jobPrimitive=<primitive>
 GET This API retrieves the most recent DJR events of the specified device. It provides an option to filter the data for specific jobPrimitive.

Method: GET

URI: 

http://<<IDShostname>>/ids-data-api/v1/djr-events/current/352253064335021

Response: 200 OK:

[{"groupName":"waterco","deviceId":"352253064335021", "serverTime":"2021-02-01T09:22:00.968+0000", "requestId":"Req456730.7148219156814", "subscriberId":"null", "networkId":"null", "make":"null", "model":"null", "groupId":"null", "jobId":"1", "jobName":"null", "jobType":"null", "jobPrimitive":"delete", "jobNBICorrelator":"null", "jobGroupId":"null", "jobGroupName":"null", "startedOn":"2021-02-01T09:22:01.009+0000", "endedOn":"2021-02-01T09:22:01.002+0000", "retries":1, "status":"success", "subStatus":"null", "faultString":"null", "nativeClientTargeted":false, "jobInitiator":"null", "resolvedVariables":"null", "response":{"device/0/pressure":"100"}}]

Historical API

URI Method Description 
/ids-data-api/v1/djr-events/history?fromTime=<fromTime>&toTime=<toTime>&deviceId=<deviceIds>&jobStatus=<status>&jobPrimitive=<primitives>&jobId=<JobIDs>
 GET

This API retrieves all the DJR events of specified devices. If other parameters are specified, then only the events that match these parameters will be retrieved.

When filtering by jobPrimitive, jobStatus is mandatory.

When filtering by jobId, jobStatus and jobPrimitive are mandatory.

Method: GET

URI: 
http://<<IDShostname>>/ids-data-api/v1/djr-events/history?deviceId=352253064335021&fromTime=2021-01-04T01:35:06.095Z&toTime= 2021-03-08T01:35:06.095Z&jobStatus=success&jobPrimitive=delete&jobId=1&pageSize=5

Response: 200 OK:

[{"groupName":"waterco","deviceId":"352253064335021", "serverTime":"2021-02-01T09:22:00.968+0000", "requestId":"Req456730.7148219156814", "subscriberId":"null", "networkId":"null", "make":"null", "model":"null", "groupId":"null", "jobId":"1", "jobName":"null", "jobType":"null", "jobPrimitive":"delete", "jobNBICorrelator":"null", "jobGroupId":"null", "jobGroupName":"null", "startedOn":"2021-02-01T09:22:01.009+0000", "endedOn":"2021-02-01T09:22:01.002+0000", "retries":1, "status":"success", "subStatus":"null", "faultString":"null", "nativeClientTargeted":false, "jobInitiator":"null", "resolvedVariables":"null", "response":{"device/0/pressure":"100"}}]

Bulk APIs

URI Method Description 
/ids-data-api/v1/djr-events/bulk?fromTime=<fromTime>&toTime=<toTime>
 GET

This API retrieves all the DJR events of all the devices in the specified time range.

The response consists of a list of JSON formatted data, separated by newlines.

Method: GET

URI: 
http://<<IDShostname>>/ids-data-api/v1/djr-events/bulk?fromTime=2020-01-07T01:35:06.095Z&toTime=2021-03-08T01:35:06.095Z

Response: 200 OK:

{"groupName":"waterco","deviceId":"352253064335021", "serverTime":1612171320968,"requestId":"Req456730.7148219156814", "subscriberId":"null", "networkId":"null", "make":"null","model":"null", "groupId":"null","jobId":"1","jobName":"null", "jobType":"null","jobPrimitive":"delete", "jobNBICorrelator":"null","jobGroupId":"null", "jobGroupName":"null","startedOn":1612171321009, "endedOn":1612171321002,"retries":1, "status":"success","subStatus":"null", "faultString":"null","nativeClientTargeted":false, "jobInitiator":"null","resolvedVariables":"null", "response":{"device/0/pressure":"100"}}
{"groupName":"waterco","deviceId":"352253064335022", "serverTime":1612171320968,"requestId":"Req456730.7148219156816", "subscriberId":"null", "networkId":"null", "make":"null","model":"null", "groupId":"null","jobId":"1","jobName":"null", "jobType":"null","jobPrimitive":"delete", "jobNBICorrelator":"null","jobGroupId":"null", "jobGroupName":"null","startedOn":1612171321009, "endedOn":1612171321002,"retries":1, "status":"success","subStatus":"null", "faultString":"null","nativeClientTargeted":false, "jobInitiator":"null","resolvedVariables":"null", "response":{"device/0/pressure":"100"}}