Polarion REST API

AI

generateCompletion

Generates a chat completion using a Large Language Model (LLM).

/llms/actions/generateCompletion

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/llms/actions/generateCompletion" -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 AIApiExample {

    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/llms/actions/generateCompletion"))
                .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/llms/actions/generateCompletion', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/llms/actions/generateCompletion");
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: 200 - 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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getLlms

Returns a list of Large Language Models (LLMs).

/llms

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/llms?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 AIApiExample {

    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/llms?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/llms?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/llms?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
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


Collections

closeCollection

Closes the specified Collection.

/projects/{projectId}/collections/{collectionId}/actions/close

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}/actions/close" -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 CollectionsApiExample {

    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}/collections/{collectionId}/actions/close"))
                .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}/collections/{collectionId}/actions/close', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}/actions/close");
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
collectionId*
String
The Collection ID.
Required

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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


deleteCollection

Deletes the specified Collection.

/projects/{projectId}/collections/{collectionId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}" -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 CollectionsApiExample {

    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}/collections/{collectionId}"))
                .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}/collections/{collectionId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}");
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
collectionId*
String
The Collection ID.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


deleteCollections

Deletes a list of Collections.

/projects/{projectId}/collections

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/collections" -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 CollectionsApiExample {

    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}/collections"))
                .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}/collections', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/collections");
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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


deleteCollectionsRelationship

Removes the specific Relationship from the Collection.

/projects/{projectId}/collections/{collectionId}/relationships/{relationshipId}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}/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 CollectionsApiExample {

    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}/collections/{collectionId}/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}/collections/{collectionId}/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}/collections/{collectionId}/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
collectionId*
String
The Collection 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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getCollection

Returns the specified Collection.

/projects/{projectId}/collections/{collectionId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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 CollectionsApiExample {

    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}/collections/{collectionId}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/collections/{collectionId}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/collections/{collectionId}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
collectionId*
String
The Collection ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getCollections

Returns a list of Collections.

/projects/{projectId}/collections

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/collections?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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 CollectionsApiExample {

    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}/collections?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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}/collections?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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}/collections?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
query
String
The query string.
sort
String
The sort string.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getCollectionsRelationship

Returns a list of Collection Relationships.

/projects/{projectId}/collections/{collectionId}/relationships/{relationshipId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}/relationships/{relationshipId}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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 CollectionsApiExample {

    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}/collections/{collectionId}/relationships/{relationshipId}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/collections/{collectionId}/relationships/{relationshipId}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/collections/{collectionId}/relationships/{relationshipId}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
collectionId*
String
The Collection ID.
Required
relationshipId*
String
The Relationship 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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getFieldsMetadataForCollection

Returns fields for the specified resource.

/projects/{projectId}/collections/{collectionId}/actions/getFieldsMetadata

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}/actions/getFieldsMetadata" -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 CollectionsApiExample {

    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}/collections/{collectionId}/actions/getFieldsMetadata"))
                .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}/collections/{collectionId}/actions/getFieldsMetadata', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}/actions/getFieldsMetadata");
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
collectionId*
String
The Collection ID.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchCollections

Updates the specified Collection.

/projects/{projectId}/collections/{collectionId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}" -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 CollectionsApiExample {

    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}/collections/{collectionId}"))
                .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}/collections/{collectionId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}");
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
collectionId*
String
The Collection 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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchCollectionsRelationships

Updates a list of Collection Relationships.

/projects/{projectId}/collections/{collectionId}/relationships/{relationshipId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}/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 CollectionsApiExample {

    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}/collections/{collectionId}/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}/collections/{collectionId}/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}/collections/{collectionId}/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
collectionId*
String
The Collection 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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


postCollections

Creates a list of Collections.

/projects/{projectId}/collections

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/collections" -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 CollectionsApiExample {

    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}/collections"))
                .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}/collections', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/collections");
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


postCollectionsRelationships

Creates the specific Relationships for the Collections.

/projects/{projectId}/collections/{collectionId}/relationships/{relationshipId}

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}/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 CollectionsApiExample {

    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}/collections/{collectionId}/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}/collections/{collectionId}/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}/collections/{collectionId}/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
collectionId*
String
The Collection 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: 406 - Not Acceptable

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


reopenCollection

Reopens the specified Collection.

/projects/{projectId}/collections/{collectionId}/actions/reopen

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}/actions/reopen" -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 CollectionsApiExample {

    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}/collections/{collectionId}/actions/reopen"))
                .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}/collections/{collectionId}/actions/reopen', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}/actions/reopen");
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
collectionId*
String
The Collection ID.
Required

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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


reuseCollection

Reuses the specified Collection.

/projects/{projectId}/collections/{collectionId}/actions/reuse

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/collections/{collectionId}/actions/reuse?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 CollectionsApiExample {

    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}/collections/{collectionId}/actions/reuse?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}/collections/{collectionId}/actions/reuse?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}/collections/{collectionId}/actions/reuse?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
collectionId*
String
The Collection ID.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


CustomFields

deleteGlobalCustomFields

Deletes the specified Custom Field configuration from the Global context.

/customfields/{resourceType}/{targetType}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/customfields/{resourceType}/{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 CustomFieldsApiExample {

    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/customfields/{resourceType}/{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/customfields/{resourceType}/{targetType}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/customfields/{resourceType}/{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
resourceType*
String
The Resource Type.
Required
targetType*
String
The Type of the object. Use '~' without quotes to represent no target Type.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


deleteProjectCustomFields

Deletes the specified Custom Field configuration from the Project context.

/projects/{projectId}/customfields/{resourceType}/{targetType}

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/customfields/{resourceType}/{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 CustomFieldsApiExample {

    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}/customfields/{resourceType}/{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}/customfields/{resourceType}/{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}/customfields/{resourceType}/{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
resourceType*
String
The Resource Type.
Required
targetType*
String
The Type of the object. Use '~' without quotes to represent no target Type.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getGlobalCustomFields

Returns the defined Custom Fields for the resource type and target type in the Global context.

/customfields/{resourceType}/{targetType}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/customfields/{resourceType}/{targetType}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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 CustomFieldsApiExample {

    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/customfields/{resourceType}/{targetType}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/customfields/{resourceType}/{targetType}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/customfields/{resourceType}/{targetType}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
resourceType*
String
The Resource Type.
Required
targetType*
String
The Type of the object. Use '~' without quotes to represent no target Type.
Required
Query parameters
Name Description
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getProjectCustomFields

Returns the defined Custom Fields for the resource type and target type in the Project context.

/projects/{projectId}/customfields/{resourceType}/{targetType}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/customfields/{resourceType}/{targetType}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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 CustomFieldsApiExample {

    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}/customfields/{resourceType}/{targetType}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/customfields/{resourceType}/{targetType}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/customfields/{resourceType}/{targetType}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
resourceType*
String
The Resource Type.
Required
targetType*
String
The Type of the object. Use '~' without quotes to represent no target Type.
Required
Query parameters
Name Description
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchCustomField

Updates the specified Custom Fields in the Project context.

/projects/{projectId}/customfields/{resourceType}/{targetType}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/customfields/{resourceType}/{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 CustomFieldsApiExample {

    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}/customfields/{resourceType}/{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}/customfields/{resourceType}/{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}/customfields/{resourceType}/{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
resourceType*
String
The Resource Type.
Required
targetType*
String
The Custom Field target type. (Use '~' when there is no specific type for the Prototype.)
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchGlobalCustomFields

Updates the specified Custom Fields in the Global context.

/customfields/{resourceType}/{targetType}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/customfields/{resourceType}/{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 CustomFieldsApiExample {

    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/customfields/{resourceType}/{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/customfields/{resourceType}/{targetType}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/customfields/{resourceType}/{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
resourceType*
String
The Resource Type.
Required
targetType*
String
The Custom Field target type. (Use '~' when there is no specific type for the Prototype.)
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


postGlobalCustomFields

Creates a list of Custom Fields in the Global context.

/customfields

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/customfields" -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 CustomFieldsApiExample {

    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/customfields"))
                .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/customfields', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/customfields");
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


postProjectCustomFields

Creates a list of Custom Fields in the Project context.

/projects/{projectId}/customfields

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/customfields" -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 CustomFieldsApiExample {

    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}/customfields"))
                .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}/customfields', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/projects/{projectId}/customfields");
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


DocumentParts

deleteDocumentParts

Deletes a list of Document Parts.

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

Usage and Code Samples

curl -X DELETE "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)
                .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}/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.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
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: 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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


moveDocumentParts

Moves a Work Item Document Part.

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

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts/{partId}/actions/move" -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/{partId}/actions/move"))
                .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/{partId}/actions/move', 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}/actions/move");
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
partId*
String
The Document Part 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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


overwriteDocumentParts

Overwrites multiple Work Item Document Parts.

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

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts/actions/overwrite" -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/actions/overwrite"))
                .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/actions/overwrite', 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/actions/overwrite");
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: 200 - 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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 406 - Not Acceptable

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getAllDocuments

Returns a list of Documents from all Projects.

/all/documents

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/all/documents?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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/all/documents?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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/all/documents?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/all/documents?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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

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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
query
String
The query string.
sort
String
The sort string.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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. Use '~' without quotes to represent no target Type.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getDocuments

Returns a list of Documents from the Project context.

/projects/{projectId}/documents

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/documents?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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}/documents?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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}/documents?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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}/documents?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
query
String
The query string.
sort
String
The sort string.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getFieldsMetadataForDocument

Returns fields for the specified resource.

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

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/getFieldsMetadata" -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}/actions/getFieldsMetadata"))
                .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}/actions/getFieldsMetadata', 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/getFieldsMetadata");
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 Branch Document 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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getSpaceDocuments

