Swagger Tester - Extensive Testing

Adapters

adaptersAdapterAdd

Add a new adapter

/rest/adapters/adapter/add

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/adapters/adapter/add", 
  "message": "adapter added"
}

Status: 400 - Bad request provided

Status: 401 - unauthorized


adaptersAdapterAddByWsdlFile

Add adapter from wsdl file

/rest/adapters/adapter/add/by/wsdl/file

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/adapters/adapter/add/by/wsdl/file", 
  "message": "adapter added"
}

Status: 400 - Bad request provided

Status: 401 - unauthorized


adaptersAdapterAddByWsdlUrl

Add adapter from wsdl url

/rest/adapters/adapter/add/by/wsdl/url

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/adapters/adapter/add/by/wsdl/url", 
  "message": "adapter added"
}

Status: 400 - Bad request provided

Status: 401 - unauthorized


adaptersBuild

build adapters

/rest/adapters/build

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - adapters packaged

{
  "cmd": "/adapters/build", 
  "message": "unlocked"
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersCheckSyntax

check the syntax of a adapter

/rest/adapters/check/syntax

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/adapters/check/syntax", 
  "file-content": "...."
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


adaptersDirectoryAdd

Add directory in the adapters storage

/rest/adapters/directory/add

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/adapters/directory/add", 
  "message": "directory successfully added"
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersDirectoryDuplicate

Duplicate directory in the adapters storage

/rest/adapters/directory/duplicate

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - rename response

{
  "cmd": "/adapters/directory/rename", 
  "message": "directory successfully renamed"
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersDirectoryMove

Move directory

/rest/adapters/directory/move

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - move response

{
  "cmd": "/adapters/directory/move", 
  "message": "directory successfully moved"
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersDirectoryRemove

remove directory in the adapters storage

/rest/adapters/directory/remove

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/adapters/directory/remove", 
  "message": "directory successfully removed"
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersDirectoryRename

Rename directory in the adapters storage

/rest/adapters/directory/rename

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - rename response

{
  "cmd": "/adapters/directory/rename", 
  "message": "directory successfully renamed"
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersFileDownload

download file from the test storage

/rest/adapters/file/download

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/adapters/file/download", 
  "file-content": "...."
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersFileDuplicate

Duplicate file in the adapters storage

/rest/adapters/file/duplicate

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - rename response

{
  "cmd": "/adapters/file/rename", 
  "message": "file successfully renamed"
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersFileMove

Move file

/rest/adapters/file/move

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - move response

{
  "cmd": "/adapters/file/move", 
  "message": "file successfully moved"
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersFileOpen

open and lock file from the test storage

/rest/adapters/file/open

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/adapters/file/open", 
  "file-content": "...."
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersFileRemove

remove file in the adapters storage

/rest/adapters/file/remove

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/adapters/file/remove", 
  "message": "file successfully removed"
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersFileRename

Rename file in the adapters storage

/rest/adapters/file/rename

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - rename response

{
  "cmd": "/adapters/file/rename", 
  "message": "file successfully renamed"
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersFileUnlock

unlock file in the adapters storage

/rest/adapters/file/unlock

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/adapters/file/unlock", 
  "message": "file successfully unlocked"
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersFileUpload

Upload file the test storage

/rest/adapters/file/upload

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/adapters/file/upload", 
  "code": 200
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersListing

Get the listing of all adapters.

/rest/adapters/listing

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - adapters listing

{
  "cmd": "/adapters/listing", 
  "adapters-listing": "...."
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersPackageAdd

Add a new package of adapters

/rest/adapters/package/add

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/package/add", 
  "message": "package added"
}

Status: 400 - Bad request provided

Status: 401 - unauthorized


adaptersPackageDefault

set adapters package as default

/rest/adapters/package/default

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - adapters vXXXX is default

{
  "cmd": "/adapters/package/default", 
  "message": "success"
}

Status: 400 - Bad request provided

Status: 500 - Server error


adaptersPackageGeneric

set adapters package as generic

/rest/adapters/package/generic

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - adapters vXXXX is generic

{
  "cmd": "/adapters/package/generic", 
  "message": "success"
}

Status: 400 - Bad request provided

Status: 500 - Server error


Agents

agentsAdd

add a agent

/rest/agents/add

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/agents/add", 
  "message: "agent successfully added"
}

Status: 400 - Bad request provided

Status: 500 - Server error


agentsConnect

connect a agent

/rest/agents/connect

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/agents/connect", 
  "message: "agent successfully connected"
}

Status: 400 - Bad request provided

Status: 404 - Agent not found

Status: 500 - Server error


agentsDefault

Get all default agents

/rest/agents/default

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - default agents

{
  "cmd": "/agents/default", 
  "agents": ...
}

agentsDisconnect

Disconnect a agent by the name

/rest/agents/disconnect

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/agents/disconnect", 
  "message: "agent successfully disconnected"
}

Status: 400 - Bad request provided

Status: 404 - Agent not found


agentsRemove

remove a agent

/rest/agents/remove

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/agents/remove", 
  "message: "agent successfully removed"
}

Status: 400 - Bad request provided

Status: 500 - Server error


agentsRunning

Get all running agents

/rest/agents/running

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - running agents

{
  "cmd": "/agents/running", 
  "agents-running": ...
}

Libraries

librariesBuild

build libraries

/rest/libraries/build

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - libraries packaged

{
  "cmd": "/libraries/build", 
  "message": "unlocked"
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesCheckSyntax

check the syntax of a library

/rest/libraries/check/syntax

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/check/syntax", 
  success:
    type: boolean
  syntax-error:
    type: string
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


librariesDirectoryAdd

Add directory in the libraries storage

/rest/libraries/directory/add

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/directory/add", 
  "message": "directory successfully added"
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesDirectoryDuplicate

Duplicate directory in the libraries storage

/rest/libraries/directory/duplicate

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - rename response

{
  "cmd": "/libraries/directory/rename", 
  "message": "directory successfully renamed"
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesDirectoryMove

Move directory

/rest/libraries/directory/move

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - move response

{
  "cmd": "/libraries/directory/move", 
  "message": "directory successfully moved"
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesDirectoryRemove

remove directory in the libraries storage

/rest/libraries/directory/remove

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/directory/remove", 
  "message": "directory successfully removed"
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesDirectoryRename

Rename directory in the libraries storage

/rest/libraries/directory/rename

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - rename response

{
  "cmd": "/libraries/directory/rename", 
  "message": "directory successfully renamed"
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesFileDownload

download file from the test storage

/rest/libraries/file/download

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/file/download", 
  "file-content": "...."
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesFileDuplicate

Duplicate file in the libraries storage

/rest/libraries/file/duplicate

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/file/duplicate", 
  "message": "file successfully renamed"
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesFileMove

Move file

/rest/libraries/file/move

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - move response

{
  "cmd": "/libraries/file/move", 
  "message": "file successfully moved"
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesFileOpen

open and lock file from the test storage

/rest/libraries/file/open

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/file/open", 
  "file-content": "...."
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesFileRemove

remove file in the libraries storage

/rest/libraries/file/remove

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/file/remove", 
  "message": "file successfully removed"
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesFileRename

Rename file in the libraries storage

/rest/libraries/file/rename

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - rename response

{
  "cmd": "/libraries/file/rename", 
  "message": "file successfully renamed"
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesFileUnlock

unlock file in the libraries storage

/rest/libraries/file/unlock

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/file/unlock", 
  "message": "file successfully unlocked"
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesFileUpload

Upload file the test storage

/rest/libraries/file/upload

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/file/upload", 
  "code": 200
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesLibraryAdd

Add a new library

/rest/libraries/library/add

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/library/add", 
  "message": "library added"
}

Status: 400 - Bad request provided

Status: 401 - unauthorized


librariesListing

Get the listing of all libraries.

/rest/libraries/listing

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - libraries listing

{
  "cmd": "/libraries/listing", 
  "libraries-listing": "...."
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesPackageAdd

Add a new package of libraries

/rest/libraries/package/add

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/package/add", 
  "message": "package added"
}

Status: 400 - Bad request provided

Status: 401 - unauthorized


librariesPackageDefault

set libraries package as default

/rest/libraries/package/default

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/package/default", 
  "message": "success"
}

Status: 400 - Bad request provided

Status: 500 - Server error


librariesPackageGeneric

set libraries package as generic

/rest/libraries/package/generic

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/package/generic", 
  "message": "success"
}

Status: 400 - Bad request provided

Status: 500 - Server error


Metrics

metricsTestsDurationWriting

add the duration of developpement for a test

/rest/metrics/tests/duration/writing

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/metrics/tests/duration/writing", 
  "message": "duration added"
}

Status: 400 - Bad request provided

Status: 500 - Server error


Probes

probesAdd

add a probe

/rest/probes/add

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/probes/add", 
  "message: "probe successfully added"
}

Status: 400 - Bad request provided

Status: 500 - Server error


probesConnect

connect a probe

/rest/probes/connect

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/probes/connect", 
  "message: "probe successfully connected"
}

Status: 400 - Bad request provided

Status: 404 - Probe not found

Status: 500 - Server error


probesDefault

Get all default probes

/rest/probes/default

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - default probes

{
  "cmd": "/probes/default", 
  "probes": ...
}

probesDisconnect

Disconnect a probe by the name

/rest/probes/disconnect

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/probes/disconnect", 
  "message: "probe successfully disconnected"
}

Status: 400 - Bad request provided

Status: 404 - Probe not found


probesRemove

remove a probe

/rest/probes/remove

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/probes/remove", 
  "message: "probe successfully removed"
}

Status: 400 - Bad request provided

Status: 500 - Server error


probesRunning

Get all running probes

/rest/probes/running

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - running probes

{
  "cmd": "/probes/running", 
  "probes": ...
}

Reports

resultsReportComments

Get all comments in one report

/rest/results/report/comments

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - all test reports

{
  "cmd": "/results/reports", 
  "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
  "comments": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result not found

Status: 500 - Server error


resultsReportDesigns

Get all report designs

/rest/results/report/designs

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - all test reports

{
  "cmd": "/results/reports", 
  "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
  "design": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "xml-design": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV...."
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result not found

Status: 500 - Server error


resultsReportEvents

Get a report of events occured during the test

/rest/results/report/events

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - all test reports

{
  "cmd": "/results/reports", 
  "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
  "events": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV...."
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result not found

Status: 500 - Server error


resultsReportReviews

Get all report reviews

/rest/results/report/reviews

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - all test reports

{
  "cmd": "/results/report/reviews", 
  "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
  "basic-review": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "review": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV...."
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result not found

Status: 500 - Server error


resultsReportVerdicts

Get all report verdicts.

/rest/results/report/verdicts

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - all test reports

{
  "cmd": "/results/reports", 
  "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
  "verdict": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "xml-verdict": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV...."
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result not found

Status: 500 - Server error


resultsReports

Get all reports of one test (advanced and basic in all formats).

/rest/results/reports

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - all test reports

{
  "cmd": "/results/reports", 
  "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
  "basic-review": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "review": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "verdict": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "xml-verdict": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "design": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "xml-design": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "comments": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "events": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV...."
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result not found

Status: 500 - Server error


Results

resultsCommentAdd

Add a comment in a test result

/rest/results/comment/add

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/results/download/result", 
  "result": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "result-name": "....",
  "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
  "save-as": False,
  "save-as-dest: ""
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result by id not found

Status: 500 - Server error


resultsCommentsRemoveAll

Remove all comments in test result

/rest/results/comment/remove/all

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/results/download/result", 
  "result": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "result-name": "....",
  "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
  "save-as": False,
  "save-as-dest: ""
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result by id not found

Status: 500 - Server error


resultsCompressZip

Compress test result in one zip file

/rest/results/compress/zip

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - all tests results zipped

{
  "cmd": "/results/compress/zip", 
  "message": "....",
  "project-id": 22
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


resultsDownloadImage

Get image (png or jpg) from test result

/rest/results/download/image

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - image

{
  "cmd": "/results/download/image", 
  "image": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced"
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result not found

Status: 500 - Server error


resultsDownloadResult

Get result file in test result

/rest/results/download/result

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - image

{
  "cmd": "/results/download/result", 
  "result": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "result-name": "....",
  "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
  "save-as": False,
  "save-as-dest: ""
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result by id not found

Status: 500 - Server error


resultsDownloadUncomplete

Get result events event if the test is not yet terminated

/rest/results/download/uncomplete

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - image

{
  "cmd": "/results/download/uncomplete", 
  "result": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
  "result-name": "....",
  "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
  "save-as": False,
  "save-as-dest: ""
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result by id not found

Status: 500 - Server error


resultsFollow

Follow the result of one or several tests

/rest/results/follow

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/results/follow", 
  "project-id": 25
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


resultsListingFiles

Get the listing of all tests results

/rest/results/listing/files

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - all test results with details

{
  "cmd": "/results/listing/files", 
  "listing": [...],
  "nb-folders": 2,
  "nb-files":  2,
  "statistics": {...}
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


resultsListingIdByDatetime

Get the listing id of all tests results. Support date and time filtering.

/rest/results/listing/id/by/datetime

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - all tests results with id

{
  "cmd": "/results/listing/id/by/datetime", 
  "listing":  [...]
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


resultsRemoveByDate

Remove all tests results according to the date provided

/rest/results/remove/by/date

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - remove result

{
  "cmd": "/results/remove/by/date", 
  "message": "xxxxxxx",
  "project-id": 25
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result not found

Status: 500 - Server error


resultsRemoveById

Remove a test result according to the test id provided

/rest/results/remove/by/id

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - remove result

{
  "cmd": "/results/remove", 
  "message": "xxxx",
  "project-id": 25
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result not found

Status: 500 - Server error


resultsStatus

Get the status of the test (not-running, running, complete).

/rest/results/status

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - result status of a test

{
  "cmd": "/results/status", 
  "test-status": "running", 
  "test-id": "af0b2587-459e-42eb-a4da-e3e6fa227719",
  "test-progress": 25
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result not found

Status: 500 - Server error


resultsUploadFile

Upload a file in the test result

/rest/results/upload/file

Request parameters:

Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/results/upload/file", 
  "message": "success"
}

Status: 400 - Bad request provided

Status: 403 - Extension file refused

Status: 404 - Test result not found

Status: 500 - Server error


resultsVerdict

Get the end result of the test (undefined, pass, fail).

/rest/results/verdict

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - tests end result

{
  "cmd": "/results/verdict", 
  "test-verdict": "undefined",
  "test-id": "af0b2587-459e-42eb-a4da-e3e6fa227719"
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 404 - Test result not found

Status: 500 - Server error


Tests

testsBasicListing

Get the listing of all tests in basic mode.

/rest/tests/basic/listing

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/tests/basic/listing", 
  "listing": ["/Snippets/UI/03_OpenBrowser.tux", "/Snippets/UI/05_MaximizeBrowser.tux"],
  "project-id": 1
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


testsCheckSyntax

check the syntax of a test (unit, abstract and suite)

/rest/tests/check/syntax

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/tests/check/syntax/string", 
  "status": True,
  "error-msg": "...."
}

Status: 400 - Bad request provided

Status: 500 - Server error


testsCheckSyntaxTpg

check the syntax of a test (plan and global)

/rest/tests/check/syntax/tpg

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/tests/check/syntax/tpg", 
  "status": True,
  "error-msg": "...."
}

Status: 400 - Bad request provided

Status: 500 - Server error


testsCreateDesign

create the design of a test (unit, abstract and suite)

/rest/tests/create/design

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/tests/check/design", 
  "status": True,
  "error-msg": "...."
}

Status: 400 - Bad request provided

Status: 500 - Server error


testsCreateDesignTpg

create the design of a test (plan and global)

/rest/tests/create/design/tpg

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/tests/check/design/tpg", 
  "status": True,
  "error-msg": "...."
}

Status: 400 - Bad request provided

Status: 500 - Server error


testsDirectoryAdd

Add directory in the test storage

/rest/tests/directory/add

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/tests/directory/add", 
  "message": "directory successfully added"
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


testsDirectoryDuplicate

Duplicate directory in the test storage

/rest/tests/directory/duplicate

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - rename response

{
  "cmd": "/tests/directory/rename", 
  "message": "directory successfully renamed"
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


testsDirectoryMove

Move directory in the test storage

/rest/tests/directory/move

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - move response

{
  "cmd": "/tests/directory/move", 
  "message": "directory successfully moved"
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


testsDirectoryRemove

remove directory in the test storage

/rest/tests/directory/remove

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/tests/directory/remove", 
  "message": "directory successfully removed"
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


testsDirectoryRename

Rename directory in the test storage

/rest/tests/directory/rename

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - rename response

{
  "cmd": "/tests/directory/rename", 
  "message": "directory successfully renamed"
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


testsFileDownload

download file from the test storage

/rest/tests/file/download

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/tests/file/download", 
  "file-content": "...."
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


testsFileDuplicate

Duplicate file in the test storage

/rest/tests/file/duplicate

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - rename response

{
  "cmd": "/tests/file/rename", 
  "message": "file successfully renamed"
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


testsFileMove

Move file in the test storage

/rest/tests/file/move

Request parameters: