API for Automation

Get List of all Automation Agents

POST /rest/admin/agent/read

Request

Content-Type: application/json

Parameters

Table 172. Get List of all Automation Agents Request

Name

Located in

Required

Description

Defualt

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

Table 173. Get List of all Automation Agents Response

Status Code

Reason

Response Model

200

List of agents fetched successfully

ResponseEntity

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

Table 174. Fetch Scheduled Execution Command Request

Name

Located in

Required

Description

Defualt

Schema

data

body

yes

data

-

string

limit

body

yes

Number of records per page

-

integer

page

body

yes

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

Table 175. Fetch Scheduled Execution Command Response

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

Table 176. Fetch Agent Details like OS, Agent Type Request

Name

Located in

Required

Description

Defualt

Schema

data

body

yes

data

-

string

pluginAgentId

body

yes

Unique identifier of pluginAgent

-

integer

scheduleId

body

yes

Unique identifier of schedule

-

integer

schedultType

body

yes

scheduleType

-

string

agentCronScheduleId

body

no

Unique identifier of schedule agent

integer



Response

Content-Type: application/json

Table 177. Fetch Agent Details like OS, Agent Type Response

Status Code

Reason

Response Model

200

Fetch 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

Table 178. Update Scheduled Command Request

Name

Located in

Required

Description

Defualt

Schema

dropID

query

no

dropID

-

string

platformId

query

no

Unique identifier of platform

-

string

pluginAgentId

query

no

Unique identifier of pluginAgent

-

string

scheduledate

query

no

schedule date

-

string

scheduletime

query

no

schedule time

-

string

testSuiteId

query

no

Unique Identifier of the testSuiteI

-

string

tsRunId

query

no

Unique Identifier of Test Suite Run

-

string



Response

Content-Type: application/json

Table 179. Update Scheduled Command Response

Status Code

Reason

Response Model

200

Fetch 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

Table 180. Delete Scheduled Execution Command Request

Name

Located in

Required

Description

Defualt

Schema

data

body

yes

data

-

string

pluginAgentId

body

yes

Unique identifier of pluginAgent

-

integer

scheduleId

body

no

Unique identifier of schedule

-

integer

scheduleType

body

no

scheduleType

-

string



Response

Content-Type: application/json

Table 181. Delete Scheduled Execution Command Response

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

Unique identifier of pluginAgent

-

integer

start

body

no

Start index of records

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Read ExecutionHistory for agent successfully

-

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Automation API - Create Test Suites through Automation

POST /rest/import/createandscheduletestresults/{headerRow}

Request

Content-Type:multipart/form-data

Name

Located in

Required

Description

Default

Schema

scope

header

yes

scope

-

string

apikey

header

yes

Generated Automation API key

-

string

headerRow

path

yes

Default value is 1

-

string

file

formData

yes