Returns a list of Documents from a given Project Space.

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

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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 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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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}/spaces/{spaceId}/documents?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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}/spaces/{spaceId}/documents?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


importWordDocument

Imports a Word document to create a new Polarion Document.

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

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/actions/importWordDocument" -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 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/actions/importWordDocument"))
                .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/actions/importWordDocument', 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/actions/importWordDocument");
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
Form parameters
Name Description
file *
byte[] (binary)
Required
parameters *
importWordDocumentParameters
Required

Responses

Status: 202 - Accepted

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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


mergeDocumentFromMaster

Merges Master Work Item changes to the specified Branched Document.

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

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/mergeFromMaster" -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/mergeFromMaster"))
                .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/mergeFromMaster', 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/mergeFromMaster");
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 Branch Document Name.
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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


mergeDocumentToMaster

Merges Work Item changes from specified Branched Document to Master.

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

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/mergeToMaster" -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/mergeToMaster"))
                .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/mergeToMaster', 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/mergeToMaster");
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 Branch Document Name.
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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getGlobalEnumerations

Returns a list of Enumerations from the Global context.

/enumerations

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/enumerations?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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 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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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

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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getProjectEnumerations

Returns a list of Enumerations from the Project context.

/projects/{projectId}/enumerations

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/enumerations?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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 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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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

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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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

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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


Jobs

executeJob

Executes a Job.

/jobs/actions/execute

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/jobs/actions/execute" -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 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/actions/execute"))
                .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/jobs/actions/execute', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/jobs/actions/execute");
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: 406 - Not Acceptable

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getJobLogContent

Downloads the Log content for a specified job.

/jobs/{jobId}/log/content

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/jobs/{jobId}/log/content" -H  "Authorization: Bearer {personal_access_token}" -H  "Accept: text/plain, 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}/log/content"))
                .header("Accept", "text/plain, 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': 'text/plain, application/json'
    }
}

