openapi: 3.0.1
info:
contact:
name: Polarion REST API Support
url: https://support.sw.siemens.com/
description:
About
The Polarion REST API lets you interact with Polarion programmatically. Use this API to integrate Polarion with your applications. This page documents the REST resources, including the HTTP response codes and example requests and responses.
For a detailed description of the REST API and how to use it, see the REST API User Guide (available on Support Center).
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
title: Polarion REST Account Test Runs API
version: v1
servers:
- url: https://example.com/polarion/rest/v1
security:
- bearerAuth: []
tags:
- name: Test Runs
paths:
/projects/{projectId}/testruns:
delete:
operationId: deleteTestRuns
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/testrunsListDeleteRequest'
description: The Test Run(s) body.
required: true
responses:
'204':
description: No Content
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'409':
description: Conflict
'413':
description: Request Entity Too Large
'415':
description: Unsupported Media Type
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Deletes a list of Test Runs.
tags:
- Test Runs
get:
operationId: getTestRuns
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: page[size]
in: query
description: Limit the number of entities returned in a single response. See REST API User Guide for details.
schema:
type: integer
format: int32
- name: page[number]
in: query
description: Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.
schema:
type: integer
format: int32
- name: fields
in: query
description: Filter returned resource fields. See REST API User Guide for details.
style: deepObject
schema:
$ref: '#/components/schemas/sparseFields'
- name: include
in: query
description: Include related entities. See REST API User Guide for details.
schema:
type: string
- name: query
in: query
description: The query string.
schema:
type: string
- name: sort
in: query
description: The sort string.
schema:
type: string
- name: revision
in: query
description: The revision ID.
schema:
type: string
- name: templates
in: query
description: If set to true, only templates will be returned, otherwise only actual instances will be returned.
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/testrunsListGetResponse'
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Returns a list of Test Runs.
tags:
- Test Runs
patch:
operationId: patchTestRuns
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/testrunsListPatchRequest'
description: The Test Run(s) body.
required: true
responses:
'204':
description: No Content
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'409':
description: Conflict
'413':
description: Request Entity Too Large
'415':
description: Unsupported Media Type
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Updates a list of Test Runs.
tags:
- Test Runs
post:
operationId: postTestRuns
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/testrunsListPostRequest'
description: The Test Run(s) body.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/testrunsListPostResponse'
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'409':
description: Conflict
'413':
description: Request Entity Too Large
'415':
description: Unsupported Media Type
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Creates a list of Test Runs.
tags:
- Test Runs
/projects/{projectId}/testruns/{testRunId}:
delete:
operationId: deleteTestRun
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'409':
description: Conflict
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Deletes the specified Test Run.
tags:
- Test Runs
get:
operationId: getTestRun
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
- name: fields
in: query
description: Filter returned resource fields. See REST API User Guide for details.
style: deepObject
schema:
$ref: '#/components/schemas/sparseFields'
- name: include
in: query
description: Include related entities. See REST API User Guide for details.
schema:
type: string
- name: revision
in: query
description: The revision ID.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/testrunsSingleGetResponse'
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Returns the specified Test Run.
tags:
- Test Runs
patch:
operationId: patchTestRun
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/testrunsSinglePatchRequest'
description: The Test Run(s) body.
required: true
responses:
'204':
description: No Content
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'409':
description: Conflict
'413':
description: Request Entity Too Large
'415':
description: Unsupported Media Type
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Updates the specified Test Run.
tags:
- Test Runs
/projects/{projectId}/testruns/{testRunId}/actions/exportTestsToExcel:
get:
operationId: getExportExcelTests
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
- name: query
in: query
description: The query string.
schema:
type: string
- name: sortBy
in: query
description: The property to sort the test results.
schema:
type: string
- name: template
in: query
description: The export template string.
schema:
type: string
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/jobsSinglePostResponse'
description: Accepted
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'413':
description: Request Entity Too Large
'415':
description: Unsupported Media Type
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Exports tests to Excel.
tags:
- Test Runs
/projects/{projectId}/testruns/{testRunId}/actions/getWorkflowActions:
get:
operationId: getWorkflowActionsForTestRun
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
- name: page[size]
in: query
description: Limit the number of entities returned in a single response. See REST API User Guide for details.
schema:
type: integer
format: int32
- name: page[number]
in: query
description: Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.
schema:
type: integer
format: int32
- name: revision
in: query
description: The revision ID.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/workflowActionsActionResponseBody'
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Returns a list of Workflow Actions.
tags:
- Test Runs
/projects/{projectId}/testruns/{testRunId}/actions/importExcelTestResults:
post:
operationId: importExcelTestResults
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/PostImportActionRequestBody'
description: Excel import meta data and file data.
required: true
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/jobsSinglePostResponse'
description: Accepted
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Imports Excel test results.
tags:
- Test Runs
/projects/{projectId}/testruns/{testRunId}/actions/importXUnitTestResults:
post:
operationId: importXUnitTestResults
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
requestBody:
content:
application/octet-stream:
schema:
type: object
description: XUnit File.
required: true
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/jobsSinglePostResponse'
description: Accepted
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Imports XUnit test results.
tags:
- Test Runs
/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions:
get:
operationId: getTestRunTestParameterDefinitions
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
- name: page[size]
in: query
description: Limit the number of entities returned in a single response. See REST API User Guide for details.
schema:
type: integer
format: int32
- name: page[number]
in: query
description: Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.
schema:
type: integer
format: int32
- name: fields
in: query
description: Filter returned resource fields. See REST API User Guide for details.
style: deepObject
schema:
$ref: '#/components/schemas/sparseFields'
- name: include
in: query
description: Include related entities. See REST API User Guide for details.
schema:
type: string
- name: revision
in: query
description: The revision ID.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/testparameter_definitionsListGetResponse'
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Returns a list of Test Parameter Definitions for the specified Test Run.
tags:
- Test Runs
post:
operationId: postTestRunParameterDefinitions
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/testparameter_definitionsListPostRequest'
description: The Test Parameter Definition(s) body.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/testparameter_definitionsListPostResponse'
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'409':
description: Conflict
'413':
description: Request Entity Too Large
'415':
description: Unsupported Media Type
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Creates a list of Test Parameter Definitions for the specified Test Run.
tags:
- Test Runs
/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions/{testParamId}:
delete:
operationId: deleteTestRunTestParameterDefinition
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
- name: testParamId
in: path
description: The Test Parameter.
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'409':
description: Conflict
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Deletes the specified Test Parameter Definition for the specified Test Run.
tags:
- Test Runs
get:
operationId: getTestRunTestParameterDefinition
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
- name: testParamId
in: path
description: The Test Parameter.
required: true
schema:
type: string
- name: fields
in: query
description: Filter returned resource fields. See REST API User Guide for details.
style: deepObject
schema:
$ref: '#/components/schemas/sparseFields'
- name: include
in: query
description: Include related entities. See REST API User Guide for details.
schema:
type: string
- name: revision
in: query
description: The revision ID.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/testparameter_definitionsSingleGetResponse'
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Returns the specified Test Parameter Definition for the specified Test Run.
tags:
- Test Runs
/projects/{projectId}/testruns/{testRunId}/testparameters:
delete:
operationId: deleteTestRunTestParameters
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/testparametersListDeleteRequest'
description: The Test Parameter(s) body.
required: true
responses:
'204':
description: No Content
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'409':
description: Conflict
'413':
description: Request Entity Too Large
'415':
description: Unsupported Media Type
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Deletes a list of Test Parameters for the specified Test Run.
tags:
- Test Runs
get:
operationId: getTestRunTestParameters
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
- name: page[size]
in: query
description: Limit the number of entities returned in a single response. See REST API User Guide for details.
schema:
type: integer
format: int32
- name: page[number]
in: query
description: Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.
schema:
type: integer
format: int32
- name: fields
in: query
description: Filter returned resource fields. See REST API User Guide for details.
style: deepObject
schema:
$ref: '#/components/schemas/sparseFields'
- name: include
in: query
description: Include related entities. See REST API User Guide for details.
schema:
type: string
- name: revision
in: query
description: The revision ID.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/testparametersListGetResponse'
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Returns a list of Test Parameters for the specified Test Run.
tags:
- Test Runs
post:
operationId: postTestRunTestParameters
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/testparametersListPostRequest'
description: The Test Parameter(s) body.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/testparametersListPostResponse'
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
'409':
description: Conflict
'413':
description: Request Entity Too Large
'415':
description: Unsupported Media Type
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Creates a list of Test Parameters for the specified Test Run.
tags:
- Test Runs
/projects/{projectId}/testruns/{testRunId}/testparameters/{testParamId}:
delete:
operationId: deleteTestRunTestParameter
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
- name: testParamId
in: path
description: The Test Parameter.
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'409':
description: Conflict
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Deletes the specified Test Parameter for the specified Test Run.
tags:
- Test Runs
get:
operationId: getTestRunTestParameter
parameters:
- name: projectId
in: path
description: The Project ID.
required: true
schema:
type: string
- name: testRunId
in: path
description: The Test Run ID.
required: true
schema:
type: string
- name: testParamId
in: path
description: The Test Parameter.
required: true
schema:
type: string
- name: fields
in: query
description: Filter returned resource fields. See REST API User Guide for details.
style: deepObject
schema:
$ref: '#/components/schemas/sparseFields'
- name: include
in: query
description: Include related entities. See REST API User Guide for details.
schema:
type: string
- name: revision
in: query
description: The revision ID.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/testparametersSingleGetResponse'
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'406':
description: Not Acceptable
4XX-5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/errors'
description: 'Error responses have the following structure:'
'500':
description: Internal Server Error
'503':
description: Service Unavailable
summary: Returns the specified Test Parameter for the specified Test Run.
tags:
- Test Runs
components:
schemas:
testparametersListGetResponse:
properties:
data:
items:
properties:
type:
enum:
- testparameters
type: string
id:
example: MyProjectId/MyTestRunId/MyTestParameter
type: string
revision:
example: '1234'
type: string
attributes:
properties:
name:
example: Example Test Parameter value
type: string
value:
example: Example Test Parameter value
type: string
type: object
relationships:
properties:
definition:
properties:
data:
properties:
id:
example: MyProjectId/MyTestParamDefinition
type: string
revision:
example: '1234'
type: string
type:
enum:
- testparameter_definitions
type: string
type: object
type: object
type: object
links:
properties:
self:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter
type: string
type: object
meta:
properties:
errors:
items:
properties:
detail:
description: Human-readable explanation specific to this occurrence of the problem.
example: 'Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)'
type: string
source:
properties:
parameter:
description: String indicating which URI query parameter caused the error.
example: revision
type: string
pointer:
description: JSON Pointer to the associated entity in the request document.
example: $.data
type: string
resource:
description: Resource causing the error.
properties:
id:
example: MyProjectId/id
type: string
type:
example: type
type: string
type: object
type: object
status:
description: HTTP status code applicable to this problem.
example: '400'
type: string
title:
description: Short, human-readable summary of the problem.
example: Bad Request
type: string
type: object
type: array
type: object
type: object
type: array
included:
description: Related entities might be returned, see REST API User Guide.
items:
type: object
type: array
links:
properties:
first:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=1
type: string
last:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=9
type: string
next:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=6
type: string
prev:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=4
type: string
self:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=5
type: string
type: object
meta:
properties:
totalCount:
format: int32
type: integer
type: object
type: object
testparameter_definitionsListPostRequest:
properties:
data:
items:
properties:
type:
enum:
- testparameter_definitions
type: string
attributes:
properties:
name:
example: Test Parameter Definition example
type: string
type: object
type: object
type: array
type: object
testparameter_definitionsSingleGetResponse:
properties:
data:
properties:
type:
enum:
- testparameter_definitions
type: string
id:
example: MyProjectId/MyTestParamDefinition
type: string
revision:
example: '1234'
type: string
attributes:
properties:
name:
example: Test Parameter Definition example
type: string
type: object
links:
properties:
self:
example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition
type: string
type: object
meta:
properties:
errors:
items:
properties:
detail:
description: Human-readable explanation specific to this occurrence of the problem.
example: 'Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)'
type: string
source:
properties:
parameter:
description: String indicating which URI query parameter caused the error.
example: revision
type: string
pointer:
description: JSON Pointer to the associated entity in the request document.
example: $.data
type: string
resource:
description: Resource causing the error.
properties:
id:
example: MyProjectId/id
type: string
type:
example: type
type: string
type: object
type: object
status:
description: HTTP status code applicable to this problem.
example: '400'
type: string
title:
description: Short, human-readable summary of the problem.
example: Bad Request
type: string
type: object
type: array
type: object
type: object
included:
description: Related entities might be returned, see REST API User Guide.
items:
type: object
type: array
links:
properties:
self:
example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition
type: string
type: object
type: object
PostImportActionRequestBody:
properties:
file:
description: excel file content
format: binary
type: string
resource:
$ref: '#/components/schemas/importTestResultsRequestBody'
required:
- file
title: PostImportActionRequestBody
type: object
testparameter_definitionsListPostResponse:
properties:
data:
items:
properties:
type:
enum:
- testparameter_definitions
type: string
id:
example: MyProjectId/MyTestParamDefinition
type: string
links:
properties:
self:
example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition
type: string
type: object
type: object
type: array
type: object
sparseFields:
properties:
categories:
description: Requested fields
example: '@all'
type: string
collections:
description: Requested fields
example: '@all'
type: string
customfields:
description: Requested fields
example: '@all'
type: string
document_attachments:
description: Requested fields
example: '@all'
type: string
document_comments:
description: Requested fields
example: '@all'
type: string
document_parts:
description: Requested fields
example: '@all'
type: string
documents:
description: Requested fields
example: '@all'
type: string
enumerations:
description: Requested fields
example: '@all'
type: string
externallylinkedworkitems:
description: Requested fields
example: '@all'
type: string
featureselections:
description: Requested fields
example: '@all'
type: string
globalroles:
description: Requested fields
example: '@all'
type: string
icons:
description: Requested fields
example: '@all'
type: string
jobs:
description: Requested fields
example: '@all'
type: string
license:
description: Requested fields
example: '@all'
type: string
license_assignments:
description: Requested fields
example: '@all'
type: string
license_slots:
description: Requested fields
example: '@all'
type: string
license_types:
description: Requested fields
example: '@all'
type: string
linkedoslcresources:
description: Requested fields
example: '@all'
type: string
linkedworkitems:
description: Requested fields
example: '@all'
type: string
metadata:
description: Requested fields
example: '@all'
type: string
page_attachments:
description: Requested fields
example: '@all'
type: string
page_comments:
description: Requested fields
example: '@all'
type: string
pages:
description: Requested fields
example: '@all'
type: string
plans:
description: Requested fields
example: '@all'
type: string
projectroles:
description: Requested fields
example: '@all'
type: string
projects:
description: Requested fields
example: '@all'
type: string
projecttemplates:
description: Requested fields
example: '@all'
type: string
revisions:
description: Requested fields
example: '@all'
type: string
testparameter_definitions:
description: Requested fields
example: '@all'
type: string
testparameters:
description: Requested fields
example: '@all'
type: string
testrecord_attachments:
description: Requested fields
example: '@all'
type: string
testrecords:
description: Requested fields
example: '@all'
type: string
testrun_attachments:
description: Requested fields
example: '@all'
type: string
testrun_comments:
description: Requested fields
example: '@all'
type: string
testruns:
description: Requested fields
example: '@all'
type: string
teststep_results:
description: Requested fields
example: '@all'
type: string
teststepresult_attachments:
description: Requested fields
example: '@all'
type: string
teststeps:
description: Requested fields
example: '@all'
type: string
usergroups:
description: Requested fields
example: '@all'
type: string
users:
description: Requested fields
example: '@all'
type: string
workitem_approvals:
description: Requested fields
example: '@all'
type: string
workitem_attachments:
description: Requested fields
example: '@all'
type: string
workitem_comments:
description: Requested fields
example: '@all'
type: string
workitems:
description: Requested fields
example: '@all'
type: string
workrecords:
description: Requested fields
example: '@all'
type: string
type: object
testparametersListPostResponse:
properties:
data:
items:
properties:
type:
enum:
- testparameters
type: string
id:
example: MyProjectId/MyTestRunId/MyTestParameter
type: string
links:
properties:
self:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter
type: string
type: object
type: object
type: array
type: object
testrunsListPostResponse:
properties:
data:
items:
properties:
type:
enum:
- testruns
type: string
id:
example: MyProjectId/MyTestRunId
type: string
links:
properties:
portal:
example: server-host-name/application-path/polarion/redirect/project/MyProjectId/testrun?id=MyTestRunId&revision=1234
type: string
self:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId?revision=1234
type: string
type: object
type: object
type: array
type: object
testparametersListPostRequest:
properties:
data:
items:
properties:
type:
enum:
- testparameters
type: string
attributes:
properties:
name:
example: Example Test Parameter value
type: string
value:
example: Example Test Parameter value
type: string
type: object
type: object
type: array
type: object
testrunsListGetResponse:
properties:
data:
items:
properties:
type:
enum:
- testruns
type: string
id:
example: MyProjectId/MyTestRunId
type: string
revision:
example: '1234'
type: string
attributes:
properties:
created:
example: '1970-01-01T00:00:00Z'
format: date-time
type: string
finishedOn:
example: '1970-01-01T00:00:00Z'
format: date-time
type: string
groupId:
example: Group ID
type: string
homePageContent:
properties:
type:
enum:
- text/html
- text/plain
type: string
value:
example: My text value
type: string
type: object
id:
example: ID
type: string
idPrefix:
example: MyTestRunIdPrefix
type: string
isTemplate:
type: boolean
keepInHistory:
type: boolean
query:
example: Query
type: string
selectTestCasesBy:
enum:
- manualSelection
- staticQueryResult
- dynamicQueryResult
- staticLiveDoc
- dynamicLiveDoc
- automatedProcess
example: manualSelection
type: string
status:
example: open
type: string
title:
example: Title
type: string
type:
example: manual
type: string
updated:
example: '1970-01-01T00:00:00Z'
format: date-time
type: string
useReportFromTemplate:
type: boolean
type: object
relationships:
properties:
author:
properties:
data:
properties:
id:
example: MyUserId
type: string
revision:
example: '1234'
type: string
type:
enum:
- users
type: string
type: object
type: object
document:
properties:
data:
properties:
id:
example: MyProjectId/MySpaceId/MyDocumentId
type: string
revision:
example: '1234'
type: string
type:
enum:
- documents
type: string
type: object
type: object
project:
properties:
data:
properties:
id:
example: MyProjectId
type: string
revision:
example: '1234'
type: string
type:
enum:
- projects
type: string
type: object
type: object
projectSpan:
properties:
data:
items:
properties:
id:
example: MyProjectId
type: string
revision:
example: '1234'
type: string
type:
enum:
- projects
type: string
type: object
type: array
meta:
properties:
totalCount:
format: int32
type: integer
type: object
type: object
summaryDefect:
properties:
data:
properties:
id:
example: MyProjectId/MyWorkItemId
type: string
revision:
example: '1234'
type: string
type:
enum:
- workitems
type: string
type: object
type: object
template:
properties:
data:
properties:
id:
example: MyProjectId/MyTestRunId
type: string
revision:
example: '1234'
type: string
type:
enum:
- testruns
type: string
type: object
type: object
type: object
links:
properties:
portal:
example: server-host-name/application-path/polarion/redirect/project/MyProjectId/testrun?id=MyTestRunId&revision=1234
type: string
self:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId?revision=1234
type: string
type: object
meta:
properties:
errors:
items:
properties:
detail:
description: Human-readable explanation specific to this occurrence of the problem.
example: 'Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)'
type: string
source:
properties:
parameter:
description: String indicating which URI query parameter caused the error.
example: revision
type: string
pointer:
description: JSON Pointer to the associated entity in the request document.
example: $.data
type: string
resource:
description: Resource causing the error.
properties:
id:
example: MyProjectId/id
type: string
type:
example: type
type: string
type: object
type: object
status:
description: HTTP status code applicable to this problem.
example: '400'
type: string
title:
description: Short, human-readable summary of the problem.
example: Bad Request
type: string
type: object
type: array
type: object
type: object
type: array
included:
description: Related entities might be returned, see REST API User Guide.
items:
type: object
type: array
links:
properties:
first:
example: server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=1
type: string
last:
example: server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=9
type: string
next:
example: server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=6
type: string
portal:
example: server-host-name/application-path/polarion/redirect/project/MyProjectId/testruns
type: string
prev:
example: server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=4
type: string
self:
example: server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=5
type: string
type: object
meta:
properties:
totalCount:
format: int32
type: integer
type: object
type: object
testrunsListPostRequest:
properties:
data:
items:
properties:
type:
enum:
- testruns
type: string
attributes:
properties:
finishedOn:
example: '1970-01-01T00:00:00Z'
format: date-time
type: string
groupId:
example: Group ID
type: string
homePageContent:
properties:
type:
enum:
- text/html
- text/plain
type: string
value:
example: My text value
type: string
type: object
id:
example: ID
type: string
idPrefix:
example: MyTestRunIdPrefix
type: string
isTemplate:
type: boolean
keepInHistory:
type: boolean
query:
example: Query
type: string
selectTestCasesBy:
enum:
- manualSelection
- staticQueryResult
- dynamicQueryResult
- staticLiveDoc
- dynamicLiveDoc
- automatedProcess
example: manualSelection
type: string
status:
example: open
type: string
title:
example: Title
type: string
type:
example: manual
type: string
useReportFromTemplate:
type: boolean
type: object
relationships:
properties:
document:
properties:
data:
properties:
id:
example: MyProjectId/MySpaceId/MyDocumentId
type: string
revision:
example: '1234'
type: string
type:
enum:
- documents
type: string
type: object
type: object
projectSpan:
properties:
data:
items:
properties:
id:
example: MyProjectId
type: string
type:
enum:
- projects
type: string
type: object
type: array
type: object
summaryDefect:
properties:
data:
properties:
id:
example: MyProjectId/MyWorkItemId
type: string
type:
enum:
- workitems
type: string
type: object
type: object
template:
properties:
data:
properties:
id:
example: MyProjectId/MyTestRunId
type: string
type:
enum:
- testruns
type: string
type: object
type: object
type: object
type: object
type: array
type: object
testrunsListDeleteRequest:
properties:
data:
items:
properties:
type:
enum:
- testruns
type: string
id:
example: MyProjectId/MyTestRunId
type: string
type: object
type: array
type: object
importTestResultsRequestBody:
properties:
defectTemplateId:
example: MyProjectId/MyDefectId
type: string
retest:
example: false
type: boolean
type: object
errors:
properties:
errors:
items:
properties:
status:
description: HTTP status code applicable to this problem.
example: '400'
type: string
title:
description: Short, human-readable summary of the problem.
example: Bad Request
type: string
detail:
description: Human-readable explanation specific to this occurrence of the problem.
example: 'Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)'
type: string
source:
properties:
parameter:
description: String indicating which URI query parameter caused the error.
example: revision
type: string
pointer:
description: JSON Pointer to the associated entity in the request document.
example: $.data
type: string
resource:
description: Resource causing the error.
properties:
id:
example: MyProjectId/id
type: string
type:
example: type
type: string
type: object
type: object
type: object
type: array
type: object
testparameter_definitionsListGetResponse:
properties:
data:
items:
properties:
type:
enum:
- testparameter_definitions
type: string
id:
example: MyProjectId/MyTestParamDefinition
type: string
revision:
example: '1234'
type: string
attributes:
properties:
name:
example: Test Parameter Definition example
type: string
type: object
links:
properties:
self:
example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition
type: string
type: object
meta:
properties:
errors:
items:
properties:
detail:
description: Human-readable explanation specific to this occurrence of the problem.
example: 'Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)'
type: string
source:
properties:
parameter:
description: String indicating which URI query parameter caused the error.
example: revision
type: string
pointer:
description: JSON Pointer to the associated entity in the request document.
example: $.data
type: string
resource:
description: Resource causing the error.
properties:
id:
example: MyProjectId/id
type: string
type:
example: type
type: string
type: object
type: object
status:
description: HTTP status code applicable to this problem.
example: '400'
type: string
title:
description: Short, human-readable summary of the problem.
example: Bad Request
type: string
type: object
type: array
type: object
type: object
type: array
included:
description: Related entities might be returned, see REST API User Guide.
items:
type: object
type: array
links:
properties:
first:
example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=1
type: string
last:
example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=9
type: string
next:
example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=6
type: string
prev:
example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=4
type: string
self:
example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=5
type: string
type: object
meta:
properties:
totalCount:
format: int32
type: integer
type: object
type: object
testrunsSinglePatchRequest:
properties:
data:
properties:
type:
enum:
- testruns
type: string
id:
example: MyProjectId/MyTestRunId
type: string
attributes:
properties:
finishedOn:
example: '1970-01-01T00:00:00Z'
format: date-time
type: string
groupId:
example: Group ID
type: string
homePageContent:
properties:
type:
enum:
- text/html
- text/plain
type: string
value:
example: My text value
type: string
type: object
idPrefix:
example: MyTestRunIdPrefix
type: string
keepInHistory:
type: boolean
query:
example: Query
type: string
selectTestCasesBy:
enum:
- manualSelection
- staticQueryResult
- dynamicQueryResult
- staticLiveDoc
- dynamicLiveDoc
- automatedProcess
example: manualSelection
type: string
status:
example: open
type: string
title:
example: Title
type: string
type:
example: manual
type: string
useReportFromTemplate:
type: boolean
type: object
relationships:
properties:
document:
properties:
data:
properties:
id:
example: MyProjectId/MySpaceId/MyDocumentId
type: string
revision:
example: '1234'
type: string
type:
enum:
- documents
type: string
type: object
type: object
projectSpan:
properties:
data:
items:
properties:
id:
example: MyProjectId
type: string
type:
enum:
- projects
type: string
type: object
type: array
type: object
summaryDefect:
properties:
data:
properties:
id:
example: MyProjectId/MyWorkItemId
type: string
type:
enum:
- workitems
type: string
type: object
type: object
type: object
type: object
type: object
jobsSinglePostResponse:
properties:
data:
properties:
type:
enum:
- jobs
type: string
id:
example: MyJobId
type: string
attributes:
properties:
jobId:
example: example
type: string
name:
example: example
type: string
state:
example: example
type: string
status:
properties:
message:
example: message
type: string
type:
enum:
- OK
- CANCELLED
- FAILED
- UNKNOWN
type: string
type: object
type: object
relationships:
properties:
document:
properties:
data:
properties:
id:
example: MyProjectId/MySpaceId/MyDocumentId
type: string
type:
enum:
- documents
type: string
type: object
type: object
documents:
properties:
data:
items:
properties:
id:
example: MyProjectId/MySpaceId/MyDocumentId
type: string
type:
enum:
- documents
type: string
type: object
type: array
type: object
project:
properties:
data:
properties:
id:
example: MyProjectId
type: string
type:
enum:
- projects
type: string
type: object
type: object
type: object
links:
properties:
downloads:
example:
- https://example.com/polarion/download/filename1
- https://example.com/polarion/download/filename2
type: array
log:
example: server-host-name/application-path/polarion/job-report?jobId=MyJobId
type: string
self:
example: server-host-name/application-path/jobs/MyJobId
type: string
type: object
type: object
type: object
testrunsListPatchRequest:
properties:
data:
items:
properties:
type:
enum:
- testruns
type: string
id:
example: MyProjectId/MyTestRunId
type: string
attributes:
properties:
finishedOn:
example: '1970-01-01T00:00:00Z'
format: date-time
type: string
groupId:
example: Group ID
type: string
homePageContent:
properties:
type:
enum:
- text/html
- text/plain
type: string
value:
example: My text value
type: string
type: object
idPrefix:
example: MyTestRunIdPrefix
type: string
keepInHistory:
type: boolean
query:
example: Query
type: string
selectTestCasesBy:
enum:
- manualSelection
- staticQueryResult
- dynamicQueryResult
- staticLiveDoc
- dynamicLiveDoc
- automatedProcess
example: manualSelection
type: string
status:
example: open
type: string
title:
example: Title
type: string
type:
example: manual
type: string
useReportFromTemplate:
type: boolean
type: object
relationships:
properties:
document:
properties:
data:
properties:
id:
example: MyProjectId/MySpaceId/MyDocumentId
type: string
revision:
example: '1234'
type: string
type:
enum:
- documents
type: string
type: object
type: object
projectSpan:
properties:
data:
items:
properties:
id:
example: MyProjectId
type: string
type:
enum:
- projects
type: string
type: object
type: array
type: object
summaryDefect:
properties:
data:
properties:
id:
example: MyProjectId/MyWorkItemId
type: string
type:
enum:
- workitems
type: string
type: object
type: object
type: object
type: object
type: array
type: object
testrunsSingleGetResponse:
properties:
data:
properties:
type:
enum:
- testruns
type: string
id:
example: MyProjectId/MyTestRunId
type: string
revision:
example: '1234'
type: string
attributes:
properties:
created:
example: '1970-01-01T00:00:00Z'
format: date-time
type: string
finishedOn:
example: '1970-01-01T00:00:00Z'
format: date-time
type: string
groupId:
example: Group ID
type: string
homePageContent:
properties:
type:
enum:
- text/html
- text/plain
type: string
value:
example: My text value
type: string
type: object
id:
example: ID
type: string
idPrefix:
example: MyTestRunIdPrefix
type: string
isTemplate:
type: boolean
keepInHistory:
type: boolean
query:
example: Query
type: string
selectTestCasesBy:
enum:
- manualSelection
- staticQueryResult
- dynamicQueryResult
- staticLiveDoc
- dynamicLiveDoc
- automatedProcess
example: manualSelection
type: string
status:
example: open
type: string
title:
example: Title
type: string
type:
example: manual
type: string
updated:
example: '1970-01-01T00:00:00Z'
format: date-time
type: string
useReportFromTemplate:
type: boolean
type: object
relationships:
properties:
author:
properties:
data:
properties:
id:
example: MyUserId
type: string
revision:
example: '1234'
type: string
type:
enum:
- users
type: string
type: object
type: object
document:
properties:
data:
properties:
id:
example: MyProjectId/MySpaceId/MyDocumentId
type: string
revision:
example: '1234'
type: string
type:
enum:
- documents
type: string
type: object
type: object
project:
properties:
data:
properties:
id:
example: MyProjectId
type: string
revision:
example: '1234'
type: string
type:
enum:
- projects
type: string
type: object
type: object
projectSpan:
properties:
data:
items:
properties:
id:
example: MyProjectId
type: string
revision:
example: '1234'
type: string
type:
enum:
- projects
type: string
type: object
type: array
meta:
properties:
totalCount:
format: int32
type: integer
type: object
type: object
summaryDefect:
properties:
data:
properties:
id:
example: MyProjectId/MyWorkItemId
type: string
revision:
example: '1234'
type: string
type:
enum:
- workitems
type: string
type: object
type: object
template:
properties:
data:
properties:
id:
example: MyProjectId/MyTestRunId
type: string
revision:
example: '1234'
type: string
type:
enum:
- testruns
type: string
type: object
type: object
type: object
links:
properties:
portal:
example: server-host-name/application-path/polarion/redirect/project/MyProjectId/testrun?id=MyTestRunId&revision=1234
type: string
self:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId?revision=1234
type: string
type: object
meta:
properties:
errors:
items:
properties:
detail:
description: Human-readable explanation specific to this occurrence of the problem.
example: 'Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)'
type: string
source:
properties:
parameter:
description: String indicating which URI query parameter caused the error.
example: revision
type: string
pointer:
description: JSON Pointer to the associated entity in the request document.
example: $.data
type: string
resource:
description: Resource causing the error.
properties:
id:
example: MyProjectId/id
type: string
type:
example: type
type: string
type: object
type: object
status:
description: HTTP status code applicable to this problem.
example: '400'
type: string
title:
description: Short, human-readable summary of the problem.
example: Bad Request
type: string
type: object
type: array
type: object
type: object
included:
description: Related entities might be returned, see REST API User Guide.
items:
type: object
type: array
links:
properties:
self:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId?revision=1234
type: string
type: object
type: object
workflowActionsActionResponseBody:
properties:
data:
items:
properties:
id:
example: '0'
type: string
available:
type: boolean
clearedFields:
items:
type: string
type: array
isAddingSignature:
type: boolean
isSignatureRequired:
type: boolean
name:
example: actionName
type: string
nativeActionId:
example: nativeActionId
type: string
requiredFields:
items:
type: string
type: array
requiredRoles:
items:
type: string
type: array
targetStatus:
example: done
type: string
unavailableReason:
type: string
type: object
type: array
links:
properties:
first:
example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=1
type: string
last:
example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=9
type: string
next:
example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=6
type: string
prev:
example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=4
type: string
self:
example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bsize%5D=10&page%5Bnumber%5D=5
type: string
type: object
meta:
properties:
totalCount:
format: int32
type: integer
type: object
type: object
testparametersListDeleteRequest:
properties:
data:
items:
properties:
type:
enum:
- testparameters
type: string
id:
example: MyProjectId/MyTestRunId/MyTestParameter
type: string
type: object
type: array
type: object
testparametersSingleGetResponse:
properties:
data:
properties:
type:
enum:
- testparameters
type: string
id:
example: MyProjectId/MyTestRunId/MyTestParameter
type: string
revision:
example: '1234'
type: string
attributes:
properties:
name:
example: Example Test Parameter value
type: string
value:
example: Example Test Parameter value
type: string
type: object
relationships:
properties:
definition:
properties:
data:
properties:
id:
example: MyProjectId/MyTestParamDefinition
type: string
revision:
example: '1234'
type: string
type:
enum:
- testparameter_definitions
type: string
type: object
type: object
type: object
links:
properties:
self:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter
type: string
type: object
meta:
properties:
errors:
items:
properties:
detail:
description: Human-readable explanation specific to this occurrence of the problem.
example: 'Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)'
type: string
source:
properties:
parameter:
description: String indicating which URI query parameter caused the error.
example: revision
type: string
pointer:
description: JSON Pointer to the associated entity in the request document.
example: $.data
type: string
resource:
description: Resource causing the error.
properties:
id:
example: MyProjectId/id
type: string
type:
example: type
type: string
type: object
type: object
status:
description: HTTP status code applicable to this problem.
example: '400'
type: string
title:
description: Short, human-readable summary of the problem.
example: Bad Request
type: string
type: object
type: array
type: object
type: object
included:
description: Related entities might be returned, see REST API User Guide.
items:
type: object
type: array
links:
properties:
self:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter
type: string
type: object
type: object
securitySchemes:
bearerAuth:
bearerFormat: JWT
scheme: bearer
type: http