Back to QMetry All Products Help Page
Execution Result
Add execution result
POST /executionresult
Description
Add new execution result in given project.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter | body | Execution result object that needs to be created. | true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 | Successful operation. | No Content |
400 | Returned if the given execution result or project is invalid. | No Content |
403 | Returned if the currently athenticated user does not have permission to access the given project. | No Content |
404 | Returned if the given execution result or project is not found. | No Content |
500 | Returned if some problem occured while creating an execution result to the given project. | No Content |
Consumes
application/json
Produces
application/json
Tags
Execution Result
Get execution results
GET /executionresult
Description
Returns the execution results of the given project.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter | projectId | Project id. | false | integer (int64) | |
QueryParameter | maxResults | Maximum number of execution results to return in each call.Default is 100. Max possible value is 100. | false | integer (int32) | 100 |
QueryParameter | offset | Index of the first execution result to return.Default is 0. | false | integer (int32) | 0 |
QueryParameter | fromgadget | Whether request come from gedgat or not . | false | boolean | false |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 | Successful operation. | No Content |
400 | Returned if the given project is invalid. | No Content |
403 | Returned if the currently athenticated user does not have permission to access the given project. | No Content |
404 | Returned if the given project is not found. | No Content |
500 | Returned if some problem occured during retrieval of execution results. | No Content |
Produces
application/json
Tags
Execution Result
Delete execution result
DELETE /executionresult/{id}Description
Delete execution result from the given project.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter | id | Execution result id | true | integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 | Successful operation. | No Content |
400 | Returned if the given execution result is invalid. | No Content |
403 | Returned if the currently athenticated user does not have permission to access the given project. | No Content |
404 | Returned if the given execution result or project is not found. | No Content |
500 | Returned if some problem occured during deleting an execution result. | No Content |
Produces
application/json
Tags
Execution Result
Get an execution result
GET /executionresult/{id}Description
Returns an execution result by id.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter | id | Id of execution result. | true | integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 | Successful operation. | No Content |
400 | Returned if the given execution result or project is invalid. | No Content |
403 | Returned if the currently athenticated user does not have permission to access the given project. | No Content |
404 | Returned if the given execution result or project is not found. | No Content |
500 | Returned if some problem occured during retrieval of execution result. | No Content |
Produces
application/json
Tags
Execution Result
Update execution result
PUT /executionresult/{id}Description
Update execution result by id. Either name, fore color or back color is required field.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter | id | Execution result id. | true | integer (int32) | |
BodyParameter | body | Execution result object that needs to be updated. | true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 | Successful operation. | No Content |
400 | Returned if the given execution result is invalid. | No Content |
403 | Returned if the currently athenticated user does not have permission to access the given project. | No Content |
404 | Returned if the given execution result details are not found. | No Content |
500 | Returned if some problem occured while updating an existing execution result. | No Content |
Consumes
application/json
Produces
application/json
Tags
Execution Result
CreateExecutionResultRequest
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
projectId | Project Id | true | integer (int64) | |
name | Name of execution result. | true | string | |
priority | Priority | false | integer (int32) | |
foreColor | Fore color Example: #FFFFFF | true | string | |
backColor | Backgroud color. Example: #59AFE1 | true | string | |
projectKey | Project Key | true | string |
UpdateExecutionResultRequest
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name | Name | false | string | |
priority | Priority | false | integer (int32) | |
foreColor | Fore color Example: #FFFFFF | false | string | |
backColor | Back color Example: #59AFE1 | false | string |
Back to QMetry All Products Help Page