Swagger Admin - Extensive Automation

Adapters

adaptersBackup

Make a backup of all adapters

/rest/adapters/backup

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/adapters/backup", 
  "message": "created"
}

Status: 400 - Bad request provided

Status: 403 - Access refused

Status: 500 - Server error


adaptersBackupDownload

Download backup file

/rest/adapters/backup/download

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - backup file

{
  "cmd": "/rest/adapters/backup/download", 
  "backup": "....",
  "dest-name": "..."
}

Status: 400 - Bad request provided

Status: 403 - Access refused

Status: 500 - Server error


adaptersBackupListing

return the list of all backups

/rest/adapters/backup/listing

Request parameters:

Name Description
Cookie*

Responses

Status: 200 -

{
  "cmd": "/adapters/backup/listing", 
  "backups": "..."
}

Status: 403 - Access refused


adaptersBackupRemoveAll

remove all backups from adapters

/rest/adapters/backup/remove/all

Request parameters:

Name Description
Cookie*

Responses

Status: 200 -

{
  "cmd": "/tests/adapters/remove/all", 
  "message": "deleted"
}

Status: 403 - Access refused

Status: 500 - server error


adaptersDirectoryRemoveAll

remove all directories in the adapters storage

/rest/adapters/directory/remove/all

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

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

Status: 400 - Bad request provided

Status: 403 - Access refused

Status: 500 - Server error


adaptersFileUnlockAll

unlock all adapters

/rest/adapters/file/unlock/all

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - adapters unlocked

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

Status: 403 - Access refused

Status: 500 - Server error


adaptersReset

reset adapters

/rest/adapters/reset

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - adapters reseted

{
  "cmd": "/adapters/reset", 
  "message": "reseted"
}

Status: 403 - Access refused

Status: 500 - Server error


adaptersStatistics

get adapters statistics files

/rest/adapters/statistics

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - adapters statistics

{
  "cmd": "/adapters/statistics", 
  "statistics": "...."
}

Status: 403 - Access refused


adaptersSyntaxAll

check syntax for all adapters

/rest/adapters/syntax/all

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - syntax is good

{
  "cmd": "/adapters/syntax/all", 
  "syntax-status": True,
  "syntax-error": ""
}

Status: 403 - Access refused


Admin

adminClientsDeploy

Deploy clients

/rest/administration/clients/deploy

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - null

{
  "cmd": "/administration/clients/deploy", 
  "status": "deployed"
}

Status: 403 - Access refused


adminConfigurationReload

Reload the configuration

/rest/administration/configuration/reload

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - null

{
  "cmd": "/administration/configuration/reload", 
  "status": "reloaded" 
}

Status: 403 - Access refused


adminConfigurationgListing

Get all configuration

/rest/administration/configurationg/listing

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - null

{
  "cmd": "/administration/configurationg/listing"
}

Status: 403 - Access refused


adminProjectsAdd

Add a project

/rest/administration/projects/add

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/administration/projects/add", 
  "message: "project successfully added"
}

Status: 400 - Bad request provided

Status: 403 - Project name already used

Status: 500 - Server error


adminProjectsListing

Get all projects

/rest/administration/projects/listing

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - null

{
  "cmd": "/administration/projects/listing", 
  "projects: "...."
}

Status: 400 - Bad request provided

Status: 500 - Server error


adminProjectsRemove

Remove a project

/rest/administration/projects/remove

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/administration/projects/remove", 
  "message: "project successfully removed"
}

Status: 400 - Bad request provided

Status: 403 - Deletion not authorized

Status: 500 - Server error


adminProjectsRename

Rename a project

/rest/administration/projects/rename

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/administration/projects/rename", 
  "message: "project successfully renamed"
}

Status: 400 - Bad request provided

Status: 403 - Name already exist or rename not authorized

Status: 500 - Server error


adminProjectsStatistics

Get statistics on projects

/rest/administration/projects/statistics

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - null

{
  "cmd": "/administration/projects/statistics", 
  "projects-statistics: "...."
}

Status: 400 - Bad request provided

Status: 500 - Server error


adminTimeShift

Shift the local time

/rest/administration/time/shift

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/administration/time/shift", 
  "message": "shifted"
}

Status: 400 - Bad request provided

Status: 403 - Access refused


adminUsersAdd

Add a new user in the server

/rest/administration/users/add

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/administration/users/add", 
  "message: "user successfully added"
}

Status: 400 - Bad request provided

Status: 404 - User not found

Status: 500 - Server error


adminUsersChannelDisconnect

Force channel disconnection for a user

/rest/administration/users/channel/disconnect

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/administration/users/channel/disconnect", 
  "message: "user successfully disconnected"
}

Status: 400 - Bad request provided

Status: 404 - User not found


adminUsersDuplicate

Duplicate user

/rest/administration/users/duplicate

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/administration/users/duplicate", 
  "message: "user successfully duplicated"
}

Status: 400 - Bad request provided

Status: 404 - User not found

Status: 500 - Server error


adminUsersListing

Get all users

/rest/administration/users/listing

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - null

{
  "cmd": "/administration/users/listing"
}

Status: 403 - Access refused

Status: 500 - Server error


adminUsersPasswordReset

Reset the password of a user

/rest/administration/users/password/reset

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/administration/users/password/reset", 
  "message: "password successfully reseted"
}

Status: 400 - Bad request provided

Status: 404 - User not found

Status: 500 - Unable to reset the password


adminUsersProfile

Get the profile of a user

/rest/administration/users/profile

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/administration/users/profile"
}

Status: 403 - Access refused

Status: 404 - User not found

Status: 500 - Server error


adminUsersRemove

Remove a user

/rest/administration/users/remove

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/administration/users/remove", 
  "message: "user successfully removed"
}

Status: 400 - Bad request provided

Status: 403 - Not authorized

Status: 404 - User not found

Status: 500 - Unable to remove the user


adminUsersSearch

Search user according to the id

/rest/administration/users/search

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/administration/users/search"
}

Status: 400 - Bad request provided

Status: 403 - Access refused

Status: 404 - User not found

Status: 500 - Server error


adminUsersStatistics

Users statistics

/rest/administration/users/statistics

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - null

{
  "cmd": "/administration/users/statistics"
}

Status: 403 - Access refused

Status: 500 - Server error


adminUsersStatus

Set the status of the user (enabled or not)

/rest/administration/users/status

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/administration/users/status", 
  "message: "probe successfully disconnected"
}

Status: 400 - Bad request provided

Status: 404 - User not found

Status: 500 - Server error


Libraries

librariesBackup

Make a backup of all libraries

/rest/libraries/backup

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/libraries/backup", 
  "message": "created"
}

Status: 400 - Bad request provided

Status: 403 - Access refused

Status: 500 - Server error


librariesBackupDownload

Download backup file

/rest/libraries/backup/download

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - backup file

{
  "cmd": "/rest/libraries/backup/download", 
  "backup": "....",
  "dest-name": "..."
}

Status: 400 - Bad request provided

Status: 403 - Access refused

Status: 500 - Server error


librariesBackupListing

return the list of all backups

/rest/libraries/backup/listing

Request parameters:

Name Description
Cookie*

Responses

Status: 200 -

{
  "cmd": "/libraries/backup/listing", 
  "backups": "..."
}

Status: 403 - Access refused


librariesBackupRemoveAll

remove all backups from libraries

/rest/libraries/backup/remove/all

Request parameters:

Name Description
Cookie*

Responses

Status: 200 -

{
  "cmd": "/tests/libraries/remove/all", 
  "message": "deleted"
}

Status: 403 - Access refused

Status: 500 - Server error


librariesDirectoryRemoveAll

remove all directories in the libraries storage

/rest/libraries/directory/remove/all

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

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

Status: 400 - Bad request provided

Status: 403 - Removing directory denied

Status: 500 - Server error


librariesFileUnlockAll

unlock all libraries

/rest/libraries/file/unlock/all

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - libraries unlocked

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

Status: 403 - Access refused

Status: 500 - Server error


librariesReset

reset libraries

/rest/libraries/reset

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - libraries reseted

{
  "cmd": "/libraries/reset", 
  "message": "reseted"
}

Status: 403 - Access refused

Status: 500 - Server error


librariesStatistics

get libraries statistics files

/rest/libraries/statistics

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - libraries statistics

{
  "cmd": "/libraries/statistics", 
  "statistics": "...."
}

Status: 403 - Access refused


librariesSyntaxAll

check syntax for all libraries

/rest/libraries/syntax/all

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - syntax is good

{
  "cmd": "/libraries/syntax/all", 
  "syntax-status": True,
  "syntax-error": ""
}

Status: 403 - Access refused


Metrics

metricsTestsReset

Reset tests statistics

/rest/metrics/tests/reset

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - statistics reseted

{
  "cmd": "/metrics/reset", 
  "message": "tests statistics reseted"
}

Status: 403 - Access refused

Status: 500 - Server error


Results

resultsBackup

Make a backup of all tests results

/rest/results/backup

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/results/backup", 
  "message": "created"
}

Status: 400 - Bad request provided

Status: 401 - unauthorized

Status: 403 - Access refused


resultsBackupDownload

Download backup file

/rest/results/backup/download

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - backup file

{
  "cmd": "/rest/results/backup/download", 
  "backup": "....",
  "dest-name": "..."
}

Status: 400 - Bad request provided

Status: 403 - Access refused

Status: 500 - Server error


resultsBackupListing

return the list of all backups

/rest/results/backup/listing

Request parameters:

Name Description
Cookie*

Responses

Status: 200 -

{
  "cmd": "/results/backup/listing", 
  "backups": "..."
}

Status: 401 - unauthorized

Status: 403 - Access refused


resultsBackupRemoveAll

remove all backups from test results

/rest/results/backup/remove/all

Request parameters:

Name Description
Cookie*

Responses

Status: 200 -

{
  "cmd": "/tests/results/remove/all", 
  "message": "deleted"
}

Status: 403 - Access refused

Status: 500 - server error


resultsReset

Remove all the tests results according to the project provided

/rest/results/reset

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - image

{
  "cmd": "/results/reset", 
  "message": "xxxxxxxx"
}

Status: 400 - Bad request provided

Status: 403 - Access denied to this project

Status: 500 - Server error


resultsStatistics

get results statistics files

/rest/results/statistics

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - results statistics

{
  "cmd": "/results/statistics", 
  "statistics": "...."
}

Status: 400 - Bad request provided

Status: 403 - Access refused


Tasks

tasksCancelAll

Cancel all waiting tasks, only with admin level

/rest/tasks/cancel/all

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - Tasks successfully cancelled

{
  "message": "tasks successfully cancelled",
  "cmd": "/tasks/cancel/all"
}

Status: 403 - Access refused


tasksHistoryClear

Reset history tasks, only with admin level

/rest/tasks/history/clear

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - History tasks successfully reseted

{
  "message": "tasks successfully reseted",
  "cmd": "/tasks/history/clear"
}

Status: 403 - Access refused

Status: 500 - Server error


tasksKillAll

Kill all running tasks, only with admin level

/rest/tasks/kill/all

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - Tasks successfully killed

{
  "message": "tasks successfully killed",
  "cmd": "/tasks/kill/all"
}

Status: 403 - Access refused


Tests

testsBackup

Make a backup of all tests

/rest/tests/backup

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/tests/backup", 
  "message": "created"
}

Status: 400 - Bad request provided

Status: 401 - unauthorized

Status: 403 - Access refused


testsBackupDownload

Download backup file

/rest/tests/backup/download

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - backup file

{
  "cmd": "/rest/tests/backup/download", 
  "backup": "....",
  "dest-name": "..."
}

Status: 400 - Bad request provided

Status: 403 - Access refused

Status: 500 - Server error


testsBackupListing

return the list of all backups

/rest/tests/backup/listing

Request parameters:

Name Description
Cookie*

Responses

Status: 200 -

{
  "cmd": "/tests/backup/listing", 
  "backups": "..."
}

Status: 403 - Access refused


testsBackupRemoveAll

remove all backups from tests

/rest/tests/backup/remove/all

Request parameters:

Name Description
Cookie*

Responses

Status: 200 -

{
  "cmd": "/tests/tests/backup/remove/all", 
  "message": "deleted"
}

Status: 403 - Access refused

Status: 500 - server error


testsBuildSamples

build tests samples

/rest/tests/build/samples

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - tests packaged

{
  "cmd": "/tests/build/samples", 
  "message": "unlocked"
}

Status: 403 - Access refused

Status: 500 - Server error


testsDirectoryRemoveAll

remove all directories in the test storage

/rest/tests/directory/remove/all

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

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

Status: 400 - Bad request provided

Status: 403 - Access refused

Status: 500 - Server error


testsFileDefaultAll

set all tests with the default adapters and libraries version

/rest/tests/file/default/all

Request parameters:

Name Description
Cookie*

Responses

Status: 200 -

{
  "cmd": "/tests/file/unlock/all", 
  "message": "unlocked"
}

Status: 403 - Access refused

Status: 500 - Server error


testsFileUnlockAll

unlock tests

/rest/tests/file/unlock/all

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - tests unlocked

{
  "cmd": "/tests/file/unlock/all", 
  "message": "unlocked"
}

Status: 403 - Access refused

Status: 500 - Server error


testsReset

reset tests

/rest/tests/reset

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - tests uninstalled

{
  "cmd": "/tests/reset", 
  "message": "reseted"
}

Status: 403 - Access refused

Status: 500 - Server error


testsSnapshotRemoveAll

remove all snapshots according to the test provided

/rest/tests/snapshot/remove/all

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 -

{
  "cmd": "/rest/tests/snapshot/remove/all", 
  "message": "all snapshots removed"
}

Status: 400 - Bad request provided

Status: 403 - Access refused

Status: 500 - Server error


testsStatistics

get tests statistics files

/rest/tests/statistics

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - tests statistics

{
  "cmd": "/tests/statistics", 
  "statistics": "...."
}

Status: 400 - Bad request provided

Status: 403 - Access refused


Variables

variablesReset

Reset all test variables according to the project

/rest/variables/reset

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - variables successfully reseted

{
  "message": "variables successfully reseted",
  "cmd": "/variables/reset"
}

Status: 400 - Bad request provided | Bad project id provided | Bad json provided in value

Status: 403 - Access refused

Status: 500 - Server error


Generated 2018-08-09T03:00:41.330-04:00