Polarion REST API

DocumentAttachments

getDocumentAttachment

Returns the specified Document Attachment.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
attachmentId*
String
The Attachment ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getDocumentAttachmentContent

Downloads the file content for a specified Document Attachment.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}/content

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}/content?revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/octet-stream, application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}/content?revision={revision}"))
                .header("Accept", "application/octet-stream, application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/octet-stream, application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}/content?revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}/content?revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/octet-stream, application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
attachmentId*
String
The Attachment ID.
Required
Query parameters
Name Description
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getDocumentAttachments

Returns a list of Document Attachments.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchDocumentAttachment

Updates the specified Document Attachment.

See more in the Rest API User Guide.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: multipart/form-data"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}"))
                .header("Content-Type", "multipart/form-data")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'multipart/form-data',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
attachmentId*
String
The Attachment ID.
Required
Form parameters
Name Description
content
byte[] (binary)
resource
document_attachmentsSinglePatchRequest

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postDocumentItemAttachments

Creates a list of Document Attachments.

Files are identified by order or optionally by the 'lid' attribute. See more in the Rest API User Guide.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: multipart/form-data"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments"))
                .header("Content-Type", "multipart/form-data")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'multipart/form-data',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
Form parameters
Name Description
files *
array[byte[]] (binary)
Required
resource *
document_attachmentsListPostRequest
Required

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


DocumentComments

getDocumentComment

Returns the specified Document Comment.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments/{commentId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments/{commentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentCommentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments/{commentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments/{commentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments/{commentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
commentId*
String
The Comment ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getDocumentComments

Returns a list of Document Comments.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentCommentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchDocumentComment

Updates the specified Document Comment.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments/{commentId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments/{commentId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentCommentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments/{commentId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments/{commentId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments/{commentId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
commentId*
String
The Comment ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postDocumentComments

Creates a list of Document Comments.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentCommentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


DocumentParts

getDocumentPart

Returns the specified Document Part.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts/{partId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts/{partId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentPartsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts/{partId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts/{partId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts/{partId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
partId*
String
The Document Part ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getDocumentParts

Returns a list of Document Parts.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentPartsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postDocumentParts

Creates a list of Document Parts.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentPartsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


Documents

branchDocument

Creates a Branch of the Document.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/branch

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/branch?revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/branch?revision={revision}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/branch?revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/branch?revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
Body parameters
Name Description
body *
Query parameters
Name Description
revision
String
The revision ID.

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


branchDocuments

Creates Branches of Documents.

/all/documents/actions/branch

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/all/documents/actions/branch" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/all/documents/actions/branch"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/all/documents/actions/branch', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/all/documents/actions/branch");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Body parameters
Name Description
body *

Responses

Status: 202 - Accepted

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


copyDocument

Creates a copy of the Document.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/copy

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/copy?revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/copy?revision={revision}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/copy?revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/copy?revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
Body parameters
Name Description
body *
Query parameters
Name Description
revision
String
The revision ID.

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getAvailableEnumOptionsForDocument

Returns a list of available options for the requested field in the specified Document.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getAvailableOptions

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
fieldId*
String
The Field ID.
Required
Query parameters
Name Description
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getAvailableEnumOptionsForDocumentType

Returns a list of available options for the requested field for the specified Document type.

/projects/{projectId}/documents/fields/{fieldId}/actions/getAvailableOptions

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/documents/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}&type={type}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/documents/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}&type={type}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/documents/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}&type={type}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/documents/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}&type={type}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
fieldId*
String
The Field ID.
Required
Query parameters
Name Description
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
type
String
The Type of the object.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getCurrentEnumerationOptionsForDocument

Returns a list of selected options for the requested field in the specified Document.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getCurrentOptions

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getCurrentOptions?page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getCurrentOptions?page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getCurrentOptions?page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getCurrentOptions?page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
fieldId*
String
The Field ID.
Required
Query parameters
Name Description
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getDocument

Returns the specified Document.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchDocument

Updates the specified Document.

/projects/{projectId}/spaces/{spaceId}/documents/{documentName}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}?workflowAction={workflowAction}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}?workflowAction={workflowAction}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}?workflowAction={workflowAction}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}?workflowAction={workflowAction}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
documentName*
String
The Document name.
Required
Body parameters
Name Description
body *
Query parameters
Name Description
workflowAction
String
The Workflow Action.

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postDocuments

Creates a list of Documents.

/projects/{projectId}/spaces/{spaceId}/documents

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class DocumentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


Enumerations

deleteGlobalEnumeration

Deletes the specified Enumeration from the Global context.

/enumerations/{enumContext}/{enumName}/{targetType}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/enumerations/{enumContext}/{enumName}/{targetType}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class EnumerationsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/enumerations/{enumContext}/{enumName}/{targetType}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/enumerations/{enumContext}/{enumName}/{targetType}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/enumerations/{enumContext}/{enumName}/{targetType}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
enumContext*
String
The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)
Required
enumName*
String
The Enumeration Name.
Required
targetType*
String
The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


deleteProjectEnumeration

Deletes the specified Enumeration from the Project context.

/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class EnumerationsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
enumContext*
String
The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)
Required
enumName*
String
The Enumeration Name.
Required
targetType*
String
The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getGlobalEnumeration

Returns the specified Enumeration from the Global context.

/enumerations/{enumContext}/{enumName}/{targetType}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/enumerations/{enumContext}/{enumName}/{targetType}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class EnumerationsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/enumerations/{enumContext}/{enumName}/{targetType}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/enumerations/{enumContext}/{enumName}/{targetType}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/enumerations/{enumContext}/{enumName}/{targetType}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
enumContext*
String
The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)
Required
enumName*
String
The Enumeration Name.
Required
targetType*
String
The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getProjectEnumeration

Returns the specified Enumeration from the Project context.

/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class EnumerationsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
enumContext*
String
The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)
Required
enumName*
String
The Enumeration Name.
Required
targetType*
String
The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchGlobalEnumeration

Updates the specified Enumeration in the Global context.

/enumerations/{enumContext}/{enumName}/{targetType}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/enumerations/{enumContext}/{enumName}/{targetType}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class EnumerationsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/enumerations/{enumContext}/{enumName}/{targetType}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/enumerations/{enumContext}/{enumName}/{targetType}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/enumerations/{enumContext}/{enumName}/{targetType}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
enumContext*
String
The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)
Required
enumName*
String
The Enumeration Name.
Required
targetType*
String
The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchProjectEnumeration

Updates the specified Enumeration in the Project context.

/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class EnumerationsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
enumContext*
String
The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)
Required
enumName*
String
The Enumeration Name.
Required
targetType*
String
The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postGlobalEnumeration

Creates a list of Enumerations in the Global context.

/enumerations

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/enumerations" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class EnumerationsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/enumerations"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/enumerations', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/enumerations");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postProjectEnumeration

Creates a list of Enumerations in the Project context.

/projects/{projectId}/enumerations

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/enumerations" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class EnumerationsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/enumerations"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/enumerations', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/enumerations");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


ExternallyLinkedWorkItems

deleteExternallyLinkedWorkItem

Deletes the specified Externally Linked Work Item.

/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems/{roleId}/{hostname}/{targetProjectId}/{linkedWorkItemId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems/{roleId}/{hostname}/{targetProjectId}/{linkedWorkItemId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ExternallyLinkedWorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems/{roleId}/{hostname}/{targetProjectId}/{linkedWorkItemId}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems/{roleId}/{hostname}/{targetProjectId}/{linkedWorkItemId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems/{roleId}/{hostname}/{targetProjectId}/{linkedWorkItemId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
roleId*
String
The Role ID.
Required
hostname*
String
The Target Hostname.
Required
targetProjectId*
String
The Target Project ID.
Required
linkedWorkItemId*
String
The Linked Work Item ID.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


deleteExternallyLinkedWorkItems

Deletes a list of Externally Linked Work Items.

/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ExternallyLinkedWorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getExternallyLinkedWorkItem

Returns the specified Externally Linked Work Item.

Returns the external links to other Work Items. (The same as the corresponding Java API method.)

/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems/{roleId}/{hostname}/{targetProjectId}/{linkedWorkItemId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems/{roleId}/{hostname}/{targetProjectId}/{linkedWorkItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ExternallyLinkedWorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems/{roleId}/{hostname}/{targetProjectId}/{linkedWorkItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems/{roleId}/{hostname}/{targetProjectId}/{linkedWorkItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems/{roleId}/{hostname}/{targetProjectId}/{linkedWorkItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
roleId*
String
The Role ID.
Required
hostname*
String
The Target Hostname.
Required
targetProjectId*
String
The Target Project ID.
Required
linkedWorkItemId*
String
The Linked Work Item ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getExternallyLinkedWorkItems

Returns a list of Externally Linked Work Items.

Returns the external links to other Work Items. (The same as the corresponding Java API method.)

/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ExternallyLinkedWorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postExternallyLinkedWorkItems

Creates a list of Externally Linked Work Items.

/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ExternallyLinkedWorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


FeatureSelections

getFeatureSelection

Returns the specified Feature Selection.

/projects/{projectId}/workitems/{workItemId}/featureselections/{selectionTypeId}/{targetProjectId}/{targetWorkItemId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/featureselections/{selectionTypeId}/{targetProjectId}/{targetWorkItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class FeatureSelectionsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/featureselections/{selectionTypeId}/{targetProjectId}/{targetWorkItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/featureselections/{selectionTypeId}/{targetProjectId}/{targetWorkItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/featureselections/{selectionTypeId}/{targetProjectId}/{targetWorkItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
selectionTypeId*
String
The Selection Type ID.
Required
targetProjectId*
String
The Target Project ID.
Required
targetWorkItemId*
String
The Target Work Item ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getFeatureSelections

Returns a list of Feature Selections.

/projects/{projectId}/workitems/{workItemId}/featureselections

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/featureselections?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class FeatureSelectionsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/featureselections?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/featureselections?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/featureselections?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


Icons

getDefaultIcon

Returns the specified Icon from the default context.

/enumerations/defaulticons/{iconId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/enumerations/defaulticons/{iconId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class IconsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/enumerations/defaulticons/{iconId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/enumerations/defaulticons/{iconId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/enumerations/defaulticons/{iconId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
iconId*
String
The Icon ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getDefaultIcons

Returns a list of Icons from the default context.

/enumerations/defaulticons

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/enumerations/defaulticons?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&page[size]={page[size]}&page[number]={page[number]}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class IconsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/enumerations/defaulticons?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&page[size]={page[size]}&page[number]={page[number]}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/enumerations/defaulticons?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&page[size]={page[size]}&page[number]={page[number]}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/enumerations/defaulticons?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&page[size]={page[size]}&page[number]={page[number]}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getGlobalIcon

Returns the specified Icon from the Global context.

/enumerations/icons/{iconId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/enumerations/icons/{iconId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class IconsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/enumerations/icons/{iconId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/enumerations/icons/{iconId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/enumerations/icons/{iconId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
iconId*
String
The Icon ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getGlobalIcons

Returns a list of Icons from the Global context.

/enumerations/icons

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/enumerations/icons?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&page[size]={page[size]}&page[number]={page[number]}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class IconsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/enumerations/icons?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&page[size]={page[size]}&page[number]={page[number]}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/enumerations/icons?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&page[size]={page[size]}&page[number]={page[number]}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/enumerations/icons?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&page[size]={page[size]}&page[number]={page[number]}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getProjectIcon

Returns the specified Icon from the Project context.

/projects/{projectId}/enumerations/icons/{iconId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/icons/{iconId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class IconsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/icons/{iconId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/icons/{iconId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/icons/{iconId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
iconId*
String
The Icon ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getProjectIcons

Returns a list of Icons from the Project context.

/projects/{projectId}/enumerations/icons

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/icons?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&page[size]={page[size]}&page[number]={page[number]}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class IconsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/icons?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&page[size]={page[size]}&page[number]={page[number]}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/icons?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&page[size]={page[size]}&page[number]={page[number]}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/icons?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&page[size]={page[size]}&page[number]={page[number]}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postGlobalIcons

Creates a list of Icons in the Global context.

Icons are identified by order

/enumerations/icons

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/enumerations/icons" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: multipart/form-data"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class IconsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/enumerations/icons"))
                .header("Content-Type", "multipart/form-data")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'multipart/form-data',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/enumerations/icons', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/enumerations/icons");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Form parameters
Name Description
files *
array[byte[]] (binary)
Required
resource *
iconsListPostRequest
Required

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postProjectIcons

Creates a list of Icons in the Project context.

Icons are identified by order

/projects/{projectId}/enumerations/icons

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/icons" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: multipart/form-data"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class IconsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/icons"))
                .header("Content-Type", "multipart/form-data")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'multipart/form-data',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/icons', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/enumerations/icons");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
Required
Form parameters
Name Description
files *
array[byte[]] (binary)
Required
resource *
iconsListPostRequest
Required

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


Jobs

getJob

Returns the specified Job.

/jobs/{jobId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/jobs/{jobId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class JobsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/jobs/{jobId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/jobs/{jobId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/jobs/{jobId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
jobId*
String
The Job ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getJobResultFileContent

Downloads the file content for a specified job.

/jobs/{jobId}/actions/download/{filename}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/jobs/{jobId}/actions/download/{filename}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class JobsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/jobs/{jobId}/actions/download/{filename}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/jobs/{jobId}/actions/download/{filename}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/jobs/{jobId}/actions/download/{filename}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
jobId*
String
The Job ID.
Required
filename*
String
The Download File Name.
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


LinkedOslcResources

deleteOslcResources

Deletes a list of instances.

/projects/{projectId}/workitems/{workItemId}/linkedoslcresources

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedoslcresources" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class LinkedOslcResourcesApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedoslcresources"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedoslcresources', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedoslcresources");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getOslcResources

Returns a list of instances.

/projects/{projectId}/workitems/{workItemId}/linkedoslcresources

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedoslcresources?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class LinkedOslcResourcesApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedoslcresources?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedoslcresources?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedoslcresources?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
query
String
The query string.
sort
String
The sort string.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postOslcResources

Creates a list of instances.

/projects/{projectId}/workitems/{workItemId}/linkedoslcresources

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedoslcresources" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class LinkedOslcResourcesApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedoslcresources"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedoslcresources', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedoslcresources");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


LinkedWorkItems

deleteLinkedWorkItem

Deletes the specified Linked Work Item.

Deletes the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks.

/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class LinkedWorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
roleId*
String
The Role ID.
Required
targetProjectId*
String
The Target Project ID.
Required
linkedWorkItemId*
String
The Linked Work Item ID.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 413 - Request Entity Too Large

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


deleteLinkedWorkItems

Deletes a list of Linked Work Items.

Deletes the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks.

/projects/{projectId}/workitems/{workItemId}/linkedworkitems

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class LinkedWorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getLinkedWorkItem

Returns the specified Linked Work Item.

Returns the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks.

/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class LinkedWorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
roleId*
String
The Role ID.
Required
targetProjectId*
String
The Target Project ID.
Required
linkedWorkItemId*
String
The Linked Work Item ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getLinkedWorkItems

Returns a list of Linked Work Items.

Returns the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks.

/projects/{projectId}/workitems/{workItemId}/linkedworkitems

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class LinkedWorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchLinkedWorkItem

Updates the specified Linked Work Item.

Updates the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks.

/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class LinkedWorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
roleId*
String
The Role ID.
Required
targetProjectId*
String
The Target Project ID.
Required
linkedWorkItemId*
String
The Linked Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postLinkedWorkItems

Creates a list of Linked Work Items.

Creates the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks.

/projects/{projectId}/workitems/{workItemId}/linkedworkitems

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class LinkedWorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/linkedworkitems");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


PageAttachments

getPageAttachment

Returns the specified Page Attachment.

/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments/{attachmentId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PageAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
pageName*
String
The Page name.
Required
attachmentId*
String
The Attachment ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getPageAttachmentContent

Downloads the file content for a specified Page Attachment.

/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments/{attachmentId}/content

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments/{attachmentId}/content?revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/octet-stream, application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PageAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments/{attachmentId}/content?revision={revision}"))
                .header("Accept", "application/octet-stream, application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/octet-stream, application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments/{attachmentId}/content?revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments/{attachmentId}/content?revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/octet-stream, application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
pageName*
String
The Page name.
Required
attachmentId*
String
The Attachment ID.
Required
Query parameters
Name Description
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postPageAttachments

Creates a list of Page Attachments.

Files are identified by order or optionally by the 'lid' attribute. See more in the Rest API User Guide.

/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: multipart/form-data"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PageAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments"))
                .header("Content-Type", "multipart/form-data")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'multipart/form-data',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
Required
spaceId*
String
Required
pageName*
String
Required
Form parameters
Name Description
files *
array[byte[]] (binary)
Required
resource *
page_attachmentsListPostRequest
Required

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


Pages

getPage

Returns the specified Page.

/projects/{projectId}/spaces/{spaceId}/pages/{pageName}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PagesApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
pageName*
String
The Page name.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchRichPage

Updates the specified Page.

/projects/{projectId}/spaces/{spaceId}/pages/{pageName}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PagesApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
pageName*
String
The Page name.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


Plans

deletePlan

Deletes the specified Plan.

/projects/{projectId}/plans/{planId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PlansApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
planId*
String
The Plan ID.
Required

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


deletePlanRelationship

Removes the specific Relationship from the Plan.

/projects/{projectId}/plans/{planId}/relationships/{relationshipId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PlansApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
planId*
String
The Plan ID.
Required
relationshipId*
String
The Relationship ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Not Allowed

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


deletePlans

Deletes a list of Plans.

/projects/{projectId}/plans

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/plans" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PlansApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/plans"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/plans', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/plans");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getPlan

Returns the specified Plan.

/projects/{projectId}/plans/{planId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PlansApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
planId*
String
The Plan ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getPlanRelationship

Returns a list of Plan Relationships.

/projects/{projectId}/plans/{planId}/relationships/{relationshipId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PlansApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
planId*
String
The Plan ID.
Required
relationshipId*
String
The Relationship ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 501 - Not Implemented

Status: 503 - Service Unavailable


getPlans

Returns a list of Plans.

/projects/{projectId}/plans

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/plans?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}&templates={templates}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PlansApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/plans?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}&templates={templates}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/plans?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}&templates={templates}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/plans?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}&templates={templates}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
query
String
The query string.
sort
String
The sort string.
templates
Boolean
If set to true, only templates will be returned, otherwise only actual instances will be returned.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchPlan

Updates the specified Plan.

/projects/{projectId}/plans/{planId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PlansApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
planId*
String
The Plan ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchPlanRelationships

Updates a list of Plan Relationships.

/projects/{projectId}/plans/{planId}/relationships/{relationshipId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PlansApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
planId*
String
The Plan ID.
Required
relationshipId*
String
The Relationship ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postPlanRelationships

Creates the specific Relationships for the Plan.

/projects/{projectId}/plans/{planId}/relationships/{relationshipId}

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PlansApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/relationships/{relationshipId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
planId*
String
The Plan ID.
Required
relationshipId*
String
The Relationship ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postPlans

Creates a list of Plans.

/projects/{projectId}/plans

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/plans" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class PlansApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/plans"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/plans', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/plans");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


ProjectTemplates

getProjectTemplates

Returns a list of Project Templates.

/projecttemplates

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projecttemplates?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ProjectTemplatesApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projecttemplates?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projecttemplates?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projecttemplates?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


Projects

createProject

Creates a new Project

/projects/actions/createProject

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/actions/createProject" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ProjectsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/actions/createProject"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/actions/createProject', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/actions/createProject");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Body parameters
Name Description
body *

Responses

Status: 202 - Accepted

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


deleteProject

Deletes the specified Project.

/projects/{projectId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ProjectsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required

Responses

Status: 202 - Accepted

Status: 401 - Unauthorized

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


deleteProjectTestParameterDefinition

Deletes the specified Test Parameter Definition for the specified Project.

/projects/{projectId}/testparameterdefinitions/{testParamId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions/{testParamId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ProjectsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions/{testParamId}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions/{testParamId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions/{testParamId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testParamId*
String
The Test Parameter.
Required

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getProject

Returns the specified Project.

/projects/{projectId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ProjectsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getProjectTestParameterDefinition

Returns the specified Test Parameter Definition for the specified Project.

/projects/{projectId}/testparameterdefinitions/{testParamId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ProjectsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testParamId*
String
The Test Parameter.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getProjectTestParameterDefinitions

Returns a list of Test Parameter Definitions for the specified Project.

/projects/{projectId}/testparameterdefinitions

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ProjectsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getProjects

Returns a list of Projects.

/projects

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ProjectsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
query
String
The query string.
sort
String
The sort string.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


markProject

Marks the Project.

/projects/actions/markProject

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/actions/markProject" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ProjectsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/actions/markProject"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/actions/markProject', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/actions/markProject");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Body parameters
Name Description
body *

Responses

Status: 202 - Accepted

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


moveProjectAction

Moves project to a different location

/projects/{projectId}/actions/moveProject

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/actions/moveProject" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ProjectsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/actions/moveProject"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/actions/moveProject', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/actions/moveProject");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Body parameters
Name Description
body *

Responses

Status: 202 - Accepted

Status: 401 - Unauthorized

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchProject

Updates the specified Project.

/projects/{projectId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ProjectsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postProjectTestParameterDefinitions

Creates a list of Test Parameter Definitions for the specified Project.

/projects/{projectId}/testparameterdefinitions

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ProjectsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testparameterdefinitions");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


unmarkProject

Unmarks the Project.

/projects/{projectId}/actions/unmarkProject

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/actions/unmarkProject" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ProjectsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/actions/unmarkProject"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/actions/unmarkProject', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/actions/unmarkProject");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required

Responses

Status: 202 - Accepted

Status: 401 - Unauthorized

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


Revisions

getRevision

Returns the specified instance.

/revisions/{repositoryName}/{revision}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/revisions/{repositoryName}/{revision}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class RevisionsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/revisions/{repositoryName}/{revision}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/revisions/{repositoryName}/{revision}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/revisions/{repositoryName}/{revision}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
repositoryName*
String
The Repository Name.
Required
revision*
String
The revision ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getRevisions

Returns a list of instances.

/revisions

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/revisions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class RevisionsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/revisions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/revisions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/revisions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
query
String
The query string.
sort
String
The sort string.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


Roles

getRole

Returns the specified Role.

/roles/{roleId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/roles/{roleId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class RolesApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/roles/{roleId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/roles/{roleId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/roles/{roleId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
roleId*
String
The Role ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


TestRecordAttachments

getTestRecordAttachment

Returns the specified Test Record Attachment.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments/{attachmentId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRecordAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
attachmentId*
String
The Attachment ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRecordAttachmentContent

Downloads the file content for a specified Test Record Attachment.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments/{attachmentId}/content

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments/{attachmentId}/content?revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/octet-stream, application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRecordAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments/{attachmentId}/content?revision={revision}"))
                .header("Accept", "application/octet-stream, application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/octet-stream, application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments/{attachmentId}/content?revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments/{attachmentId}/content?revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/octet-stream, application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
attachmentId*
String
The Attachment ID.
Required
Query parameters
Name Description
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRecordAttachments

Returns a list of Test Record Attachments.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRecordAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postTestRecordAttachments

Creates a list of Test Record Attachments.

Files are identified by order or optionally by the 'lid' attribute. See more in the Rest API User Guide.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: multipart/form-data"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRecordAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments"))
                .header("Content-Type", "multipart/form-data")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'multipart/form-data',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
Form parameters
Name Description
files *
array[byte[]] (binary)
Required
resource *
testrecord_attachmentsListPostRequest
Required

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


TestRecords

deleteTestRecordTestParameter

Deletes the specified Test Parameter for the specified Test Record.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters/{testParamId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters/{testParamId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRecordsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters/{testParamId}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters/{testParamId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters/{testParamId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
testParamId*
String
The Test Parameter.
Required

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRecord

Returns the specified Test Record.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRecordsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRecordTestParameter

Returns the specified Test Parameter for the specified Test Record.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters/{testParamId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRecordsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
testParamId*
String
The Test Parameter.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRecordTestParameters

Returns a list of Test Parameters for the specified Test Record.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRecordsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRecords

Returns a list of Test Records.

/projects/{projectId}/testruns/{testRunId}/testrecords

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}&testCaseProjectId={testCaseProjectId}&testCaseId={testCaseId}&testResultId={testResultId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRecordsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}&testCaseProjectId={testCaseProjectId}&testCaseId={testCaseId}&testResultId={testResultId}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}&testCaseProjectId={testCaseProjectId}&testCaseId={testCaseId}&testResultId={testResultId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}&testCaseProjectId={testCaseProjectId}&testCaseId={testCaseId}&testResultId={testResultId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.
testCaseProjectId
String
testCaseProjectId
testCaseId
String
testCaseId
testResultId
String
testResultId

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchTestRecord

Updates the specified Test Record.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRecordsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postTestRecordTestParameters

Creates a list of Test Parameters for the specified Test Record.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRecordsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postTestRecords

Creates a list of Test Records.

/projects/{projectId}/testruns/{testRunId}/testrecords

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRecordsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


TestRunAttachments

deleteTestRunAttachment

Deletes the specified Test Run Attachment.

/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
attachmentId*
String
The Attachment ID.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 413 - Request Entity Too Large

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRunAttachment

Returns the specified Test Run Attachment.

/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
attachmentId*
String
The Attachment ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRunAttachmentContent

Downloads the file content for a specified Test Run Attachment.

/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}/content

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}/content?revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/octet-stream, application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}/content?revision={revision}"))
                .header("Accept", "application/octet-stream, application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/octet-stream, application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}/content?revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}/content?revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/octet-stream, application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
attachmentId*
String
The Attachment ID.
Required
Query parameters
Name Description
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRunAttachments

Returns a list of Test Run Attachments.

/projects/{projectId}/testruns/{testRunId}/attachments

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
Required
testRunId*
String
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchTestRunAttachment

Updates the specified Test Run Attachment.

See more in the Rest API User Guide.

/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: multipart/form-data"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}"))
                .header("Content-Type", "multipart/form-data")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'multipart/form-data',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
Required
testRunId*
String
Required
attachmentId*
String
Required
Form parameters
Name Description
content
byte[] (binary)
resource
testrun_attachmentsSinglePatchRequest

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postTestRunAttachments

Creates a list of Test Run Attachments.

Files are identified by order or optionally by the 'lid' attribute. See more in the Rest API User Guide.

/projects/{projectId}/testruns/{testRunId}/attachments

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: multipart/form-data"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments"))
                .header("Content-Type", "multipart/form-data")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'multipart/form-data',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
Required
testRunId*
String
Required
Form parameters
Name Description
files *
array[byte[]] (binary)
Required
resource *
testrun_attachmentsListPostRequest
Required

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


TestRunComments

getTestRunComment

Returns the specified Test Run Comment.

/projects/{projectId}/testruns/{testRunId}/comments/{commentId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments/{commentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunCommentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments/{commentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments/{commentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments/{commentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
commentId*
String
The Comment ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRunComments

Returns a list of Test Run Comments.

/projects/{projectId}/testruns/{testRunId}/comments

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunCommentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchTestRunComment

Updates the specified Test Run Comment.

/projects/{projectId}/testruns/{testRunId}/comments/{commentId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments/{commentId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunCommentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments/{commentId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments/{commentId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments/{commentId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
commentId*
String
The Comment ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postTestRunComments

Creates a list of Test Run Comments.

/projects/{projectId}/testruns/{testRunId}/comments

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunCommentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/comments");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


TestRuns

deleteTestRun

Deletes the specified Test Run.

/projects/{projectId}/testruns/{testRunId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


deleteTestRunTestParameter

Deletes the specified Test Parameter for the specified Test Run.

/projects/{projectId}/testruns/{testRunId}/testparameters/{testParamId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters/{testParamId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters/{testParamId}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters/{testParamId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters/{testParamId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testParamId*
String
The Test Parameter.
Required

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


deleteTestRunTestParameterDefinition

Deletes the specified Test Parameter Definition for the specified Test Run.

/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions/{testParamId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions/{testParamId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions/{testParamId}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions/{testParamId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions/{testParamId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testParamId*
String
The Test Parameter.
Required

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


exportExcelTests

Exports tests to Excel.

/projects/{projectId}/testruns/{testRunId}/actions/exportTestsToExcel

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/actions/exportTestsToExcel" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/actions/exportTestsToExcel"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/actions/exportTestsToExcel', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/actions/exportTestsToExcel");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
Body parameters
Name Description
body

Responses

Status: 202 - Accepted

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRun

Returns the specified Test Run.

/projects/{projectId}/testruns/{testRunId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRunTestParameter

Returns the specified Test Parameter for the specified Test Run.

/projects/{projectId}/testruns/{testRunId}/testparameters/{testParamId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testParamId*
String
The Test Parameter.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRunTestParameterDefinition

Returns the specified Test Parameter Definition for the specified Test Run.

/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions/{testParamId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testParamId*
String
The Test Parameter.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRunTestParameterDefinitions

Returns a list of Test Parameter Definitions for the specified Test Run.

/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRunTestParameters

Returns a list of Test Parameters for the specified Test Run.

/projects/{projectId}/testruns/{testRunId}/testparameters

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestRuns

Returns a list of Test Runs.

/projects/{projectId}/testruns

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}&templates={templates}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}&templates={templates}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}&templates={templates}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}&templates={templates}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
query
String
The query string.
sort
String
The sort string.
templates
Boolean
If set to true, only templates will be returned, otherwise only actual instances will be returned.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


importExcelTestResults

Imports Excel test results.

/projects/{projectId}/testruns/{testRunId}/actions/importExcelTestResults

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/actions/importExcelTestResults" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: multipart/form-data"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/actions/importExcelTestResults"))
                .header("Content-Type", "multipart/form-data")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'multipart/form-data',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/actions/importExcelTestResults', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/actions/importExcelTestResults");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
Form parameters
Name Description
file *
byte[] (binary)
Required
resource *
importTestResultsRequestBody
Required

Responses

Status: 202 - Accepted

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


importXUnitTestResults

Imports XUnit test results.

/projects/{projectId}/testruns/{testRunId}/actions/importXUnitTestResults

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/actions/importXUnitTestResults" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/octet-stream"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/actions/importXUnitTestResults"))
                .header("Content-Type", "application/octet-stream")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/octet-stream',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/actions/importXUnitTestResults', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/actions/importXUnitTestResults");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/octet-stream");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
Body parameters
Name Description
body *

Responses

Status: 202 - Accepted

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchTestRun

Updates the specified Test Run.

/projects/{projectId}/testruns/{testRunId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postTestRunParameterDefinitions

Creates a list of Test Parameter Definitions for the specified Test Run.

/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postTestRunTestParameters

Creates a list of Test Parameters for the specified Test Run.

/projects/{projectId}/testruns/{testRunId}/testparameters

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testparameters");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postTestRuns

Creates a list of Test Runs.

/projects/{projectId}/testruns

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/testruns" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestRunsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


TestStepResultAttachments

getTestStepResultAttachment

Returns the specified Test Step Result Attachment for the specified Test Record.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments/{attachmentId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestStepResultAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
testStepIndex*
String
The Test Step index.
Required
attachmentId*
String
The Attachment ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestStepResultAttachmentContent

Downloads the file content for a specified Test Step Result Attachment for the specified Test Record.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments/{attachmentId}/content

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments/{attachmentId}/content?revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/octet-stream, application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestStepResultAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments/{attachmentId}/content?revision={revision}"))
                .header("Accept", "application/octet-stream, application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/octet-stream, application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments/{attachmentId}/content?revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments/{attachmentId}/content?revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/octet-stream, application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
testStepIndex*
String
The Test Step index.
Required
attachmentId*
String
The Attachment ID.
Required
Query parameters
Name Description
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestStepResultAttachments

Returns a list of Attachments for the specified Test Step Result.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestStepResultAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
testStepIndex*
String
The Test Step index.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postTestStepResultAttachments

Creates a list of Test Step Result Attachments.

Files are identified by order or optionally by the 'lid' attribute. See more in the Rest API User Guide.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: multipart/form-data"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestStepResultAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments"))
                .header("Content-Type", "multipart/form-data")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'multipart/form-data',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
testStepIndex*
String
The Test Step index.
Required
Form parameters
Name Description
files *
array[byte[]] (binary)
Required
resource *
teststepresult_attachmentsListPostRequest
Required

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


TestStepResults

getTestStepResult

Returns the specified Test Step Result.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestStepResultsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
testStepIndex*
String
The Test Step index.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestStepResults

Returns a list of Test Step Results.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestStepResultsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postTestStepResults

Creates a list of Test Step Results.

/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestStepResultsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
testRunId*
String
The Test Run ID.
Required
testCaseProjectId*
String
The Testcase Project ID.
Required
testCaseId*
String
The Testcase ID.
Required
iteration*
String
The Iteration Number.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


TestSteps

deleteTestStep

Deletes the specified Test Step.

/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestStepsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
testStepIndex*
String
The Test Step index.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Not Allowed

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


deleteTestSteps

Deletes a list of Test Steps.

/projects/{projectId}/workitems/{workItemId}/teststeps

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestStepsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestStep

Returns the specified Test Step.

/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestStepsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
testStepIndex*
String
The Test Step index.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getTestSteps

Returns a list of Test Steps.

/projects/{projectId}/workitems/{workItemId}/teststeps

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestStepsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchTestStep

Updates the specified Test Step.

/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestStepsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
testStepIndex*
String
The Test Step index.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchTestSteps

Updates a list of Test Steps.

/projects/{projectId}/workitems/{workItemId}/teststeps

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestStepsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postTestSteps

Creates a list of Test Steps.

/projects/{projectId}/workitems/{workItemId}/teststeps

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class TestStepsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/teststeps");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


UserGroups

getUserGroup

Returns the specified User Group.

/usergroups/{groupId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/usergroups/{groupId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class UserGroupsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/usergroups/{groupId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/usergroups/{groupId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/usergroups/{groupId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
groupId*
String
The Group ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


Users

getAvatar

Returns the specified User Avatar.

/users/{userId}/actions/getAvatar

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/users/{userId}/actions/getAvatar" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/octet-stream, application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class UsersApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/users/{userId}/actions/getAvatar"))
                .header("Accept", "application/octet-stream, application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/octet-stream, application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/users/{userId}/actions/getAvatar', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/users/{userId}/actions/getAvatar");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/octet-stream, application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
userId*
String
The User ID.
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getUser

Returns the specified User.

/users/{userId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/users/{userId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class UsersApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/users/{userId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/users/{userId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/users/{userId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
userId*
String
The User ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getUsers

Returns a list of Users.

/users

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/users?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class UsersApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/users?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/users?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/users?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
query
String
The query string.
sort
String
The sort string.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchUser

Updates the specified User.

/users/{userId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/users/{userId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class UsersApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/users/{userId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/users/{userId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/users/{userId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
userId*
String
The User ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postUsers

Creates a list of Users.

/users

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/users" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class UsersApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/users"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/users', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/users");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


setLicense

Sets the User's license.

/users/{userId}/actions/setLicense

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/users/{userId}/actions/setLicense" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class UsersApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/users/{userId}/actions/setLicense"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/users/{userId}/actions/setLicense', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/users/{userId}/actions/setLicense");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
userId*
String
The User ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


updateAvatar

Updates the specified User Avatar.

/users/{userId}/actions/updateAvatar

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/users/{userId}/actions/updateAvatar" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: multipart/form-data"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class UsersApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/users/{userId}/actions/updateAvatar"))
                .header("Content-Type", "multipart/form-data")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'multipart/form-data',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/users/{userId}/actions/updateAvatar', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/users/{userId}/actions/updateAvatar");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
userId*
String
The User ID.
Required
Form parameters
Name Description
content
byte[] (binary)

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


WorkItemApprovals

deleteApproval

Deletes the specified Work Item Approval.

/projects/{projectId}/workitems/{workItemId}/approvals/{userId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals/{userId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemApprovalsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals/{userId}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals/{userId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals/{userId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
userId*
String
The User ID.
Required

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


deleteApprovals

Deletes a list of Work Item Approvals.

/projects/{projectId}/workitems/{workItemId}/approvals

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemApprovalsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getWorkItemApproval

Returns the specified instance.

/projects/{projectId}/workitems/{workItemId}/approvals/{userId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals/{userId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemApprovalsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals/{userId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals/{userId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals/{userId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
userId*
String
The User ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getWorkItemApprovals

Returns a list of instances.

/projects/{projectId}/workitems/{workItemId}/approvals

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemApprovalsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchWorkItemApproval

Updates the specified instance.

/projects/{projectId}/workitems/{workItemId}/approvals/{userId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals/{userId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemApprovalsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals/{userId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals/{userId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals/{userId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
userId*
String
The User ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchWorkItemApprovals

Updates a list of instances.

/projects/{projectId}/workitems/{workItemId}/approvals

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemApprovalsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postWorkItemApprovals

Creates a list of WorkItem Approvals.

/projects/{projectId}/workitems/{workItemId}/approvals

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemApprovalsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/approvals");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


WorkItemAttachments

deleteWorkItemAttachment

Deletes the specified Work Item Attachment.

/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
attachmentId*
String
The Attachment ID.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 413 - Request Entity Too Large

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getWorkItemAttachment

Returns the specified Work Item Attachment.

/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
attachmentId*
String
The Attachment ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getWorkItemAttachmentContent

Downloads the file content for a specified Work Item Attachment.

/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}/content

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}/content?revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/octet-stream, application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}/content?revision={revision}"))
                .header("Accept", "application/octet-stream, application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/octet-stream, application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}/content?revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}/content?revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/octet-stream, application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
attachmentId*
String
The Attachment ID.
Required
Query parameters
Name Description
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getWorkItemAttachments

Returns a list of Work Item Attachments.

/projects/{projectId}/workitems/{workItemId}/attachments

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
Required
workItemId*
String
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchWorkItemAttachment

Updates the specified Work Item Attachment.

See more in the Rest API User Guide.

/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: multipart/form-data"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}"))
                .header("Content-Type", "multipart/form-data")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'multipart/form-data',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
Required
workItemId*
String
Required
attachmentId*
String
Required
Form parameters
Name Description
content
byte[] (binary)
resource
workitem_attachmentsSinglePatchRequest

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postWorkItemAttachments

Creates a list of Work Item Attachments.

Files are identified by order or optionally by the 'lid' attribute. See more in the Rest API User Guide.

/projects/{projectId}/workitems/{workItemId}/attachments

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: multipart/form-data"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemAttachmentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments"))
                .header("Content-Type", "multipart/form-data")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'multipart/form-data',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/attachments");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
Required
workItemId*
String
Required
Form parameters
Name Description
files *
array[byte[]] (binary)
Required
resource *
workitem_attachmentsListPostRequest
Required

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


WorkItemComments

getComment

Returns the specified Work Item Comment.

/projects/{projectId}/workitems/{workItemId}/comments/{commentId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments/{commentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemCommentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments/{commentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments/{commentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments/{commentId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
commentId*
String
The Comment ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getComments

Returns a list of Work Item Comments.

/projects/{projectId}/workitems/{workItemId}/comments

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemCommentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchComment

Updates the specified Work Item Comment.

/projects/{projectId}/workitems/{workItemId}/comments/{commentId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments/{commentId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemCommentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments/{commentId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments/{commentId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments/{commentId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
commentId*
String
The Comment ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postComments

Creates a list of Work Item Comments.

/projects/{projectId}/workitems/{workItemId}/comments

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemCommentsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/comments");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


WorkItemWorkRecords

deleteWorkRecord

Deletes the specified Work Record.

/projects/{projectId}/workitems/{workItemId}/workrecords/{workRecordId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords/{workRecordId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemWorkRecordsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords/{workRecordId}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords/{workRecordId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords/{workRecordId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
workRecordId*
String
The Work Record ID.
Required

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


deleteWorkRecords

Deletes a list of Work Records.

/projects/{projectId}/workitems/{workItemId}/workrecords

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemWorkRecordsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getWorkRecord

Returns the specified instance.

/projects/{projectId}/workitems/{workItemId}/workrecords/{workRecordId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords/{workRecordId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemWorkRecordsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords/{workRecordId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords/{workRecordId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords/{workRecordId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
workRecordId*
String
The Work Record ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getWorkRecords

Returns a list of instances.

/projects/{projectId}/workitems/{workItemId}/workrecords

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemWorkRecordsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postWorkRecords

Creates a list of Work Records.

/projects/{projectId}/workitems/{workItemId}/workrecords

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemWorkRecordsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/workrecords");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


WorkItems

deleteAllWorkItems

Deletes a list of Work Items from the Global context.

/all/workitems

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/all/workitems" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/all/workitems"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/all/workitems', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/all/workitems");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


deleteWorkItems

Deletes a list of Work Items.

/projects/{projectId}/workitems

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/workitems" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


deleteWorkItemsRelationship

Deletes a list of Work Item Relationships.

/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .DELETE()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'DELETE',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.DELETE;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
relationshipId*
String
The Relationship ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Not Allowed

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getAllWorkItems

Returns a list of Work Items from the Global context.

/all/workitems

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/all/workitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/all/workitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/all/workitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/all/workitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
query
String
The query string.
sort
String
The sort string.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getAvailableEnumOptionsForWorkItem

Returns a list of available options for the requested field for the specified Work Item.

/projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getAvailableOptions

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
fieldId*
String
The Field ID.
Required
Query parameters
Name Description
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getAvailableEnumOptionsForWorkItemType

Returns a list of available options for the requested field for the specified Work Item Type.

/projects/{projectId}/workitems/fields/{fieldId}/actions/getAvailableOptions

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}&type={type}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}&type={type}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}&type={type}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/fields/{fieldId}/actions/getAvailableOptions?page[size]={page[size]}&page[number]={page[number]}&type={type}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
fieldId*
String
The Field ID.
Required
Query parameters
Name Description
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
type
String
The Type of the object.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getCurrentEnumOptionsForWorkItem

Returns a list of selected options for the requested field for specific Work Item.

/projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getCurrentOptions

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getCurrentOptions?page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getCurrentOptions?page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getCurrentOptions?page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getCurrentOptions?page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
fieldId*
String
The Field ID.
Required
Query parameters
Name Description
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getWorkItem

Returns the specified Work Item.

/projects/{projectId}/workitems/{workItemId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getWorkItemTestParameterDefinition

Returns the specified Test Parameter Definition for the specified Work Item.

/projects/{projectId}/workitems/{workItemId}/testparameterdefinitions/{testParamId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/testparameterdefinitions/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/testparameterdefinitions/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/testparameterdefinitions/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/testparameterdefinitions/{testParamId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
testParamId*
String
The Test Parameter.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getWorkItemTestParameterDefinitions

Returns a list of Test Parameter Definitions for the specified Work Item.

/projects/{projectId}/workitems/{workItemId}/testparameterdefinitions

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/testparameterdefinitions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/testparameterdefinitions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/testparameterdefinitions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/testparameterdefinitions?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getWorkItems

Returns a list of Work Items.

/projects/{projectId}/workitems

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&query={query}&sort={sort}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
query
String
The query string.
sort
String
The sort string.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getWorkItemsRelationships

Returns a list of Work Item Relationships.

/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}?fields[categories]={fields[categories]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[page_attachments]={fields[page_attachments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
relationshipId*
String
The Relationship ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[document_attachments]
String
fields[document_comments]
String
fields[document_parts]
String
fields[documents]
String
fields[enumerations]
String
fields[externallylinkedworkitems]
String
fields[featureselections]
String
fields[globalroles]
String
fields[icons]
String
fields[jobs]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[page_attachments]
String
fields[pages]
String
fields[plans]
String
fields[projectroles]
String
fields[projects]
String
fields[projecttemplates]
String
fields[revisions]
String
fields[testparameter_definitions]
String
fields[testparameters]
String
fields[testrecord_attachments]
String
fields[testrecords]
String
fields[testrun_attachments]
String
fields[testrun_comments]
String
fields[testruns]
String
fields[teststep_results]
String
fields[teststepresult_attachments]
String
fields[teststeps]
String
fields[usergroups]
String
fields[users]
String
fields[workitem_approvals]
String
fields[workitem_attachments]
String
fields[workitem_comments]
String
fields[workitems]
String
fields[workrecords]
String
include
String
Include related entities. See Rest API User Guide for details.
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


getWorkflowActionsForWorkItem

Returns a list of Workflow Actions.

/projects/{projectId}/workitems/{workItemId}/actions/getWorkflowActions

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/actions/getWorkflowActions?page[size]={page[size]}&page[number]={page[number]}&revision={revision}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/actions/getWorkflowActions?page[size]={page[size]}&page[number]={page[number]}&revision={revision}"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .GET()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'GET',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/actions/getWorkflowActions?page[size]={page[size]}&page[number]={page[number]}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/actions/getWorkflowActions?page[size]={page[size]}&page[number]={page[number]}&revision={revision}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Query parameters
Name Description
page[size]
Integer (int32)
Limit the number of entities returned in a single response. See Rest API User Guide for details.
page[number]
Integer (int32)
Specify the page number to be returned. Counting starts from 1. See Rest API User Guide for details.
revision
String
The revision ID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


moveFromDocument

Moves the specified Work Item from the Document.

/projects/{projectId}/workitems/{workItemId}/actions/moveFromDocument

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/actions/moveFromDocument" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/actions/moveFromDocument"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/actions/moveFromDocument', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/actions/moveFromDocument");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


moveToDocument

Moves the specified Work Item to the Document.

/projects/{projectId}/workitems/{workItemId}/actions/moveToDocument

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/actions/moveToDocument" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/actions/moveToDocument"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/actions/moveToDocument', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/actions/moveToDocument");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchAllWorkItems

Updates a list of Work Items in the Global context.

/all/workitems

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/all/workitems?workflowAction={workflowAction}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/all/workitems?workflowAction={workflowAction}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/all/workitems?workflowAction={workflowAction}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/all/workitems?workflowAction={workflowAction}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
workflowAction
String
The Workflow Action.

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchWorkItem

Updates the specified Work Item.

/projects/{projectId}/workitems/{workItemId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}?workflowAction={workflowAction}&changeTypeTo={changeTypeTo}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}?workflowAction={workflowAction}&changeTypeTo={changeTypeTo}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}?workflowAction={workflowAction}&changeTypeTo={changeTypeTo}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}?workflowAction={workflowAction}&changeTypeTo={changeTypeTo}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
Body parameters
Name Description
body *
Query parameters
Name Description
workflowAction
String
The Workflow Action.
changeTypeTo
String
The Type the Workitem to change to.

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchWorkItemRelationships

Updates a list of Work Item Relationships.

/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
relationshipId*
String
The Relationship ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


patchWorkItems

Updates a list of Work Items.

/projects/{projectId}/workitems

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/workitems?workflowAction={workflowAction}&changeTypeTo={changeTypeTo}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems?workflowAction={workflowAction}&changeTypeTo={changeTypeTo}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .PATCH()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'PATCH',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems?workflowAction={workflowAction}&changeTypeTo={changeTypeTo}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems?workflowAction={workflowAction}&changeTypeTo={changeTypeTo}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.PATCH;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Body parameters
Name Description
body *
Query parameters
Name Description
workflowAction
String
The Workflow Action.
changeTypeTo
String
The Type the Workitem to change to.

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postWorkItemRelationships

Creates a list of Work Item Relationships.

/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
workItemId*
String
The Work Item ID.
Required
relationshipId*
String
The Relationship ID.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable


postWorkItems

Creates a list of Work Items.

/projects/{projectId}/workitems

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/workitems" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: application/json" -H  "Content-Type: application/json"
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WorkItemsApiExample {

    public static void main(String[] args) throws IOException, InterruptedException { 
        String polarionToken = "{personal_access_token}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://example.com/polarion/rest/v1/projects/{projectId}/workitems"))
                .header("Content-Type", "application/json")
                .header("Accept", "application/json")
                .header("Authorization", "Bearer " + polarionToken)
                .POST()
                .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response);
    }
}
const options = {
    method: 'POST',
    headers: { 
        'Authorization': 'Bearer {personal_access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/projects/{projectId}/workitems', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/workitems");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.POST;
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {personal_access_token}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Parameters

Path parameters
Name Description
projectId*
String
The Project ID.
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

Status: 4XX-5XX - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable