Platform

Get platforms

GET /platform

Description

Get list of platforms by project id.

Parameters

Type	Name	Description	Schema	Default
Query	maxResult optional	Maximum number of test scenarios to return in each call. Maximum possible value is 50. By default maximum value will be returned.	integer(int32)	`"50"`
Query	offset optional	Index of the first test scenarios to return.Default is 0.	integer(int32)	`"0"`
Query	projectId required	Id of project.	integer(int64)

Responses

HTTP Code	Description	Schema
200	Successful operation.	No Content
400	Returned if the project id is invalid.	No Content
403	Returned if the currently authenticated user does not have permission to access given project.	No Content
404	Returned if the given project is not found.	No Content
500	Returned if there is some problem in retrieval of platform.	No Content

Consumes

application/json

Produces

application/json

Tags

Platform

Add new platform

POST /platform

Description

Add new platform in given project.

Parameters

Type	Name	Description	Schema	Default
Body	body required	Platform object that needs to create	CreatePlatformRequest

Responses

HTTP Code	Description	Schema
200	Successful operation.	No Content
400	Returned if parameters is invalid.	No Content
403	Returned if the currently authenticated user does not have permission to access given project.	No Content
500	Returned if there is some problem in adding of platform.	No Content

Consumes

application/json

Produces

application/json

Tags

Platform

Delete platform

DELETE /platform/{platformId}

Description

Delete platform by platform id.

Parameters

Type	Name	Description	Schema	Default
Path	platformId required	Id of platform.	integer(int32)

Responses

HTTP Code	Description	Schema
200	Successful operation.	No Content
400	Returned if platform id is invalid.	No Content
403	Returned if the currently authenticated user does not have permission to access given project.	No Content
404	Returned if the given platform is not found.	No Content
500	Returned if there is some problem in deleting of platform.	No Content

Consumes

application/json

Produces

application/json

Tags

Platform

Get Platform

GET /platform/{platformId}

Description

Get platform by platform id.

Parameters

Type	Name	Description	Schema	Default
Path	platformId required	Id of platform.	integer(int32)

Responses

HTTP Code	Description	Schema
200	Successful operation.	No Content
400	Returned if platform id is invalid.	No Content
403	Returned if the currently authenticated user does not have permission to access given project.	No Content
404	Returned if the given platform is not found.	No Content
500	Returned if there is some problem in retrieval of platform.	No Content

Consumes

application/json

Produces

application/json

Tags

Platform

Update platform

PUT /platform/{platformId}

Description

Update platform by id.

Parameters

Type	Name	Description	Schema	Default
Path	platformId required	Id of platform.	integer(int32)
Body	body optional		UpdatePlatformRequest

Responses

HTTP Code	Description	Schema
200	Successful operation.	No Content
400	Returned if platform id is invalid.	No Content
403	Returned if the currently authenticated user does not have permission to access given project.	No Content
404	Returned if the given platform is not found.	No Content
500	Returned if there is some problem in updating of platform.	No Content

Consumes

application/json

Produces

application/json

Tags

Platform

CreatePlatformRequest

Name	Description	Schema
name required	Name of platform	string
projectId required	Id of project	integer(int64)

UpdatePlatformRequest

Name	Description	Required	Schema	Default
name	Name of platform	true	string