fetch('https://example.com/polarion/rest/v1/jobs/{jobId}/log/content', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/jobs/{jobId}/log/content");
client.Timeout = -1;
var request = new RestRequest();
request.Method = Method.GET;
request.AddHeader("Accept", "text/plain, 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

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getJobs

Returns the list of Jobs.

/jobs

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/jobs?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&projectId={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 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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&projectId={projectId}"))
                .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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&projectId={projectId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/jobs?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&projectId={projectId}");
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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
projectId
String
The Project 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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


License

deleteLicenseSlots

Deletes a list of Group license slots. (Not supported by cloud-based Polarion X.)

/license/types/{typeId}/slots

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/license/types/{typeId}/slots" -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 LicenseApiExample {

    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/license/types/{typeId}/slots"))
                .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/license/types/{typeId}/slots', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/license/types/{typeId}/slots");
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
typeId*
String
License type.
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden (insufficient permissions or Polarion X environment)

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getLicense

Returns information on the available License Limits.

/license

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/license?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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 LicenseApiExample {

    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/license?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/license?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/license?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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

Query parameters
Name Description
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getLicenseAssignments

Returns a list of License Assignments. (Not supported by cloud-based Polarion X.)

/license/assignments

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/license/assignments?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&activeOnly={activeOnly}" -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 LicenseApiExample {

    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/license/assignments?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&activeOnly={activeOnly}"))
                .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/license/assignments?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&activeOnly={activeOnly}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/license/assignments?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&activeOnly={activeOnly}");
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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
activeOnly
Boolean
If set to true, only active (with status LOGGED_IN or EXPIRING) License Assignments will be returned, otherwise all the License Assignments will be returned.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden (insufficient permissions or Polarion X environment)

Status: 404 - Not Found

Status: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getLicenseAssignmentsForUser

Returns the specified License Assignment. (Not supported by cloud-based Polarion X.)

/license/assignments/{userId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/license/assignments/{userId}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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 LicenseApiExample {

    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/license/assignments/{userId}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/license/assignments/{userId}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/license/assignments/{userId}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
userId*
String
Required
Query parameters
Name Description
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 (insufficient permissions or Polarion X environment)

Status: 404 - Not Found

Status: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getLicenseSlot

Returns the specified License Slot. (Not supported by cloud-based Polarion X.)

/license/types/{typeId}/slots/{model}/{group}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/license/types/{typeId}/slots/{model}/{group}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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 LicenseApiExample {

    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/license/types/{typeId}/slots/{model}/{group}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/license/types/{typeId}/slots/{model}/{group}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/license/types/{typeId}/slots/{model}/{group}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
typeId*
String
Required
model*
String
Required
group*
String
Required
Query parameters
Name Description
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 (insufficient permissions or Polarion X environment)

Status: 404 - Not Found

Status: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getLicenseSlots

Returns information on the available License Slots. (Not supported by cloud-based Polarion X.)

/license/types/{typeId}/slots

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/license/types/{typeId}/slots?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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 LicenseApiExample {

    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/license/types/{typeId}/slots?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/license/types/{typeId}/slots?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/license/types/{typeId}/slots?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
typeId*
String
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 (insufficient permissions or Polarion X environment)

Status: 404 - Not Found

Status: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchLicense

Updates the product License. (Not supported by cloud-based Polarion X.)

/license

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/license" -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 LicenseApiExample {

    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/license"))
                .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/license', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/license");
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 *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden (insufficient permissions or Polarion X environment)

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchLicenseAssignment

Updates a user's License Assignment. (Not supported by cloud-based Polarion X.)

/license/assignments/{userId}

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/license/assignments/{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 LicenseApiExample {

    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/license/assignments/{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/license/assignments/{userId}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/license/assignments/{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 (insufficient permissions or Polarion X environment)

Status: 404 - Not Found

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchLicenseAssignments

Updates the License Assignments of multiple users. (Not supported by cloud-based Polarion X.)

/license/assignments

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/license/assignments" -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 LicenseApiExample {

    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/license/assignments"))
                .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/license/assignments', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/license/assignments");
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 *

Responses

Status: 200 - The request was processed, but some user License Assignments could not be changed because they are locked or because of license slot limits. See the errors array in the response for details about each failure.

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden (insufficient permissions or Polarion X environment)

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


postLicenseSlots

Creates a list of group License Slots. (Not supported by cloud-based Polarion X.)

/license/types/{typeId}/slots

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/license/types/{typeId}/slots" -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 LicenseApiExample {

    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/license/types/{typeId}/slots"))
                .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/license/types/{typeId}/slots', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/license/types/{typeId}/slots");
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
typeId*
String
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden (insufficient permissions or Polarion X environment)

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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 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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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}/linkedoslcresources?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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}/linkedoslcresources?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
query
String
The query string.
sort
String
The sort string.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getBacklinkedWorkItems

Returns a list of Backlinked Work Items.

Returns the incoming links from other Work Items (also known as backlinks). Does not pertain to External links.

/projects/{projectId}/workitems/{workItemId}/backlinkedworkitems

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/backlinkedworkitems?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/backlinkedworkitems?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/backlinkedworkitems?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/backlinkedworkitems?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


postBacklinkedWorkItems

Creates a list of Backlinked Work Items.

Creates incoming links from other Work Items (backlinks). Does not pertain to External links.

/projects/{projectId}/workitems/{workItemId}/backlinkedworkitems

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/backlinkedworkitems" -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}/backlinkedworkitems"))
                .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}/backlinkedworkitems', 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}/backlinkedworkitems");
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


Metadata

getGlobalFieldsMetadata

Returns fields for the resource type and its target type in the Global context.

/actions/getFieldsMetadata

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/actions/getFieldsMetadata?resourceType={resourceType}&targetType={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 MetadataApiExample {

    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/actions/getFieldsMetadata?resourceType={resourceType}&targetType={targetType}"))
                .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/actions/getFieldsMetadata?resourceType={resourceType}&targetType={targetType}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/actions/getFieldsMetadata?resourceType={resourceType}&targetType={targetType}");
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
resourceType*
String
The Resource Type.
Required
targetType
String
The Type of the object. Use '~' without quotes to represent no target Type.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getMetadata

Returns global metadata, including version, build, REST API configuration properties, etc. (Available to all REST API users.)

/metadata

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/metadata?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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 MetadataApiExample {

    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/metadata?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/metadata?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/metadata?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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

Query parameters
Name Description
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getProjectFieldsMetadata

Returns fields for the resource type and its target type in the Project context.

/projects/{projectId}/actions/getFieldsMetadata

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/actions/getFieldsMetadata?resourceType={resourceType}&targetType={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 MetadataApiExample {

    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/getFieldsMetadata?resourceType={resourceType}&targetType={targetType}"))
                .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}/actions/getFieldsMetadata?resourceType={resourceType}&targetType={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}/actions/getFieldsMetadata?resourceType={resourceType}&targetType={targetType}");
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
resourceType*
String
The Resource Type.
Required
targetType
String
The Type of the object. Use '~' without quotes to represent no target Type.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


PageAttachments

deletePageAttachment

Deletes the specified Page Attachment.

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

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/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 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}"))
                .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}/spaces/{spaceId}/pages/{pageName}/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}/pages/{pageName}/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
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

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getPageAttachments

Returns a list of Page Attachments.

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

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchPageAttachment

Updates the specified Page Attachment.

See more in the REST API User Guide.

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

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/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 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}"))
                .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}/pages/{pageName}/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}/pages/{pageName}/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
pageName*
String
The Page name.
Required
attachmentId*
String
The Attachment ID.
Required
Form parameters
Name Description
content
byte[] (binary)
resource
page_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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


PageComments

getPageComment

Returns the specified Page Comment.

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

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/comments/{commentId}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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 PageCommentsApiExample {

    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}/comments/{commentId}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/comments/{commentId}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/comments/{commentId}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
commentId*
String
The Comment ID.
Required
Query parameters
Name Description
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getPageComments

Returns a list of Page Comments.

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

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/comments?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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 PageCommentsApiExample {

    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}/comments?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/comments?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/comments?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchPageComment

Updates the specified Page Comment.

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

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/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 PageCommentsApiExample {

    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}/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}/pages/{pageName}/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}/pages/{pageName}/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
pageName*
String
The Page 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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


postPageComments

Creates a list of Page Comments.

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

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/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 PageCommentsApiExample {

    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}/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}/pages/{pageName}/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}/pages/{pageName}/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
pageName*
String
The Page 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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


Pages

deletePage

Deletes the specified Page.

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

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}" -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}"))
                .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}/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.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
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
pageName*
String
The Page name.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


deletePageRelationships

Deletes a list of Page Relationships.

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

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/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 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}/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}/spaces/{spaceId}/pages/{pageName}/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}/spaces/{spaceId}/pages/{pageName}/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
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
pageName*
String
The Page name.
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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getAllPages

Returns a list of Pages from all Projects and Pages on the Repository level.

/all/pages

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/all/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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/all/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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/all/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/all/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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

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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
query
String
The query string.
sort
String
The sort string.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getGlobalPages

Returns a list of all Pages on the Repository level.

/pages

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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 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/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getPageRelationships

Returns a list of Page Relationships.

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

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/relationships/{relationshipId}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/relationships/{relationshipId}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/relationships/{relationshipId}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/relationships/{relationshipId}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
relationshipId*
String
The Relationship 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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getPages

Returns a list of Pages from the Project context.

/projects/{projectId}/pages

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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}/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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}/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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}/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
query
String
The query string.
sort
String
The sort string.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getRepositorySpacePages

Returns a list of Pages in a given Space on the Repository level.

/spaces/{spaceId}/pages

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/spaces/{spaceId}/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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/spaces/{spaceId}/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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/spaces/{spaceId}/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/spaces/{spaceId}/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
query
String
The query string.
sort
String
The sort string.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getSpacePages

Returns a list of Pages from a given Project Space.

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

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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 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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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}/spaces/{spaceId}/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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}/spaces/{spaceId}/pages?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchPageRelationships

Updates a list of Page Relationships.

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

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/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 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}/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}/spaces/{spaceId}/pages/{pageName}/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}/spaces/{spaceId}/pages/{pageName}/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
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
pageName*
String
The Page name.
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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


postPageRelationships

Creates a list of Rich Page Relationships.

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

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/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 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}/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}/spaces/{spaceId}/pages/{pageName}/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}/spaces/{spaceId}/pages/{pageName}/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
spaceId*
String
The Space ID. (Use '_default' without quotes to address the default Space.)
Required
pageName*
String
The Page name.
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: 406 - Not Acceptable

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


postPages

Creates a list of Pages.

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

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/spaces/{spaceId}/pages" -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"))
                .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}/pages', 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");
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getFieldsMetadataForPlan

Returns fields for the specified resource.

/projects/{projectId}/plans/{planId}/actions/getFieldsMetadata

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/plans/{planId}/actions/getFieldsMetadata" -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}/actions/getFieldsMetadata"))
                .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}/actions/getFieldsMetadata', 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}/actions/getFieldsMetadata");
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

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/relationships/{relationshipId}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/relationships/{relationshipId}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/relationships/{relationshipId}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
relationshipId*
String
The Relationship 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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&revision={revision}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&revision={revision}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&revision={revision}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&revision={revision}&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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
query
String
The query string.
sort
String
The sort string.
revision
String
The revision ID.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Not Allowed

Status: 406 - Not Acceptable

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


ProjectTemplates

getProjectTemplates

Returns a list of Project Templates.

/projecttemplates

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projecttemplates?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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 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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/projecttemplates?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/projecttemplates?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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

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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 406 - Not Acceptable

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


deleteProjectTestParameterDefinitions

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

/projects/{projectId}/testparameterdefinitions

Usage and Code Samples

curl -X DELETE "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)
                .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}/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.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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getProjects

Returns a list of Projects.

/projects

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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

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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
query
String
The query string.
sort
String
The sort string.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 406 - Not Acceptable

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 400 - Bad Request

Status: 401 - Unauthorized

Status: 406 - Not Acceptable

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getRevisions

Returns a list of instances.

/revisions

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/revisions?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


Roles

getRole

Returns the specified Global Role.

/roles/{roleId}

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/roles/{roleId}?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


TestRecordAttachments

deleteTestRecordAttachment

Deletes the specified Test Record Attachment.

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

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/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 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}"))
                .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}/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}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/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
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

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


deleteTestRecordAttachments

Deletes a list of Test Record Attachments.

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

Usage and Code Samples

curl -X DELETE "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: 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"))
                .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}/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.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
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchTestRecordAttachment

Updates the specified Test Record Attachment.

See more in the REST API User Guide.

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

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/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 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}"))
                .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}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/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}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/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
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
Form parameters
Name Description
content
byte[] (binary)
resource
testrecord_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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


TestRecords

deleteTestRecord

Deletes the specified Test Record.

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

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}" -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}"))
                .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}', 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.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

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getFieldsMetadataForTestRecord

Returns fields for the specified resource.

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

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/actions/getFieldsMetadata" -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}/actions/getFieldsMetadata"))
                .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}/actions/getFieldsMetadata', 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}/actions/getFieldsMetadata");
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

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}&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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchTestRecords

Updates a list of Test Records.

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

Usage and Code Samples

curl -X PATCH "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)
                .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', 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.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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


deleteTestRunAttachments

Deletes a list of Test Run Attachments.

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

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/attachments" -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 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", "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}/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.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
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
Required
testRunId*
String
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchTestRunComments

Updates a list of Test Run Comments.

/projects/{projectId}/testruns/{testRunId}/comments

Usage and Code Samples

curl -X PATCH "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)
                .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', 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.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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


deleteTestRunTestParameters

Deletes a list of Test Parameters for the specified Test Run.

/projects/{projectId}/testruns/{testRunId}/testparameters

Usage and Code Samples

curl -X DELETE "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)
                .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}/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.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
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


deleteTestRuns

Deletes a list of Test Runs.

/projects/{projectId}/testruns

Usage and Code Samples

curl -X DELETE "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)
                .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}/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.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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getExportExcelTests

Exports tests to Excel.

/projects/{projectId}/testruns/{testRunId}/actions/exportTestsToExcel

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/actions/exportTestsToExcel?query={query}&sortBy={sortBy}&template={template}" -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}/actions/exportTestsToExcel?query={query}&sortBy={sortBy}&template={template}"))
                .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}/actions/exportTestsToExcel?query={query}&sortBy={sortBy}&template={template}', 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?query={query}&sortBy={sortBy}&template={template}");
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
query
String
The query string.
sortBy
String
The property to sort the test results.
template
String
The export template string.

Responses

Status: 202 - Accepted

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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getFieldsMetadataForTestRun

Returns fields for the specified resource.

/projects/{projectId}/testruns/{testRunId}/actions/getFieldsMetadata

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/actions/getFieldsMetadata" -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}/actions/getFieldsMetadata"))
                .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}/actions/getFieldsMetadata', 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/getFieldsMetadata");
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

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&revision={revision}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&revision={revision}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&revision={revision}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&revision={revision}&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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
query
String
The query string.
sort
String
The sort string.
revision
String
The revision ID.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getWorkflowActionsForTestRun

Returns a list of Workflow Actions.

/projects/{projectId}/testruns/{testRunId}/actions/getWorkflowActions

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/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 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/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}/testruns/{testRunId}/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}/testruns/{testRunId}/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
testRunId*
String
The Test Run 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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 406 - Not Acceptable

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchTestRuns

Updates a list of Test Runs.

/projects/{projectId}/testruns

Usage and Code Samples

curl -X PATCH "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)
                .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', 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.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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


TestStepResultAttachments

deleteTestStepResultAttachment

Deletes the specified Test Step Result Attachment.

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

Usage and Code Samples

curl -X DELETE "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/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 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}"))
                .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}/teststepresults/{testStepIndex}/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}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/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
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

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


deleteTestStepResultAttachments

Deletes a list of Test Step Result Attachments.

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

Usage and Code Samples

curl -X DELETE "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: 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"))
                .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}/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.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
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
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchTestStepResultAttachment

Updates the specified Test Step Result Attachment.

See more in the REST API User Guide.

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

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/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 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}"))
                .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}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/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}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/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
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
Form parameters
Name Description
content
byte[] (binary)
resource
teststepresult_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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchTestStepResult

Updates the specified Test Step Result.

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

Usage and Code Samples

curl -X PATCH "https://example.com/polarion/rest/v1/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{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 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}"))
                .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}/teststepresults/{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}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{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
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
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


patchTestStepResults

Updates a list of Test Step Results.

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

Usage and Code Samples

curl -X PATCH "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)
                .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}/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.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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getCurrentUser

Returns the current User.

/user

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/user?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/user?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/user?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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/user?fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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

Query parameters
Name Description
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getUsers

Returns a list of Users.

/users

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/users?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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

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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
query
String
The query string.
sort
String
The sort string.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
Required
workItemId*
String
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - Conflict

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getAllWorkItems

Returns a list of Work Items from all Projects.

/all/workitems

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/all/workitems?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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/all/workitems?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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/all/workitems?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&revision={revision}', options)
    .then(response => console.log(response))
    .catch(error => console.log('error', error));
var client = new RestClient("https://example.com/polarion/rest/v1/all/workitems?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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

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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
query
String
The query string.
sort
String
The sort string.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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. Use '~' without quotes to represent no target Type.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


getFieldsMetadataForWorkItem

Returns fields for the specified resource.

/projects/{projectId}/workitems/{workItemId}/actions/getFieldsMetadata

Usage and Code Samples

curl -X GET "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/{workItemId}/actions/getFieldsMetadata" -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/getFieldsMetadata"))
                .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/getFieldsMetadata', 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/getFieldsMetadata");
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

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 406 - Not Acceptable

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[workitem_approvals]}&fields[workitem_attachments]={fields[workitem_attachments]}&fields[workitem_comments]={fields[workitem_comments]}&fields[workitems]={fields[workitems]}&fields[workrecords]={fields[workrecords]}&include={include}&query={query}&sort={sort}&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
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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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.
query
String
The query string.
sort
String
The sort string.
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/relationships/{relationshipId}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/relationships/{relationshipId}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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}/relationships/{relationshipId}?page[size]={page[size]}&page[number]={page[number]}&fields[categories]={fields[categories]}&fields[collections]={fields[collections]}&fields[customfields]={fields[customfields]}&fields[document_attachments]={fields[document_attachments]}&fields[document_comments]={fields[document_comments]}&fields[document_parts]={fields[document_parts]}&fields[documents]={fields[documents]}&fields[enumerations]={fields[enumerations]}&fields[externallylinkedworkitems]={fields[externallylinkedworkitems]}&fields[featureselections]={fields[featureselections]}&fields[globalroles]={fields[globalroles]}&fields[icons]={fields[icons]}&fields[jobs]={fields[jobs]}&fields[license]={fields[license]}&fields[license_assignments]={fields[license_assignments]}&fields[license_slots]={fields[license_slots]}&fields[license_types]={fields[license_types]}&fields[linkedoslcresources]={fields[linkedoslcresources]}&fields[linkedworkitems]={fields[linkedworkitems]}&fields[llms]={fields[llms]}&fields[metadata]={fields[metadata]}&fields[page_attachments]={fields[page_attachments]}&fields[page_comments]={fields[page_comments]}&fields[pages]={fields[pages]}&fields[plans]={fields[plans]}&fields[projectroles]={fields[projectroles]}&fields[projects]={fields[projects]}&fields[projecttemplates]={fields[projecttemplates]}&fields[revisions]={fields[revisions]}&fields[testparameter_definitions]={fields[testparameter_definitions]}&fields[testparameters]={fields[testparameters]}&fields[testrecord_attachments]={fields[testrecord_attachments]}&fields[testrecords]={fields[testrecords]}&fields[testrun_attachments]={fields[testrun_attachments]}&fields[testrun_comments]={fields[testrun_comments]}&fields[testruns]={fields[testruns]}&fields[teststep_results]={fields[teststep_results]}&fields[teststepresult_attachments]={fields[teststepresult_attachments]}&fields[teststeps]={fields[teststeps]}&fields[usergroups]={fields[usergroups]}&fields[users]={fields[users]}&fields[workitem_approvals]={fields[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
relationshipId*
String
The Relationship 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.
fields[categories]
String
fields[collections]
String
fields[customfields]
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[license]
String
fields[license_assignments]
String
fields[license_slots]
String
fields[license_types]
String
fields[linkedoslcresources]
String
fields[linkedworkitems]
String
fields[llms]
String
fields[metadata]
String
fields[page_attachments]
String
fields[page_comments]
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


moveWorkItemsToDocument

Moves multiple Work Items to the Document.

/projects/{projectId}/workitems/actions/moveToDocument

Usage and Code Samples

curl -X POST "https://example.com/polarion/rest/v1/projects/{projectId}/workitems/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/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/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/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
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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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: 409 - Conflict

Status: 413 - Request Entity Too Large

Status: 415 - Unsupported Media Type

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

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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


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 - Error responses have the following structure:

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

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