Acquire a list of Agent instances

This is an API function to acquire a list of Agent instances. This API function corresponds to the operation on the screen that is displayed by selecting the [Agent] on the operation screen of Manager.

= Remarks =

The response parameters under the content layer of this API function are the same as the response parameters of the acquire an Agent instance details API function.
Format
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            'http://HOSTNAME:PORTNUMBER/api/v1/agents?REQUESTINQUERYFORMAT'
Request parameter (Query format)
Item name Request parameter Type Value Default value
Agent ID agentId String Exact match  
Agent Name agentName String Partial match  
Host Name host String Partial match  

Registration Date and Time

(start)

 geRegistrationDate Integer

Specify the value by using a "yyyyMMddHHmmssSSS" format.

•　yyyy: year

•　MM: month

•　dd: day

•　HH: hour

•　mm: minute

•　ss: second

•　SSS: millisecond

(Example: 20180319030101000)

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

  

Registration Date and Time

(end)

 leRegistrationDate Integer  
MAC address macAddress String Partial match  
Unit ID unitId String

When you search Agent to which Unit has not been allocated, specify "none".

Partial match

  
Unit Name unitName String Partial match  
Profile ID profileId String

When you search Agent to which Profile has not been allocated, specify "none".

Partial match

  
Profile Name profileName String Partial match  

Agent status

 status String

"ON"　|　"OFF"

•　ON: Agent is in use.

•　OFF: Agent is on standby.

  
Sort Order sort String

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

•　+: Ascending order

•　-: Descending order

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

 +name

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
Agent ID agentId

Agent Version　(Settings history)

 agentVersion
Auto Resend Retry Count basicSettings.autoResendingRetryCount
Auto Resend Retry Interval basicSettings.autoResendingRetryInterval
Connection Retry Count basicSettings.connectionRetryCount
Connection Retry Interval basicSettings.connectionRetryInterval
Log Output Mode basicSettings.historyMode
Job Timeout (Time) basicSettings.jobTimeout
Job Timeout (Valid or Invalid) basicSettings.receivingTaskQueueSize
Request Timeout basicSettings.requestTimeout
Send Process Multiplex Level basicSettings.sendProcessMultiplexLevel

Socket Buffer Size　 (Byte count)

 basicSettings.socketBufferSize

Socket Buffer Size　 (Type)

 basicSettings.socketBufferSizeMode
Socket Read Timeout basicSettings.socketTimeout
Communication Time Limit basicSettings.communicationTimeLimitEnabled
Start Time (Communication Time Limit) basicSettings.startCommunicationTimeHour
End Time (Communication Time Limit) basicSettings.endCommunicationTimeHour
Agent Bit Count bit
Agent Architecture cpu
Access Date and Time deviceAccessLog.accessedDate
Agent ID deviceAccessLog.agentId

Agent Version (Settings history)

 deviceAccessLog.agentVersion
Module Version (Current) deviceAccessLog.attachedModuleVersion
Access Log ID deviceAccessLog.deviceAccessLogId

Module Version (To be allocated)

 deviceAccessLog.moduleVersion
Polling Interval deviceAccessLog.pollingInterval
Profile ID deviceAccessLog.profileId
Profile Version deviceAccessLog.profileVersion
Access Log Type deviceAccessLog.type
Unit ID deviceAccessLog.unitId
Unit Version deviceAccessLog.unitVersion
Make Auto Resend Retry Count static lockDown.autoResendingRetryCount
Make Auto Resend Retry Interval static lockDown.autoResendingRetryInterval
Make Connection Retry Count static lockDown.connectionRetryCount
Make Connection Retry Interval static lockDown.connectionRetryInterval
Make Log Output Mode static lockDown.historyMode
Make Job Timeout (Time) static lockDown.jobTimeout
Make Job Timeout (Valid or Invalid) static lockDown.jobTimeoutEnabled
Make Polling Interval static lockDown.pollingInterval
Make Receive Queue Polling Interval static lockDown.receivingQueuePollingInterval
Make Request Timeout static lockDown.requestTimeout
Make Send Log Pool Size static lockDown.sendLogPoolSize
Make Send Process Multiplex Level static lockDown.sendProcessMultiplexLevel
Make Socket Buffer Size static lockDown.socketBufferSize
Make Socket Read Timeout static lockDown.socketTimeout
Make Trace Log Pool Size static lockDown.traceLogPoolSize
Make Communication Time Limit static lockDown.communicationTimeLimitEnabled
Make Start Time static (Communication Time Limit) lockDown.startCommunicationTimeHour
Make End Time static (Communication Time Limit) lockDown.endCommunicationTimeHour
MAC address macAddress
Module Version moduleVersion

Update of the module

 moduleVersionUpdated
Agent Name name
OS os
Region otherInfo.region
Floating Point Operation of Agent otherInfo.floating
Profile ID profile.profileId
Profile Name profile.profileName
Update of Profile profileVersionUpdated
Registration Date and Time registrationDate
Remarks agentRemarks.remarks
Agent ID sendLog.agentId
Agent Name sendLog.agentName
Encryption Type sendLog.cipherType
Compression Ratio sendLog.compressedRate
Transfer Block Length sendLog.dTelegramLen
Data Size (Send) sendLog.dataSize
Detail Code (Send) sendLog.detailCode
End Code of Unsuccessful Job sendLog.errorJobExitCode
Unsuccessful Job sendLog.errorJobName
End Code (Send) sendLog.exitCode
File ID (Send file) sendLog.fileId

Host Name (Send destination)

 sendLog.hostName
Latest Processing Identifier sendLog.latestProcessId
Latest Transfer Identifier sendLog.latestTransferId
End code of Pre-send Job sendLog.preJobExitCode
Pre-send Job sendLog.preJobName
Profile ID sendLog.profileId
Profile Name sendLog.profileName
Record Count sendLog.recordCount
Send Log ID sendLog.sendLogId
Send End Date and Time (String) sendLog.sndEndTimeStr
Send End Date and Time (UTC) sendLog.sndEndTimeUtc
Send File name sendLog.sndFileName
Send Start Date and Time (String) sendLog.sndStartTimeStr
Send Start Date and Time (UTC) sendLog.sndStartTimeUtc
Starting Identifier sendLog.startProcessId
Start Transfer Identifier sendLog.startTransferId
End code of Successful Job sendLog.successJobExitCode
Successful Job sendLog.successJobName
Transmission Rate sendLog.transferRate
Transfer Type sendLog.transferType
Trigger Fire Event sendLog.triggerEvent
File Status When Firing Trigger sendLog.triggerStatus
Unit ID sendLog.unitId
Unit Name sendLog.unitName
Agent status status
Unit ID unit.unitId
Unit Name unit.unitName
Update of Unit unitVersionUpdated
Response
{
  "content": [
    {
      "agentId": "string",
      "agentVersion": 0,
      "agentVersionSyncronized": true,
      "basicSettings": {
        "autoResendingRetryCount": 0,
        "autoResendingRetryInterval": 0,
        "connectionRetryCount": 0,
        "connectionRetryInterval": 0,
        "historyMode": 0,
        "jobTimeout": 0,
        "jobTimeoutEnabled": true,
        "pollingInterval": "string",
        "receivingQueuePollingInterval": "string",
        "receivingTaskQueueSize": 0,
        "requestTimeout": 0,
        "sendLogPoolSize": "string",
        "sendProcessMultiplexLevel": 0,
        "socketBufferSize": 0,
        "socketBufferSizeMode": "string",
        "socketTimeout": 0,
        "traceLogPoolSize": "string",
        "communicationTimeLimitEnabled": true,
        "startCommunicationTimeHour": 0,
        "endCommunicationTimeHour": 0
      },
      "bit": "string",
      "cpu": "string",
      "deviceAccessLog": {
        "accessedDate": 0,
        "agentId": "string",
        "agentVersion": 0,
        "attachedModuleVersion": "string",
        "deviceAccessLogId": "string",
        "moduleVersion": "string",
        "pollingInterval": 0,
        "profileId": "string",
        "profileVersion": 0,
        "type": "string",
        "unitId": "string",
        "unitVersion": 0
      },
      "host": "string",
      "lockDown": {
        "autoResendingRetryCount": true,
        "autoResendingRetryInterval": true,
        "connectionRetryCount": true,
        "connectionRetryInterval": true,
        "historyMode": true,
        "jobTimeout": true,
        "jobTimeoutEnabled": true,
        "pollingInterval": true,
        "receivingQueuePollingInterval": true,
        "requestTimeout": true,
        "sendLogPoolSize": true,
        "sendProcessMultiplexLevel": true,
        "socketBufferSize": true,
        "socketTimeout": true,
        "traceLogPoolSize": true,
        "communicationTimeLimitEnabled": true,
        "startCommunicationTimeHour": true,
        "endCommunicationTimeHour": true
      },
      "macAddress": "string",
      "moduleVersion": "string",
      "moduleVersionSyncronized": true,
      "moduleVersionUpdated": true,
      "name": "string",
      "nextSyncronizationScheduledTime": 0,
      "os": "string",
      "otherInfo": {
        "region": 0,
        "floating": "string"
      },
      "profileId": "string",
      "profileName": "string",
      "profileVersionSyncronized": true,
      "profileVersionUpdated": true,
      "registrationDate": 0,
      "remarks": "string",
      "sendLog": {
        "agentId": "string",
        "agentName": "string",
        "cipherType": "string",
        "compressedRate": 0,
        "dTelegramLen": 0,
        "dataSize": 0,
        "detailCode": 0,
        "errorJobExitCode": 0,
        "errorJobName": "string",
        "exitCode": 0,
        "fileId": "string",
        "hostName": "string",
        "latestProcessId": "string",
        "latestTransferId": "string",
        "preJobExitCode": 0,
        "preJobName": "string",
        "profileId": "string",
        "profileName": "string",
        "recordCount": 0,
        "sendLogId": "string",
        "sndEndTimeStr": "string",
        "sndEndTimeUtc": 0,
        "sndFileName": "string",
        "sndStartTimeStr": "string",
        "sndStartTimeUtc": 0,
        "startProcessId": "string",
        "startTransferId": "string",
        "successJobExitCode": 0,
        "successJobName": "string",
        "transferRate": 0,
        "transferType": "string",
        "triggerEvent": 0,
        "triggerStatus": 0,
        "unitId": "string",
        "unitName": "string"
      },
      "session": "string",
      "status": "string",
      "unitId": "string",
      "unitName": "string",
      "unitVersionSyncronized": true,
      "unitVersionUpdated": true
    }
  ],
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "sort": [],
  "totalElements": 0,
  "totalPages": 0
}
Response parameter

For details of the parameters under the content layer, see Response parameter described in Acquire Agent instance details.

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