Back to QMetry All Products Help Page
Platform API
Add new platform
POST /platform
Description
Add new platform in given project.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter | body | Platform object that needs to create | true |
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
Get platforms
GET /platform
Description
Get list of platforms by project id.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter | projectId | Id of project. | false | integer (int64) | |
QueryParameter | maxResult | Maximum number of test scenarios to return in each call. Maximum possible value is 100. By default maximum value will be returned. | false | integer (int32) | 100 |
QueryParameter | offset | Index of the first test scenarios to return.Default is 0. | false | integer (int32) | 0 |
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
Delete platform
DELETE /platform/{platformId}Description
Delete platform by platform id.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter | platformId | Id of platform. | true | 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 | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter | platformId | Id of platform. | true | 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 | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter | platformId | Id of platform. | true | integer (int32) | |
BodyParameter | body | false |
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 | Required | Schema | Default |
|---|---|---|---|---|
projectId | Id of project | true | integer (int64) | |
name | Name of platform | true | string |
UpdatePlatformRequest
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name | Name of platform | true | string |
Back to QMetry All Products Help Page