List of response parameters
The following table shows a list of response parameters. The parameters are described in an alphabetical order of the item name.
Response parameters may be layered. Only the lowest parameters that have a value are described in this table.
| Item name | Response parameter | Description | See |
|---|---|---|---|
| API Key | apiKey | The key that will be specified in the API request header is returned. | |
| Term of API Key | expiresOn |
|
|
| DEFLATE level | deflateLevel |
|
Acquire a list of transfer settings |
| MAC address | value | ||
| MAC address | macAddress | ||
| OS | os |
Acquire a list of Agent instances Acquire Agent instance details |
|
| OS End Code | osExitCode | OS End Code that was related to the occurred event is returned. | |
| OS User Name | osUserName | OS User Name who started Agent is returned. | |
| PID | pid | The process ID of Agent that output the log is returned. | |
| Architecture (Agent) | cpu |
The CPU architecture on which the Agent module runs is returned. |
Acquire a list of Agent instances Acquire Agent instance details |
| Access Date and Time | accessedDate |
|
Acquire a list of Agent instances |
| Access Log ID | deviceAccessLogId |
Acquire a list of Agent instances |
|
| Access Log Type | type |
|
Acquire a list of Agent instances |
| Threshold for the Access Log (Records) | offset |
The maximum number of records to keep the logs is returned. |
|
| Threshold for the Access Log (Days) | minusDays |
The maximum number of days to keep the logs is returned. |
|
| Truncating the Access Log (On/Off) | enableTruncate |
|
|
| Truncation schedule for the Access Log | cron |
|
|
| Truncation Mode for the Access Log | truncateMode |
|
|
| Activation Key | activationKey | ||
| Whitelist Activation | whitelistEnabled |
|
|
| Compression Method | compressionMode |
|
Acquire a list of transfer settings |
| Compression Ratio | compressedRate |
|
Acquire a list of Agent instances Acquire Agent instance details |
| Address (Cc) | cc | ||
| Address (To) | address | ||
| Encryption Key | encryptKey |
|
Acquire a list of transfer settings |
| Encryption Type | cipherType |
|
Acquire a list of Agent instances Acquire Agent instance details |
| Encryption Type | encryptMode |
|
Acquire a list of transfer settings |
| Unsuccessful Job | errorJobName | Job itself is returned. |
Acquire a list of Agent instances Acquire Agent instance details |
| Unsuccessful Job (From) | jobNameOnError |
Acquire a list of transfer settings |
|
| Unsuccessful Job (To) | receiveJobOnError | ||
| End code of Unsuccessful Job | errorJobExitCode |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Unsuccessful Job Execution Mode (From) | jobExecModeOnError |
|
Acquire a list of transfer settings |
| Date and Time of Occurrence (UTC) | eventDateTimeUtc | ||
| Date and Time of Occurrence (String) | eventDateTimeStr |
|
|
| Agent ID | agentId |
Acquire a list of Agent instances Acquire Agent instance details Acquire a list of Receive Logs |
|
| Version of Module that is attached by using the Agent List screen | attachedModuleVersion | ||
| Agent offline notification (ON/OFF) | enableNotification |
|
|
| Agent offline notification threshold | offlineTime | The time when an email will be sent after a session between Manager and an instance of Agent becomes offline is returned by using the number of minutes. | |
| Agent offline notification schedule | cron |
|
|
| Maximum Number of Agents That Can be Used | numberOfAgents |
|
|
| Number of Agents in Use | numberOfActiveAgents | The number of Agent instances that are used is returned. | |
| Agent Count | numberOfAgent | ||
| Agent Version | agentVersion | ||
| Agent Version (Settings history) | agentVersion |
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. |
|
| Agent Name | agentName |
Acquire a list of Agent instances Acquire Agent instance details Acquire a list of Receive Logs |
|
| Agent Name | name | ||
| Start Time (Communication Time Limit) | startCommunicationTimeHour | ||
| Make Start Time static (Communication Time Limit) | startCommunicationTimeHour | ||
| Starting Identifier | startProcessId |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Start Transfer Identifier | startTransferId |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Monitoring Interval (From) | triggerInterval |
|
Acquire a list of transfer settings |
| Elapsed Monitoring Time (From) | triggerElapsedTime |
|
Acquire a list of transfer settings |
| Monitoring Size (From) | triggerSize |
|
Acquire a list of transfer settings |
| Monitored File Name (From) | triggerFileName |
|
Acquire a list of transfer settings |
| Monitoring Mode (From) | triggerMode |
|
Acquire a list of transfer settings |
| End Code | exitCode | The end code of the receive processing on agent environment is returned. | |
| End Code (Receive) | exitCode |
The end code of the receive processing on manager environment is returned. |
|
| End Code (Send) | exitCode |
The end code of the send processing is returned. |
Acquire a list of Agent instances Acquire Agent instance details |
| Term License Key | termKey | ||
| Term License Key expiration notification (ON/OFF) | enableNotification |
|
|
| Term License Key expiration notification threshold | beforeDays | The day that the notification email is sent is returned by using the number of days before the license term is expired. | |
| Term License Key expiration notification schedule | cron | ||
| Result | result | ||
| Search Order (From) | searchOrderDescending |
|
Acquire a list of transfer settings |
| Search Target (From) | searchTarget |
|
Acquire a list of transfer settings |
| Subject prefix | subjectPrefix | ||
| Connection Retry Count | connectionRetryCount | ||
| Make Connection Retry Count static | connectionRetryCount |
|
|
| Connection Retry Interval | connectionRetryInterval | ||
| Make Connection Retry Interval static | connectionRetryInterval | ||
| Latest Processing Identifier | latestProcessId |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Latest Transfer Identifier | latestTransferId |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Reissue Key | clientSecret | You can reissue an API key by using this key for the input of the Reacquire API Key API function without using a user name and a password. | |
| Created Date and Time | createdDate | ||
| Next Scheduled Sync Time | nextSyncronizationScheduledTime | ||
| Auto Resend Retry Count | autoResendingRetryCount | ||
| Make Auto Resend Retry Count static | autoResendingRetryCount | ||
| Auto Resend Retry Interval | autoResendingRetryInterval | ||
| Make Auto Resend Retry Interval static | autoResendingRetryInterval | ||
| Receive Start Date and Time (UTC) | rcvStartTimeUtc | ||
| Receive Start Date and Time (String) | rcvStartTimeStr | ||
| Notification (To) | jobWait | ||
| Receive End Date and Time (UTC) | rcvEndTimeUtc | ||
| Receive End Date and Time (String) | rcvEndTimeStr | ||
| Receive File Name | rcvFileName | ||
| Receiving File Name (To) | receiveFileName | ||
| Port Number on Receiver | shushinPort | ||
| Host Name of Receiver | shushinHostName | ||
| Receive Log ID | hulrcvLogId | ||
| End Time (Communication Time Limit) | endCommunicationTimeHour | ||
| Make End Time static (Communication Time Limit) | endCommunicationTimeHour | ||
| Reception Start Date and Time (UTC) | receivingStartDateUtc | ||
| Reception Start Date and Time (String) | receivingStartDateStr | ||
| Reception Completion Date and Time (UTC) | receivingEndDateUtc | ||
| Reception Completion Date and Time (String) | receivingEndDateStr | ||
| Receive Queue Polling Interval | receivingQueuePollingInterval | ||
| Make Receive Queue Polling Interval static | receivingQueuePollingInterval | ||
| Reception Settings ID | receivingProfileId | The ID of Reception Settings |
Acquire a list of reception settings Acquire a list of Receive Logs |
| Reception Settings Name | receivingProfileName | The name of Reception Settings |
Acquire a list of reception settings Acquire a list of Receive Logs |
| Receiving Task ID | receivingTaskId | ||
| Size of Receive Task Queue | receivingTaskQueueSize | ||
| Receive Log ID | receivingLogId | ||
| Receive log error notification (ON/OFF) | enableNotification | ||
| Receive log error notification schedule | cron | ||
| Threshold for the Receive Log (Records) | offset | The maximum number of records to keep the logs is returned. | |
| Threshold for the Receive Log (Days) | minusDays | The maximum number of days to keep the logs is returned. | |
| Truncating the Receive Log (On/Off) | enableTruncate | ||
| Truncation schedule for the Receive Log | cron | ||
| Truncation Mode for the Receive Log | truncateMode | ||
| Detail Code | detailCode | The detail code of the receive processing on agent environment is returned. | |
| Detail Code (Receive) | detailCode | The detail code of the receive processing on manager environment is returned. | |
| Detail Code (Send) | detailCode | The detail code of the send processing is returned. |
Acquire a list of Agent instances Acquire Agent instance details |
| Job | job |
Acquire a list of receive tasks |
|
| Contents of Job | jobScript |
Acquire a list of reception settings |
|
| Job ID | jobId | The ID of the job that was executed after the reception is returned. | |
| End Code of Job | jobExitCode | ||
|
Job Execution Mode (Reception Settings) |
jobExecMode |
Acquire a list of reception settings |
|
| Job Timeout (Time) | jobTimeout | ||
| Make Job Timeout (Time) static | jobTimeout | ||
| Job Timeout (Valid or Invalid) | jobTimeoutEnabled | ||
| Make Job Timeout (Valid or Invalid) static | jobTimeoutEnabled | ||
| Serial | serial | ||
| Status (Agent) | status | ||
| Normalized MAC address | normalizedValue | ||
| Successful Job | successJobName | Job itself is returned. |
Acquire a list of Agent instances Acquire Agent instance details |
| Successful Job (From) | jobName |
Acquire a list of transfer settings |
|
| Successful Job (To) | receiveJob | If multiple jobs are registered, jobs are divided by a newline code (LF). | |
| End code of Successful Job | successJobExitCode |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Successful Job Execution Mode (From) | jobExecMode |
Acquire a list of transfer settings |
|
| Generation File Count (To) | generationFileCount | ||
| Session | session | ||
| Description | description | ||
| Type | attribute | ||
| Socket Buffer Size (Type) | socketBufferSizeMode | ||
| Socket Buffer Size (Byte count) | socketBufferSize | ||
| Make Socket Buffer Size static | socketBufferSize | ||
| Socket Read Timeout | socketTimeout | ||
| Make Socket Read Timeout static | socketTimeout | ||
| Download URL | url | The URL from which Agent actually downloaded the file. | |
| Communication Time Limit | communicationTimeLimitEnabled | ||
| Make Communication Time Limit static | communicationTimeLimitEnabled | ||
| Verify Data | dataVerify | ||
| Data Size | dataSize | The size of data that has been received so far is returned. | |
| Data Size (Receive) | dataSize | The size of the reception data is returned. | |
| Data Size (Send) | dataSize | The size of the send data is returned. |
Acquire a list of Agent instances Acquire Agent instance details |
| File Deletion after Transfer (From) | deleteFile |
Acquire a list of transfer settings |
|
| Transfer Settings ID | sendingProfileId |
Acquire a list of transfer settings |
|
| Transfer Settings Name | sendingProfileName |
Acquire a list of transfer settings |
|
| Transfer Type | transferType |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Transfer Type | sendType |
Acquire a list of transfer settings |
|
| Transfer Block Length | dTelegramLen |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Transfer Log ID | transferLogId | ||
| Transfer log error notification (ON/OFF) | enableNotification | ||
| Transfer log error notification schedule | cron | ||
| Threshold for the Transfer Log (Records) | offset |
The maximum number of records to keep the logs is returned. |
|
| Threshold for the Transfer Log (Days) | minusDays |
The maximum number of days to keep the logs is returned. |
|
| Truncating the Transfer Log (On/Off) | enableTruncate | ||
| Truncation schedule for the Transfer Log | cron | ||
| Truncation Mode for the Transfer Log | truncateMode | ||
| Transmission Rate | transferRate |
The transmission rate that is calculated by the following formula is returned: Send data size (bytes) ÷ Send time (seconds) |
Acquire a list of Agent instances Acquire Agent instance details |
| Transmission Rate | transferRate |
The transmission rate that is calculated by the following formula is returned: Received data size (bytes) ÷ Receive time (seconds) |
|
| Temporary File Transfer (From) | temporaryFile |
Acquire a list of transfer settings |
|
| Registration Date and Time | registrationDate |
Enable and disable activation whitelist function Acquire a list of Agent instances Acquire Agent instance details |
|
| Trigger Fire Event | triggerEvent |
Acquire a list of Agent instances Acquire Agent instance details |
|
| File Status When Firing Trigger | triggerStatus |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Trace Log ID | traceLogId | The ID of the Trace Log that was allocated to a message is returned. | |
| Trace log error notification (ON/OFF) | enableNotification | ||
| Trace log error notification schedule | cron | ||
| Truncating the Trace Log (On/Off) | enableTruncate | ||
| Truncation schedule for the Trace Log | cron | ||
| Truncation Mode for the Trace Log | truncateMode | ||
| Threshold for the Trace Log (Records) | offset |
The maximum number of records to keep the logs is returned. |
|
| Threshold for the Trace Log (Days) | minusDays |
The maximum number of days to keep the logs is returned. |
|
| Trace Log Unique ID | traceLogUniqueId | The ID to be used for identifying the Trace Log is returned. | |
| Trace Log Pool Size | traceLogPoolSize | ||
| Make Trace Log Pool Size static | traceLogPoolSize | ||
| Version | version | ||
| Version (HULFT IoT) | implementationFormattedVersion |
The version without a minor revision is returned. |
|
|
Version (HULFT IoT) (number only) |
implementationVersion |
The version without alphabetical characters is returned. |
|
|
Version (HULFT IoT) (Full) |
implementationFullFormattedVersion |
The version with a minor revision is returned. |
|
| Send Start Date and Time (UTC) | sndStartTimeUtc |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Send Start Date and Time (String) | sndStartTimeStr |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Send End Date and Time (UTC) | sndEndTimeUtc |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Send End Date and Time (String) | sndEndTimeStr |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Send Process Multiplex Level | sendProcessMultiplexLevel | ||
| Make Send Process Multiplex Level static | sendProcessMultiplexLevel | ||
| Send File name | sndFileName |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Pre-send Job | preJobName | Job itself is returned. |
Acquire a list of Agent instances Acquire Agent instance details |
| Pre-send Job (From) | preJobName |
Acquire a list of transfer settings |
|
| End code of Pre-send Job | preJobExitCode |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Pre-send Job Execution Mode (From) | preJobExecMode |
Acquire a list of transfer settings |
|
| Send Log ID | sendLogId |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Send Log Pool Size | sendLogPoolSize | ||
| Make Send Log Pool Size static | sendLogPoolSize | ||
| File Name at Send Destination | fileName |
Acquire a list of receive tasks Acquire a list of reception settings |
|
| Password Registration | passwdCreated | ||
| Remarks | remarks | ||
| Bit Count (Agent) | bit |
The value that indicates the bit count of Agent module is returned. |
Acquire a list of Agent instances Acquire Agent instance details |
| File ID | fileId |
Acquire a list of transfer settings |
|
| File ID | fileId | The ID of the file that is being received is returned. | |
| File ID (Receive File) | fileId | The ID of the received file is returned. | |
| File ID (Send File) | fileId | The ID of the send file is returned. |
Acquire a list of Agent instances Acquire Agent instance details |
| URL for uploading a file | entryPoint |
Acquire a list of reception settings |
|
| File Size | fileSize | ||
| File Creation (To) | fileCreation |
|
|
| File Distribution ID | distributionModuleId | ||
| File Path | filePath | ||
| Floating Point Operation of Agent | floating | ||
| Product Key | productKey | ||
| Product Key update status (HULFT) | statusHulft | ||
| Product Key update status (HULFT IoT) | statusIoT | ||
| Profile ID | profileId |
Acquire a list of Agent instances Acquire Agent instance details Acquire a list of transfer settings Acquire a list of Receive Logs Acquire transfer settings details Modify transfer settings details |
|
| Update of Profile | profileVersionUpdated | ||
| Synchronization of Profile | profileVersionSyncronized | ||
| Profile Version | profileVersion |
Acquire a list of Agent instances |
|
| Profile Name | profileName |
Acquire a list of Agent instances Acquire Agent instance details Acquire a list of Receive Logs |
|
| Polling Interval | pollingInterval |
Acquire a list of Agent instances |
|
| Make Polling Interval static | pollingInterval | ||
| Host Name | host | ||
| Host Name | hostName | ||
| Host Name (Agent ID) | hostName |
The parameter name is hostName, however the Agent ID that is displayed on the Agent List screen of Manager is returned. |
|
| Host Name (Send destination) | hostName |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Whitelist ID | activationWhitelistId | ||
| To send an email (ON/OFF) | enableNotification |
|
|
| Message | eventMessage | The message that was related to the occurred event is returned | |
| Message | message | If the "result" is "failure", the content of error is returned. | |
| Module ID | moduleId | ||
| Update of the module | moduleVersionUpdated | ||
| Creation day of the module | implementationDate | ||
| Synchronization of the module | agentVersionSyncronized | ||
| Synchronization of the module | moduleVersionSyncronized | ||
| Module Version | moduleVersion |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Module Version (Current) | attachedModuleVersion |
The version of a module that is currently allocated to the Agent is returned. |
|
| Module Version (To be allocated) | moduleVersion |
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. |
|
| Module File Name | moduleFileName | ||
| User ID | userId | ||
| User Name | userName | ||
| Unit ID | unitId |
Acquire a list of Agent instances Acquire Agent instance details Acquire a list of Receive Logs Acquire a list of Transfer Logs |
|
| Update of Unit | unitVersionUpdated | ||
| Synchronization of Unit | unitVersionSyncronized | ||
| Unit Version | unitVersion |
Acquire a list of Agent instances Acquire Agent instance details |
|
| Unit Name | unitName |
Acquire a list of Agent instances Acquire Agent instance details Acquire a list of Receive Logs Acquire a list of Transfer Logs |
|
| License Type | licenseType | ||
| Region | region |
Acquire a list of Agent instances |
|
| Request Timeout | requestTimeout | ||
| Make Request Timeout static | requestTimeout | ||
| Start Date of Usage | startDateTime | ||
| Number of available days | availableDays | ||
| End Date of Usage | endDateTime | ||
| Log Output Mode | historyMode | ||
| Log Output Mode (Receive Log Settings on the receiver) | hulrcvLogHistoryMode | ||
| Make Log Output Mode static | historyMode | ||
| Record Count | recordCount | The record count of the file that Agent has sent is returned. |
Acquire a list of Agent instances Acquire Agent instance details |
| Record Count | recordCount | The record count of the actually received file is returned. | |
| Record Count | recordCount | The number of records that have been received so far is returned. | |
| Role ID | userRoleId | ||
| Role Name | userRoleName | ||
| Log Level | logLevel |