DevTest 6.1 REST API documentation

This is the reference document for the REST API and resources provided by TechExcel, Inc. Test

Index

This documents the current REST API provided by TechExcel. Inc.

Resources

/api/Project

Methods

GET

/api/Project?token=_token&projectId=_projectId&projectName=_projectName

Retrieve the project info based on the project name.

request query parameters

parameter value description
_token string to represent the calling user
_projectIdnumber project id - provide either project id or project name
_projectNamestring project name
available response representations:

POST

Retrieve the project info based on the project name.

acceptable request representations: available response representations:

GET vs POST:

If the project name is too long or contains special character.

/api/Project/Reload

Methods

POST

Reload all the settings cached in the integration server. If the project settings has been changed (for example the field names are changed), this function need to be called so that the server will reload the latest settings.

acceptable request representations: available response representations:

/api/TestTask/Query

Methods

POST

Get the specified field values of some test tasks.

acceptable request representations: available response representations:

/api/TestTask/NewChildTask

Methods

POST

Create a child test task of an automated task.

acceptable request representations: available response representations:

/api/TestTask/NewDynamicTask

Methods

POST

Create a dynamic test task.

acceptable request representations: available response representations:

/api/TestTask/New

Methods

POST

Create test tasks based on certain conditions.

acceptable request representations: available response representations:

/api/TestTask/MultiNew

Methods

POST

Create test tasks based on certain conditions.

acceptable request representations: available response representations:

/api/TestTask/NewFolder

Methods

POST

Create new task folder.

acceptable request representations: available response representations:

/api/TestTask/EditFolder

Methods

POST

Edit task folder.

acceptable request representations: available response representations:

/api/TestTask/CopyFolder

Methods

POST

Copy task folder.

acceptable request representations: available response representations:

/api/TestTask/Folder

Methods

POST

Get the specified field values of a task folder.

acceptable request representations: available response representations:

/api/TestTask/FolderStructure

Methods

POST

Get the folder structure of a task folder. Folder ID 0 or an empty folder path can be used for root folder. If Recursive is set to true, the function gets the entire folder structure of the target folder; otherwise it only gets its direct children folders.

acceptable request representations: available response representations:

/api/TestTask/Coverage

Methods

POST

Modify the task coverage.

acceptable request representations: available response representations:

/api/TestTask/Edit

Methods

POST

Set field values for the specified test task.

acceptable request representations: available response representations:

/api/TestTask/GroupEdit

Methods

POST

Set field values for a group of test tasks.

acceptable request representations: available response representations:

/api/TestTask

Methods

DELETE

Delete a test task.

acceptable request representations: available response representations:

/api/TestTask/DeleteTaskEx

Methods

POST

Delete a test task.

acceptable request representations: available response representations:

/api/TestTask/LinkBug

Methods

POST

Link an existing bug with the test task issue.

acceptable request representations: available response representations:

/api/TestTask/DeleteBug

Methods

POST

Delete the link to a bug from the test task issue.

acceptable request representations: available response representations:

/api/TestTask/AddNote

Methods

POST

Create a note for a test task.

acceptable request representations: available response representations:

/api/TestTask/DeleteNoteEx

Methods

POST

Delete a note for a test task.

acceptable request representations: available response representations:

/api/TestTask/Move

Methods

POST

Move test task to different folder.

acceptable request representations: available response representations:

/api/TestTask/Copy

Methods

POST

Copy test task to specified folder.

acceptable request representations: available response representations:

/api/TestTask/Attachment

Methods

POST

Add attachment to a test task.

acceptable request representations: available response representations:

/api/TestTask/Attachment

Methods

GET

Retrieve attachment URL for a test task(template).

acceptable request representations: available response representations:

/api/TestTask/Note

Methods

GET

/api/TestTask/Note?token=_token&projectId=_projectId&issueId=_issueId&projectName=_projectName

Get notes of a test task.

request query parameters