Supported file extensions: .json, .xml, and .zip (zip file must contain files of the format given in the "entityType" param.

-

string

entityType

formData

yes

Format of the result file. Supported formats: TESTNG, or CUCUMBER, JUNIT, or HPUFT, or QAF

-

string

cycleID

formData

no

Target Cycle Id, or Cycle Name. You can fetch the Cycle Id using the List Cycle API, and the Cycle Name from the detail view of the target Cycle.

-

string

platformID

formData

no

Target Platform Id or Platform Name. Platform Id, can be fetched using the List Platform API, and Platform Name can be obtained from the detail view of the target Platform.

-

string

testsuiteId

formData

no

Target Test Suite ID or Entity Key. You can fetch the TestsuiteId using the List Testsuite API, and the Entity Key from the detail view of the target Test Suite. This parameter is ignored in case automationHierarchy for JUnit result upload is provided as 3 (multiple Test Suites).

-

string

testsuiteName

formData

no

Provide the test suite name for the new test suite. This parameter will be ignored in case automationHierarchy for JUnit result upload is provided as 3 (multiple Test Suites).

-

string

tsFolderPath

formData

no

The system creates new test suites in a specified test suite folder while importing automated test results. If the folder does not exist, the system creates it.

This parameter is ignored if the test suite is being reused.

-

string

projectID

formData

no

You can fetch the Target Project ID, or project Key, or the project name. Project id using List Project API, and the Entity Key or name from the list view of the target Project.

-

string

releaseID

formData

no

Target Release ID or Release name. You can fetch the release id using the List Release API from the list details of the target Project.

-

string

buildID

formData

no

Target Build ID or Build name. You can fetch the build ID using the List Build API from the list details of the target Project.

-

string

automationHierarchy

formData

no

The parameter has to be used only for TestNG and JUnit frameworks.

Define the hierarchy of a Test case i.e., Test Case-Test Step or Test Case or Test Suite-Test Case.

TestNG

1 Create Test Case -Test Step. The tag <class> is referred to as Test Case and tag <test-method> as Test Step. (The default value is 1)

2 Create only a Test Case. The tag <test-method> is referred to as Test Case.

JUnit

1 Create Test Case-Test Step. The tag <testsuite> is referred to as Test Case, and the tag <testcase> as Test Step. (The default value is 1)

2 Create Test Case. The tag <testcase> is referred to as Test case. In case multiple JUnit files are imported, the system creates a single Test Suite with Test cases of all the files combined.

3 Create Test Suite-Test Case. The tag <testsuite> is referred to as Test Suite, and the tag <testcase> is referred to as Test Case. In this case, multiple Test Suites are created.

-

string

testcase_fields

formData

no

Mention system-defined fields and user-defined fields for the test case as shown in Test Case JSON Format.

Mention all the mandatory fields other than Summary in this parameter.

-

JSON

testsuite_fields

formData

no

Mention all mandatory fields other than Summary in this parameter, as shown in Test Suite JSON Format

The system ignores this parameter if you use the existing Test suite Id to upload results.

-

JSON

skipWarning

formData

no

0 - Test Case Import fails if the result file contains a test case summary with more than 255 characters.

1 - You can still import Test Cases by ignoring the warning. In this case, the system truncates the summary to 255 characters.

0

string

is_matching_required

formData

no

True - Create a new test case or test case version if the test summary and steps of any of the test case versions do not match with the test case in the result file.

False - Reuse already linked test case version in test suite or auto-link the existing latest version of test case to test suite, if the test case entity key OR test case summary matches with the test case in the result file. The execution status of the linked test cases will be updated.

True

string

Supported Fields

  • Field Name as mentioned in Field Name under Manage Fields.

  • For Look up list and multi lookup list fields:

    • If the value does not exist in the Project and auto-create value is enabled, the value is added to the listand assigned to the test case.

    • If the value does not exist in the Project and auto-create value is disabled, the value is not added and Test Case field remains blank or has default value.

    • If a new value is added to the Multi Look Up List, the older value remains unchanged and the new value gets added to the list.

    • List values are added to the same version of test case.

Field

Example

Test Case

Test Suite

Notes

"component"

"component" : ["Label1, "Label2"]

Yes

No

Old values persist and new value gets set e.g., L1 and L2 are set and L3 is assigned, then the updated values for component will be L1, L2 and L3.

"priority"

"priority" : "Minor"

Yes

No

As mentioned for Look Up and Multi Look Up lists above.

"testCaseState"

"testCaseState":"Open"

Yes

No

"testCaseType"

"testCaseType":"Automated"

Yes

No

"testcaseOwner"

"testCaseOwner":"John"

Yes

No

Pass userAlias in the request. The system will not set the owner if it cannot find the requested user or if the user lacks rights to the Test Case module.

"description"

"description":"Sample Description."

Yes

Yes

Set as requested.

"estimatedTime"

"estimatedTime":30

Yes

No

Set as requested. (Allowed value is from 0 to 99999 minutes)

"testSuiteState"

"testSuiteState":"Open"

No

Yes

A new Status value is added if it does not exist in the project.

"testsuiteOwner"

"testsuiteOwner":"lizamathew"

No

Yes

Pass userAlias in the request. The system will not set the owner if it cannot find the requested user or if the user lacks rights to the Test Case module.

User Defined Fields

Custom Field Type

Validation Rule

Example

Notes

STRING

It accepts text in a single line

"tagName": "Sample test asset."

Set as requested.

LARGETEXT

It accepts text in multiple lines

"additionalComment": "this is a sample test asset"

Set as requested.

LOOKUPLIST

It accepts a single value on the list

"country": ["United States"]

Lookup type will be set as requested if its list value exists.

  • If the value does not exist in the Project and auto-create is enabled, the value is added in the list and assigned to the test case.

  • If the value does not exist in the Project and auto create value is disabled, the value is not added. The test case field remains blank or has default value in it.

MULTILOOKUPLIST

It accepts comma separated multiple values

"langaugePreference": ["English",Portuguese"]

Set as requested if its list value exists.

  • If the value does not exist in the Project and auto-create is enabled, the value is added in the list and assigned to the test case.

  • If the value does not exist in the Project and auto-create is enabled, the value is added in the list and assigned to the test case.

  • Additional value is selected, keeping the old values unchanged.

    E.g., A and B are set and we update with C, then updated values for the list will be A, B, and C.

DATEPICKER

It accepts the Date format that has been set in user profile

"reviewedDate": "08-30-2019"

Set as requested.

NUMBER

It accepts any number with decimal

"executionTime": 4

Set as requested.

Test Case Fields with UDFs in JSON format

{

"component":["com1", "com2"],
"priority":"High",
"testCaseState":"Open",
"testCaseType":"Manual",
"testcaseOwner":"lizamathew",
"estimatedTime":60,
"description":"Sample Description",

"userDefinedFields" : {

"reviewedDate": "08-30-2019",
"executionTime": 40,
"tagName": "Sample test asset.",
"additionalComment": "This is a sample test asset",
"country": ["United States"],
"langaugePreference": ["English","Portuguese"]

}

}

Test Suite Fields with UDFs in JSON format

{

"testSuiteState":"Open",
"testsuiteOwner":"lizamathew",
"description":"Testing 8.5.4 API Changes",

"userDefinedFields" : {

"reviewedDate": "08-30-2019",
"executionTime": 40,
"tagName": "Sample test asset.",
"additionalComment": "this is a sample test asset",
"country": ["United States"],
"langaugePreference": ["English","Portuguese"]
}

}

The following table depicts the probable import result according to the scenario.

Is System Field/UDF Mandatory?

Is Auto-Create Enabled?

Does UDF Value exist?

Import Result

No

No

No

Fail

No

No

Yes

Success

No

Yes

No

Success

No

Yes

Yes

Success

Yes

No

No

Fail

Yes

No

Yes

Success

Yes

Yes

No

Success

Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Test Suites created successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Definitions

ResponseEntity

name

type

required

description

example

headers

object

optional

-

body

object

optional

-

statusCode

string

optional

-

In this section:
© 2025
Publication date: