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 Step Result Attachments API
version: v1
servers:
- url: https://example.com/polarion/rest/v1
security:
- bearerAuth: []
tags:
- name: Test Step Result Attachments
paths:
? /projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments
: delete:
operationId: deleteTestStepResultAttachments
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: testCaseProjectId
in: path
description: The Testcase Project ID.
required: true
schema:
type: string
- name: testCaseId
in: path
description: The Testcase ID.
required: true
schema:
type: string
- name: iteration
in: path
description: The Iteration Number.
required: true
schema:
type: string
- name: testStepIndex
in: path
description: The Test Step index.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/teststepresult_attachmentsListDeleteRequest'
description: The Test Step Result Attachment(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 Step Result Attachments.
tags:
- Test Step Result Attachments
get:
operationId: getTestStepResultAttachments
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: testCaseProjectId
in: path
description: The Testcase Project ID.
required: true
schema:
type: string
- name: testCaseId
in: path
description: The Testcase ID.
required: true
schema:
type: string
- name: iteration
in: path
description: The Iteration Number.
required: true
schema:
type: string
- name: testStepIndex
in: path
description: The Test Step index.
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/teststepresult_attachmentsListGetResponse'
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 Attachments for the specified Test Step Result.
tags:
- Test Step Result Attachments
post:
description: Files are identified by order or optionally by the 'lid' attribute. See more in the REST API User Guide.
operationId: postTestStepResultAttachments
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: testCaseProjectId
in: path
description: The Testcase Project ID.
required: true
schema:
type: string
- name: testCaseId
in: path
description: The Testcase ID.
required: true
schema:
type: string
- name: iteration
in: path
description: The Iteration Number.
required: true
schema:
type: string
- name: testStepIndex
in: path
description: The Test Step index.
required: true
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/PostTestStepResultAttachmentsRequestBody'
description: Attachment metadata and file data.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/teststepresult_attachmentsListPostResponse'
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 Step Result Attachments.
tags:
- Test Step Result Attachments
? /projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments/{attachmentId}
: delete:
operationId: deleteTestStepResultAttachment
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: testCaseProjectId
in: path
description: The Testcase Project ID.
required: true
schema:
type: string
- name: testCaseId
in: path
description: The Testcase ID.
required: true
schema:
type: string
- name: iteration
in: path
description: The Iteration Number.
required: true
schema:
type: string
- name: testStepIndex
in: path
description: The Test Step index.
required: true
schema:
type: string
- name: attachmentId
in: path
description: The Attachment 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 Step Result Attachment.
tags:
- Test Step Result Attachments
get:
operationId: getTestStepResultAttachment
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: testCaseProjectId
in: path
description: The Testcase Project ID.
required: true
schema:
type: string
- name: testCaseId
in: path
description: The Testcase ID.
required: true
schema:
type: string
- name: iteration
in: path
description: The Iteration Number.
required: true
schema:
type: string
- name: testStepIndex
in: path
description: The Test Step index.
required: true
schema:
type: string
- name: attachmentId
in: path
description: The Attachment 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/teststepresult_attachmentsSingleGetResponse'
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 Step Result Attachment for the specified Test Record.
tags:
- Test Step Result Attachments
patch:
description: See more in the REST API User Guide.
operationId: patchTestStepResultAttachment
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: testCaseProjectId
in: path
description: The Testcase Project ID.
required: true
schema:
type: string
- name: testCaseId
in: path
description: The Testcase ID.
required: true
schema:
type: string
- name: iteration
in: path
description: The Iteration Number.
required: true
schema:
type: string
- name: testStepIndex
in: path
description: The Test Step index.
required: true
schema:
type: string
- name: attachmentId
in: path
description: The Attachment ID.
required: true
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchTestStepResultAttachmentsRequestBody'
description: Attachment metadata and file data.
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 Step Result Attachment.
tags:
- Test Step Result Attachments
? /projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments/{attachmentId}/content
: get:
operationId: getTestStepResultAttachmentContent
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: testCaseProjectId
in: path
description: The Testcase Project ID.
required: true
schema:
type: string
- name: testCaseId
in: path
description: The Testcase ID.
required: true
schema:
type: string
- name: iteration
in: path
description: The Iteration Number.
required: true
schema:
type: string
- name: testStepIndex
in: path
description: The Test Step index.
required: true
schema:
type: string
- name: attachmentId
in: path
description: The Attachment ID.
required: true
schema:
type: string
- name: revision
in: query
description: The revision ID.
schema:
type: string
responses:
'200':
content:
application/octet-stream: {}
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: Downloads the file content for a specified Test Step Result Attachment for the specified Test Record.
tags:
- Test Step Result Attachments
components:
schemas:
teststepresult_attachmentsListPostResponse:
properties:
data:
items:
properties:
type:
enum:
- teststepresult_attachments
type: string
id:
example: MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId
type: string
links:
properties:
content:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId/content
type: string
self:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId
type: string
type: object
type: object
type: array
type: object
teststepresult_attachmentsListDeleteRequest:
properties:
data:
items:
properties:
type:
enum:
- teststepresult_attachments
type: string
id:
example: MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId
type: string
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
teststepresult_attachmentsListGetResponse:
properties:
data:
items:
properties:
type:
enum:
- teststepresult_attachments
type: string
id:
example: MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId
type: string
revision:
example: '1234'
type: string
attributes:
properties:
fileName:
example: File Name
type: string
id:
example: MyAttachmentId
type: string
length:
format: int32
type: integer
title:
example: Title
type: string
updated:
example: '1970-01-01T00:00:00Z'
format: date-time
type: string
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
project:
properties:
data:
properties:
id:
example: MyProjectId
type: string
revision:
example: '1234'
type: string
type:
enum:
- projects
type: string
type: object
type: object
type: object
links:
properties:
content:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId/content
type: string
self:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId
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/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=1
type: string
last:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=9
type: string
next:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=6
type: string
prev:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=4
type: string
self:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=5
type: string
type: object
meta:
properties:
totalCount:
format: int32
type: integer
type: object
type: object
PostTestStepResultAttachmentsRequestBody:
properties:
files:
items:
description: attachments content
format: binary
type: string
type: array
resource:
$ref: '#/components/schemas/teststepresult_attachmentsListPostRequest'
title: PostTestStepResultAttachmentsRequestBody
type: object
teststepresult_attachmentsSingleGetResponse:
properties:
data:
properties:
type:
enum:
- teststepresult_attachments
type: string
id:
example: MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId
type: string
revision:
example: '1234'
type: string
attributes:
properties:
fileName:
example: File Name
type: string
id:
example: MyAttachmentId
type: string
length:
format: int32
type: integer
title:
example: Title
type: string
updated:
example: '1970-01-01T00:00:00Z'
format: date-time
type: string
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
project:
properties:
data:
properties:
id:
example: MyProjectId
type: string
revision:
example: '1234'
type: string
type:
enum:
- projects
type: string
type: object
type: object
type: object
links:
properties:
content:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId/content
type: string
self:
example: server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId
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/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId
type: string
type: object
type: object
teststepresult_attachmentsSinglePatchRequest:
properties:
data:
properties:
type:
enum:
- teststepresult_attachments
type: string
id:
example: MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId
type: string
attributes:
properties:
title:
example: Title
type: string
type: object
type: object
type: object
teststepresult_attachmentsListPostRequest:
properties:
data:
items:
properties:
type:
enum:
- teststepresult_attachments
type: string
attributes:
properties:
fileName:
example: File Name
type: string
title:
example: Title
type: string
type: object
lid:
type: string
type: object
type: array
type: object
PatchTestStepResultAttachmentsRequestBody:
properties:
content:
description: attachments content
format: binary
type: string
resource:
$ref: '#/components/schemas/teststepresult_attachmentsSinglePatchRequest'
required:
- resource
title: PatchTestStepResultAttachmentsRequestBody
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
securitySchemes:
bearerAuth:
bearerFormat: JWT
scheme: bearer
type: http