Swagger Common - Extensive Testing

Admin

adminProjectsSearchByName

Search a project by name

/rest/administration/projects/search/by/name

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - null

{
  "cmd": "/administration/projects/search/by/name",
  "project: {}
}

Status: 400 - Bad request provided

Status: 500 - Server error


Clients

clientsAvailable

check if a new client is available

/rest/clients/available

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - results statistics

{
  "cmd": "/clients/available", 
  "client-available": True,
  "version": "1.0.0",
  "name: "...."
}

Status: 400 - Bad request provided

Status: 500 - Server error


clientsDownload

download client

/rest/clients/download

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - results statistics

{
  "cmd": "/clients/download", 
  "client-binary": "...."
}

Status: 400 - Bad request provided

Status: 500 - Server error


Documentations

documentationsBuild

build a cache for the documentations

/rest/documentations/build

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - usages

{
  "build": "success",
  "cmd": "/documentations/build"
}

Status: 401 - Access denied


documentationsCache

get documentations from cache

/rest/documentations/cache

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - usages

{
  "cache": "....",
  "cmd": "/documentations/cache"
}

Status: 401 - Access denied


Session

sessionContext

Context session

/rest/session/context

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - Session refreshed

{
  "context": "xxxxxxxxxxxx",
  "cmd": "/session/context"
}

Status: 401 - Access denied


sessionContextAll

get full context

/rest/session/context/all

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - Session refreshed

{
  "context": "xxxxxxxxxxxx",
  "cmd": "/session/context"
}

Status: 401 - Access denied


sessionContextNotify

Notify all users with context

/rest/session/context/notify

Request parameters:

Name Description
Cookie*

Responses

Status: 200 -

{
  "message": "success",
  "cmd": "/session/context/notify"
}

Status: 401 - Access denied


sessionLogin

Authenticate client

/rest/session/login

Request parameters:

Name Description
body *

Responses

Status: 200 - Logged in

{
  "expires": 86400, 
  "user_id": 2, 
  "cmd": "/session/login", 
  "session_id": "NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M", 
  "message": "Logged in", 
  "project_id": 1
}
Name Description
Set-Cookie session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M;expires=Wed, 10-May-2017 06:32:57 GMT; path=/

Status: 400 - Bad request provided

Status: 401 - Invalid login | Account disabled | Access not authorized | Invalid password


sessionLogout

Logout client

/rest/session/logout

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - Logged out | Not logged in

{
  "message": "logged out",
  "cmd": "/session/logout"
}
Name Description
Set-Cookie session_id=DELETED;expires=Thu, 01 Jan 1970 00:00:00 GMT; path=/

sessionRefresh

Refresh session

/rest/session/refresh

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - Session refreshed

{
  "message": "session refreshed",
  "cmd": "/session/refresh"
}
Name Description
Set-Cookie session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M;expires=Wed, 10-May-2017 06:32:57 GMT; path=/

Status: 401 - Access denied


System

systemAbout

get system about

/rest/system/about

Request parameters:

Name Description
Cookie*

Responses

Status: 200 -

{
  "about": { 'rn': '...', 'version': '...', 'network': '...'},
  "cmd": "/system/about"
}

Status: 401 - Access denied


systemStatus

get system status

/rest/system/status

Request parameters:

Name Description
Cookie*

Responses

Status: 200 -

{
  "status": { 'start-at': '...', 'current-date': '...', 'uptime': '...' },
  "cmd": "/system/status"
}

Status: 401 - Access denied


systemUsages

get system usages

/rest/system/usages

Request parameters:

Name Description
Cookie*

Responses

Status: 200 -

{
  "disk": {...},
  "cmd": "/system/usages"
}

Status: 401 - Access denied


Tasks

tasksCancel

Cancel one specific task according to the id

/rest/tasks/cancel

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - Task successfully cancelled

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

Status: 401 - Access denied


tasksCancelSelective

Cancel one or more tasks according to the id

/rest/tasks/cancel/selective

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - Tasks successfully cancelled

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

Status: 401 - Access denied


tasksComment

add a comment to the task

/rest/tasks/comment

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - task replayed with success

{
  "message": "comment added with success",
  "cmd": "/tasks/comment"
}

Status: 401 - Access denied


tasksDesign

get the design as report of my task

/rest/tasks/design

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - task replayed with success

{
  "message": "task replayed with success",
  "cmd": "/tasks/replay"
}

Status: 401 - Access denied


tasksHistory

Get my partial history tasks or all with admin level

/rest/tasks/history

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - History tasks

{
  "tasks-history": [],
  "cmd": "/tasks/history"
}

Status: 401 - Access denied


tasksHistoryAll

Get all my history tasks or all with admin level

/rest/tasks/history/all

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - History tasks

{
  "tasks-history": [],
  "cmd": "/tasks/history/all"
}

Status: 401 - Access denied


tasksKill

Kill one specific task according to the id

/rest/tasks/kill

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - Task successfully killed

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

Status: 401 - Access denied


tasksKillSelective

Kill one or more tasks according to the id

/rest/tasks/kill/selective

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - Tasks successfully killed

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

Status: 401 - Access denied


tasksReschedule

Reschedule a test

/rest/tasks/reschedule

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - task successfully rescheduled

{
  "message": "task successfully rescheduled",
  "cmd": "/tasks/reschedule"
}

Status: 401 - Access denied


tasksReview

get the review as report of my test

/rest/tasks/review

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - task replayed with success

{
  "message": "task replayed with success",
  "cmd": "/tasks/review"
}

Status: 401 - Access denied


tasksRunning

Get all my running tasks or all with admin level

/rest/tasks/running

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - Running tasks

{
  "tasks-running": [],
  "cmd": "/tasks/running"
}

Status: 401 - Access denied


tasksVerdict

get the verdict as report of my task

/rest/tasks/verdict

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - task replayed with success

{
  "message": "task replayed with success",
  "cmd": "/tasks/verdict"
}

Status: 401 - Access denied


tasksWaiting

Get all my waiting tasks or all with admin level

/rest/tasks/waiting

Request parameters:

Name Description
Cookie*

Responses

Status: 200 - Waiting tasks

{
  "tasks-waiting": [],
  "cmd": "/tasks/waiting"
}

Status: 401 - Access denied


tastkReplay

replay my task

/rest/tasks/replay

Request parameters:

Name Description
Cookie*
Name Description
body *

Responses

Status: 200 - task replayed with success

{
  "message": "task replayed with success",
  "cmd": "/tasks/replay"
}

Status: 401 - Access denied


Generated 2018-02-11T10:32:32.534+01:00