parameter value description
_token string to represent the calling user
_projectIdnumber project Id
_issueIdnumber issue Id
_projectNamestring project name (optional)
available response representations:

POST

Get notes of a test task.

acceptable request representations: available response representations:

/api/TestTask/LinkedDefect

Methods

GET

/api/TestTask/LinkedDefect?token=_token&projectId=_projectId&issueId=_issueId&projectName=_projectName

Get linked defects of a test task.

request query parameters

parameter value description
_token string to represent the calling user (optional)
_projectIdnumber project Id
_issueIdnumber issue Id
_projectNamestring project name (optional)
available response representations:

POST

Get linked defects of a test task.

acceptable request representations: available response representations:

/api/TestTask/AllLink

Methods

GET

Get all links of a test task.

acceptable request representations: available response representations:

/api/TestTask/Field

Methods

GET

/api/TestTask/Field?token=_token&projectId=_projectId&fieldId=_fieldId&projectName=_projectName&fieldName=_fieldName

Get linked defects of a test task.

request query parameters

parameter value description
_token string to represent the calling user (optional)
_projectIdnumber project Id
_fieldIdnumber field Id
_projectNamestring project name (optional)
_fieldNamestring field name (optional)
available response representations:

POST

Get field information.

acceptable request representations: available response representations:

/api/TestTask/MakeChange

Methods

POST

Make a task pending change.

acceptable request representations: available response representations:

/api/TestTask/EditChange

Methods

POST

Update a task pending change.

acceptable request representations: available response representations:

/api/TestTask/PublishChange

Methods

POST

Publish a task pending change.

acceptable request representations: available response representations:

/api/TestTask/RetrieveChange

Methods

POST

Retrieve a list of tasks with change.

acceptable request representations: available response representations:

/api/TestTask/GroupPublishChange

Methods

POST

Publish a group of task pending change.

acceptable request representations: available response representations:

/api/TestTask/Grid

Methods

POST

Get grid info of a test cycle.

acceptable request representations: available response representations:

/api/TestTask/GridUpdate

Methods

POST

Get grid update info of a test cycle.

acceptable request representations: available response representations:

/api/TestTask/LockChildFolder

Methods

POST

Lock/unlock all child folders of a task folder.

acceptable request representations: available response representations:

/api/TestTemplate/New

Methods

POST

Create a new test template.

acceptable request representations: available response representations:

/api/TestTemplate/NewFolder

Methods

POST

Create a new test template folder.

acceptable request representations: available response representations:

/api/TestTemplate/Folder

Methods

POST

Get the specified field values of a template folder.

acceptable request representations: available response representations:

/api/TestTemplate/FolderStructure

Methods

POST

Get the folder structure of a task folder. Folder ID 0 or an empty folder path can be used for root folder. If Recursive is set to true, the function gets the entire folder structure of the target folder; otherwise it only gets its direct children folders.

acceptable request representations: available response representations:

/api/TestTemplate/Edit

Methods

POST

Set field values for the specified test template.

acceptable request representations: available response representations:

/api/TestTemplate/GroupEdit

Methods

POST

Set field values for a group of test template.

acceptable request representations: available response representations:

/api/TestTemplate/Query

Methods

POST

Get the specified field values of some test templates.

acceptable request representations: available response representations:

/api/TestTemplate

Methods

DELETE

Delete a template.

acceptable request representations: available response representations:

/api/TestTemplate/DeleteTemplateEx

Methods

POST

Delete a template.

acceptable request representations: available response representations:

/api/TestTemplate/AddNote

Methods

POST

Create a note for a test template.

acceptable request representations: available response representations:

/api/TestTemplate/CheckByEnv

Methods

POST

Check whether a Template is applicable under a given Environment Permuation(s).

acceptable request representations: available response representations:

/api/TestTemplate/ListByEnv

Methods

POST

Return the applicable Templates in a Template folder under a given Environment Permuation(s).

acceptable request representations: available response representations:

/api/TestTemplate/ListByEnvEx

Methods

POST

Return the applicable Templates in Template folders each under a given Environment Permuation(s).

acceptable request representations: available response representations:

/api/TestTemplate/Attachment

Methods

POST

Add attachment to a test template.

acceptable request representations: available response representations:

/api/TestTemplate/Attachment

Methods

GET

Retrieve attachment URL for a test task(template).

acceptable request representations: available response representations:

/api/TestTemplate/Note

Methods

GET

/api/TestTemplate/Note?token=_token&projectId=_projectId&issueId=_issueId&projectName=_projectName

Get notes of a test task.

request query parameters

parameter value description
_token string to represent the calling user
_projectIdnumber project Id
_issueIdnumber issue Id
_projectNamestring project name (optional)
available response representations:

POST

Get notes of a test template.

acceptable request representations: available response representations:

/api/TestTemplate/LinkedTask

Methods

GET

/api/TestTemplate/LinkedTask?token=_token&projectId=_projectId&issueId=_issueId&projectName=_projectName

Get linked test tasks of a test template.

request query parameters

parameter value description
_token string to represent the calling user (optional)
_projectIdnumber project Id
_issueIdnumber issue Id
_projectNamestring project name (optional)
available response representations:

POST

Get linked test tasks of a test template.

acceptable request representations: available response representations:

/api/TestTemplate/AllLink

Methods

GET

Get all links of a template.

acceptable request representations: available response representations:

/api/TestTemplate/Field

Methods

GET

/api/TestTemplate/Field?token=_token&projectId=_projectId&fieldId=_fieldId&projectName=_projectName&fieldName=_fieldName

Get linked defects of a test task.

request query parameters

parameter value description
_token string to represent the calling user (optional)
_projectIdnumber project Id
_fieldIdnumber field Id
_projectNamestring project name (optional)
_fieldNamestring field name (optional)
available response representations:

POST

Get field information.

acceptable request representations: available response representations:

/api/TestTemplate/MakeChange

Methods

POST

Make a template pending change.

acceptable request representations: available response representations:

/api/TestTemplate/EditChange

Methods

POST

Update a template pending change.

acceptable request representations: available response representations:

/api/TestTemplate/PublishChange

Methods

POST

Publish a template pending change.

acceptable request representations: available response representations:

/api/TestTemplate/RetrieveChange

Methods

POST

Retrieve a list of templates with change.

acceptable request representations: available response representations:

/api/TestTemplate/GroupPublishChange

Methods

POST

Publish a group of template pending change.

acceptable request representations: available response representations:

/api/TestTemplate/Move

Methods

POST

Move test template to different folder.

acceptable request representations: available response representations:

/api/TestTemplate/TagTemplateWithEV

Methods

POST

tag test template environment values.

acceptable request representations: available response representations:

/api/ActionStatus

Methods

GET

/api/ActionStatus?jobId=_jobId&token=_token

Check status for the previous asynchronous action using the previous returned job ID.

request query parameters

parameter value description
_token string to represent the calling user
_jobIdstring a returned string from previous action
available response representations:

POST

Check status for the previous asynchronous action using the previous returned job ID

acceptable request representations: available response representations:

Status Code

Status Code Meaning
0 Successful
100 Please check your DevTest integration server and port are available.
101 Internal TCP/IP connection error.
102 Database exception at integration server.
103 The user does not have an valid account.
104 General exception at integration server, please check the logs.
105 Internal processing error at integration server.
106 The provided user name and password do not match.
107 Empty Xml Request Data.
108 Return invalid handle in communicating with Integration Server.
109 Internal Error on parsing xml result
109 Internal Error on parsing xml result, empty xml result.
110 Integration Server return Failed Message
111 Integration Server return invalid Xml.
112 Exception occurred when parsing input json data.
113 Timeout occurred between Integration Server and API service.
114 The requested item does not exist in database.

Some other explanations: