API for Automation

API for Automation

POST /rest/admin/agent/read

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

Status Code

Reason

Response Model

200

List of agents fetched successfully

Response Entity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

POST /rest/admin/agent/listSchedules

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

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

-

POST /rest/testsuites/linkplatform/assignagent/fetchScheduleDetails

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

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

-