Acquire a list of Access Logs

This is an API function to acquire a list of Access Logs. This API function corresponds to the operation on the screen that is displayed by clicking the [Access Log] tab after selecting the [Logs] on the operation screen of Manager.

Format

curl -X GET --header 'Accept: application/json'

--header 'X-API-KEY:APIKEY'

'http://HOSTNAME:PORTNUMBER/api/v1/device-access-logs?REQUESTINQUERYFORMAT'

Request parameter (Query format)
Item name Request parameter Type Value Default value

Access Date and Time

(start)

geAccessedDate Integer

Specify the value by using a "yyyyMMddHHmm" format.

• yyyy: year

• MM: month

• dd: day

• HH: hour

• mm: minute

(Example: 201803190301)

You can specify one parameter only. If you specify both parameters, you can set a period of a search target.

 

Access Date and Time

(end)

leAccessedDate Integer  
Agent ID agentId String Exact match  
Agent Version agentVersion Integer    
Module Version moduleVersion String Exact match  
Profile ID profileId String Exact match  
Profile Version profileVersion Integer    

Access Log Type

type String

"FULLSET" | "VERSION" | "UPDATE_STATUSES"

• "FULLSET": Settings Acquisition

• "VERSION": Version Confirmation

• "UPDATE_STATUSES": Update Statuses

 
Unit ID unitId String Exact match  
Unit Version unitVersion Integer    
Sort Order sort String

"+parameter-name" | "-paramater-name"

• +: Ascending order

• -: Descending order

If you specify multiple parameters, divide values by a comma (,).

-accessedDate
Number of pages page Integer

Specify a number from zero.

If the number of pages is 1, specify 0.

0
Number of items per page size Integer   10
Parameters that can be set to Sort Order
Item name Parameter name
Access Date and Time accessedDate
Agent ID agentId
Agent Version agentVersion
Version of Module that is attached by using the Agent List screen. attachedModuleVersion
Access Log ID deviceAccessLogId
Module Version moduleVersion
Polling Interval pollingInterval
Profile ID profileId
Profile Version profileVersion
Access Log Type type
Unit ID unitId
Unit Version unitVersion
Response

{

"content": [

{

"accessedDate": 0,

"agentId": "string",

"agentVersion": 0,

"attachedModuleVersion": "string",

"deviceAccessLogId": "string",

"moduleVersion": "string",

"pollingInterval": 0,

"profileId": "string",

"profileVersion": 0,

"type": "string",

"unitId": "string",

"unitVersion": 0

}

],

"first": true,

"last": true,

"number": 0,

"numberOfElements": 0,

"size": 0,

"sort": [],

"totalElements": 0,

"totalPages": 0

}

Response parameter
Item name Response parameter Type Value
Access Date and Time content accessedDate Integer  
Agent ID agentId String  
Agent Version agentVersion Integer  
Version of Module that is attached by using the Agent List screen. attachedModuleVersion String  
Access Log ID deviceAccessLogId String  
Module Version moduleVersion String  
Polling Interval pollingInterval Integer  
Profile ID profileId String  
Profile Version profileVersion Integer  
Access Log Type type String

"FULLSET" | "VERSION" | "UPDATE_STATUSES"

• "FULLSET": Settings Acquisition

• "VERSION": Version Confirmation

• "UPDATE_STATUSES": Update Statuses

Unit ID unitId String  
Unit Version unitVersion Integer  

For details about the parameters for page settings (first, last, number, numberOfElements, size, sort, totalElements, totalPages), see Response parameters for page settings.