Back to QMetry All Products Help Page
API for Automation
Get List of all Automation Agents
POST /rest/admin/agent/read
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
start | body | yes | Start index of records | - | integer |
limit | body | yes | Number of records per page | - | integer |
page | body | yes | Page number to be displayed | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | List of agents fetched successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Fetch Scheduled Execution Command
POST /rest/admin/agent/listSchedules
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
data | body | yes | data | - | string |
limit | body | no | Number of records per page | - | integer |
page
| body | no | Page number to be displayed | - | integer |
pluginAgentId | body | yes | Unique identifier of pluginAgent | - | integer |
start
| body | no | Start index of records |
| integer |
|
|
|
|
|
|
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Fetch schedule for agent successfully | - |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Fetch Agent Details like OS, Agent Type
POST /rest/testsuites/linkplatform/assignagent/fetchScheduleDetails
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
data | body | yes | data | - | string |
pluginAgentId | body | yes | Unique identifier of pluginAgent | - | integer |
scheduleId | body | yes | Unique identifier of schedule | - | integer |
scheduleType | body | yes | scheduleType | - | string |
agentCronScheduleId | body | yes | Unique identifier of schedule agent | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Give agent details successfully | - |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Update Scheduled Command
POST /rest/testsuites/linkplatform/assignagent/updateSchedule
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
dropID | query | no | dropID | - | string |
platformId | query | no | platformId | - | string |
pluginAgentId | query | no | pluginAgentId | - | string |
scheduledate | query | no | scheduledate | - | string |
scheduletime | query | no | scheduletime | - | string |
testSuiteId | query | no | testSuiteId | - | string |
tsRunId | query | no | tsRunId | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Give agent details successfully | - |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Delete Scheduled Execution Command
POST /rest/admin/agent/deleteSchedule
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
data | body | yes | data | - | string |
pluginAgentId | body | yes | Unique identifier of pluginAgent | - | integer |
scheduleId | body | no | scheduleId | - | integer |
scheduleType | body | no | scheduleType | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Deleted scheduled command for agent successfully | - |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Read the Execution History of a Particular Agent
POST /rest/admin/agent/readExecutionHistory
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
data | body | yes | data | - | string |
limit | body | no | Number of records per page | - | integer |
page | body | no | Page number to be displayed | - | integer |
pluginAgentId | body | yes |
Back to QMetry All Products Help Page