Acquire Agent instance details

This is an API function to acquire details of the specified Agent instance. This API function corresponds to the operation of the [Details] button that is displayed by selecting the [Agent] on the operation screen of Manager.

= Remarks =

It is the difference between the acquire a list of Agent instances API function and this API function that the following parameters are not included in the response of this API function.

content layer (Parameters under the content layer of the acquire a list API function are the same as the parameters of the acquire details API function.)
first
last
number
numberOfElements
size
sort
totalElements
totalPages

Format
Request parameter (Path format)
Response
Response parameter

Item name	Response parameter		Type	Value
Auto Resend Retry Count	basicSettings	autoResendingRetryCount	Integer	0 to 9999　(times)
Auto Resend Retry Interval		autoResendingRetryInterval	Integer	0 to 9999　(seconds)
Connection Retry Count		connectionRetryCount	Integer	0 to 9999　(times)
Connection Retry Interval		connectionRetryInterval	Integer	0 to 9999　(seconds)
Log Output Mode		historyMode	Integer	0 \| 1 •　0: Only when an error occurs •　1: Always
Job Timeout (Time)		jobTimeout	Integer	10 to 86400　(seconds) If the "Job Timeout" is invalid, the value that was set when the "Job Timeout" was valid is returned.
Job Timeout (Valid or Invalid)		jobTimeoutEnabled	Boolean	•　true: valid •　false: invalid
Polling Interval		pollingInterval	String	Numeral (1 to 59) with a unit (second: s, minute: m, hour: h, or day: d) is returned.
Receive Queue Polling Interval		receivingQueuePollingInterval	String	Numeral (1 to 59) with a unit (second: s, minute: m, hour: h, or day: d) is returned.
Size of Receive Task Queue		receivingTaskQueueSize	Integer	1 to 9999　(times)
Request Timeout		requestTimeout	Integer	10 to 259200 (seconds)
Send Log Pool Size		sendLogPoolSize	String	Numeral (1 to 1024) with a unit (megabyte: m) is returned.
Send Process Multiplex Level		sendProcessMultiplexLevel	Integer	1 to 99　(items)
Socket Buffer Size (Byte count)		socketBufferSize	Integer	•　If the "socketBufferSizeMode" is "DEFAULT": The value that was set when the "socketBufferSizeMode" was "SPECIFIED" is returned. The initial value is NULL. •　If the "socketBufferSizeMode" is "SPECIFIED": 4096 to 2147483647 (byte)
Socket Buffer Size (Type)		socketBufferSizeMode	String	"DEFAULT" \| "SPECIFIED" •　DEFAULT: Default •　SPECIFIED: Specified by user
Socket Read Timeout		socketTimeout	Integer	10 to 259200　(seconds)
Trace Log Pool Size		traceLogPoolSize	String	Numeral (1 to 1024) with a unit (megabyte: m) is returned.
Communication Time Limit		communicationTimeLimitEnabled	Boolean	•　true: Communication hour is restricted •　false: Communication hour is not restricted
Start Time (Communication Time Limit)		startCommunicationTimeHour	Integer	0 to 23　(o'clock)
End Time (Communication Time Limit)		endCommunicationTimeHour	Integer	0 to 23　(o'clock)

Item name	Response parameter		Type	Value
Agent Bit Count	bit		String	"32" \| "64" The value that indicates the bit count of Agent module is returned.
Agent Architecture	cpu		String	The CPU architecture on which the Agent module runs is returned. Example: x86_84
Access Date and Time	deviceAccessLog	accessedDate	Integer	The value is returned by using a "yyyyMMddHHmmssSSS" format. Example: 20171114142949096
Agent ID		agentId	String
Agent Version (Settings history)		agentVersion	Integer	This value is returned for managing the settings history of Agent. Just after an activation, the value is 1. If you modify the settings of Agent, the value will increase one by one.
Module Version (Current)		attachedModuleVersion	String	The version of a module that is currently allocated to the Agent is returned. Example: "V01L04R00P00"
Access Log ID		deviceAccessLogId	String
Module Version (To be allocated)		moduleVersion	String	The version of a module that is currently allocated to the Agent or the version of a prepared module that will be allocated to the Agent is returned. Example: "V01L04R00P00"
Polling Interval		pollingInterval	Integer	Numeral is returned. (seconds) Example: 60
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
Host Name	host		String

Item name	Response parameter		Type	Value
Make Auto Resend Retry Count static	lockDown	autoResendingRetryCount	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Auto Resend Retry Interval static		autoResendingRetryInterval	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Connection Retry Count static		connectionRetryCount	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Connection Retry Interval static		connectionRetryInterval	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Log Output Mode static		historyMode	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Job Timeout (Time) static		jobTimeout	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Job Timeout (Valid or Invalid) static		jobTimeoutEnabled	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Polling Interval static		pollingInterval	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Receive Queue Polling Interval static		receivingQueuePollingInterval	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Request Timeout static		requestTimeout	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Send Log Pool Size static		sendLogPoolSize	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Send Process Multiplex Level static		sendProcessMultiplexLevel	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Socket Buffer Size static		socketBufferSize	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Socket Read Timeout static		socketTimeout	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Trace Log Pool Size static		traceLogPoolSize	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Communication Time Limit static		communicationTimeLimitEnabled	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make Start Time static (Communication Time Limit)		startCommunicationTimeHour	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value
Make End Time static (Communication Time Limit)		endCommunicationTimeHour	Boolean	•　true: it is a fixed-value •　false: it is not a fixed-value

Item name	Response parameter		Type	Value
MAC address	macAddress		String
Module Version	moduleVersion		String
Synchronization of the module	moduleVersionSyncronized		Boolean	•　true: It has been synchronized •　false: To be synchronized
Update of the module	moduleVersionUpdated		Boolean	•　true: Update succeeded •　false: Update failed If this value and the value of the "moduleVersionSyncronized" are both "true", the synchronization is complete.
Agent Name	name		String
Next Scheduled Sync Time	nextSyncronizationScheduledTime		Integer	The value is returned by using a "yyyyMMddHHmmssSSS" format. Example: 20171124164131676
OS	os		String
Region	otherInfo	region	Integer	0 \| 1 •　0: Not a region edition •　1: A region edition
Floating Point Operation of Agent	otherInfo	floating	String	"soft-float" \| "hard-float" •　"soft-float": by using software •　"hard-float": by using hardware This value is valid only when Agent is ARM version.
Profile ID	profileId		String
Profile Name	profileName		String
Synchronization of Profile	profileVersionSyncronized		Boolean	•　true: It has been synchronized •　false: To be synchronized
Update of Profile	profileVersionUpdated		Boolean	•　true: Update succeeded •　false: Update failed If this value and the value of the "profileVersionSyncronized" are both "true", the synchronization is complete.
Registration Date and Time	registrationDate		Integer	The value is returned by using a "yyyyMMddHHmmssSSS" format. Example: 20171124164131676
Remarks	remarks		String	Maximum 512 ASCII characters

Item name	Response parameter		Type	Value
Agent ID	sendLog	agentId	String
Agent Name		agentName	String
Encryption Type		cipherType	String	"0" \| "1" • 0: Encryption function is not used.^* • 1: HULFT encryption is used. * If the product is a region edition, always 0 is specified.
Compression Ratio		compressedRate	Integer
Transfer Block Length		dTelegramLen	Integer
Data Size (Send)		dataSize	Integer	The size of the send data is returned.
Detail Code (Send)		detailCode	Integer
End Code of Unsuccessful Job		errorJobExitCode	Integer
Unsuccessful Job		errorJobName	String	Job itself is returned.
End Code (Send)		exitCode	Integer
File ID (Send file)		fileId	String	The ID of the send file is returned.
Host Name (Send destination)		hostName	String
Latest Processing Identifier		latestProcessId	String
Latest Transfer Identifier		latestTransferId	String
End code of Pre-send Job		preJobExitCode	Integer
Pre-send Job		preJobName	String	Job itself is returned.
Profile ID		profileId	String	The ID of Profile that is used for the send processing is returned.
Profile Name		profileName	String	The name of Profile that is used for the send processing is returned.
Record Count		recordCount	Integer	The record count of the file that Agent has sent is returned.
Send Log ID		sendLogId	String
Send End Date and Time (String)		sndEndTimeStr	String	"day-of-week month day hour:minute:second year" Example: "Fri Sep 08 17:15:52 2017"
Send End Date and Time (UTC)		sndEndTimeUtc	Integer	The number of seconds that has accumulated since midnight of 1970/1/1 (UTC)
Send File name		sndFileName	String	Character code is UTF-8.
Send Start Date and Time (String)		sndStartTimeStr	String	"day-of-week month day hour:minute:second year" Example: "Fri Sep 08 17:15:52 2017"
Send Start Date and Time (UTC)		sndStartTimeUtc	Integer	The number of seconds that has accumulated since midnight of 1970/1/1 (UTC)

Item name	Response parameter		Type	Value
Starting Identifier	sendLog	startProcessId	String
Start Transfer Identifier		startTransferId	String
End code of Successful Job		successJobExitCode	Integer
Successful Job		successJobName	String	Job itself is returned.
Transmission Rate		transferRate	Integer	The transmission rate that is calculated by the following formula is returned: Send data size (bytes) ÷ Send time (seconds)
Transfer Type		transferType	String	"B" \| "T" •　B: Binary •　T: Text
Trigger Fire Event		triggerEvent	Integer	0 \| 1 •　0: The event is fired by a result of a size monitoring •　1: The event is fired by a result of a time stamp monitoring
File Status When Firing Trigger		triggerStatus	Integer	File Size \| Date and Time •　If the event is fired by a result of a size monitoring: File Size (byte) •　If the event is fired by a time stamp monitoring: Date and Time
Unit ID		unitId	String	The ID of Unit in which the send processing is executed is returned.
Unit Name		unitName	String	The name of Unit in which the send processing is executed is returned.
Session	session		String	"ONLINE" \| "OFFLINE" \| "OUT_OF_HOURS" •　ONLINE: online •　OFFLINE: offline •　OUT_OF_HOURS: other than the communication hours according to Communication Time Limit
Agent status	status		String	"ON"　\|　"OFF" •　ON: Agent is in use. •　OFF: Agent is on standby.
Unit ID	unitId		String
Unit Name	unitName		String
Synchronization of Unit	unitVersionSyncronized		Boolean	•　true: It has been synchronized •　false: To be synchronized
Update of Unit	unitVersionUpdated		Boolean	•　true: Update succeeded •　false: Update failed If this value and the value of the "unitVersionSyncronized" are both "true", the synchronization is complete.