{
  "opencollection": "1.0.0",
  "info": {
    "name": "Polarion REST Account Work Items API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Work Items",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Returns a list of Work Items from all Projects.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/all/workitems",
            "params": [
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "The query string."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "The sort string."
              },
              {
                "name": "revision",
                "value": "",
                "type": "query",
                "description": "The revision ID."
              }
            ]
          },
          "docs": "Returns a list of Work Items from all Projects."
        },
        {
          "info": {
            "name": "Updates a list of Work Items in the Global context.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://example.com/polarion/rest/v1/all/workitems",
            "params": [
              {
                "name": "workflowAction",
                "value": "",
                "type": "query",
                "description": "The Workflow Action."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a list of Work Items in the Global context."
        },
        {
          "info": {
            "name": "Deletes a list of Work Items from the Global context.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://example.com/polarion/rest/v1/all/workitems",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Deletes a list of Work Items from the Global context."
        },
        {
          "info": {
            "name": "Returns a list of Work Items.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "The query string."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "The sort string."
              },
              {
                "name": "revision",
                "value": "",
                "type": "query",
                "description": "The revision ID."
              }
            ]
          },
          "docs": "Returns a list of Work Items."
        },
        {
          "info": {
            "name": "Creates a list of Work Items.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a list of Work Items."
        },
        {
          "info": {
            "name": "Updates a list of Work Items.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "workflowAction",
                "value": "",
                "type": "query",
                "description": "The Workflow Action."
              },
              {
                "name": "changeTypeTo",
                "value": "",
                "type": "query",
                "description": "The Type the Workitem to change to."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a list of Work Items."
        },
        {
          "info": {
            "name": "Deletes a list of Work Items.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Deletes a list of Work Items."
        },
        {
          "info": {
            "name": "Returns the specified Work Item.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems/:workItemId",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "workItemId",
                "value": "",
                "type": "path",
                "description": "The Work Item ID."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "revision",
                "value": "",
                "type": "query",
                "description": "The revision ID."
              }
            ]
          },
          "docs": "Returns the specified Work Item."
        },
        {
          "info": {
            "name": "Updates the specified Work Item.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems/:workItemId",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "workItemId",
                "value": "",
                "type": "path",
                "description": "The Work Item ID."
              },
              {
                "name": "workflowAction",
                "value": "",
                "type": "query",
                "description": "The Workflow Action."
              },
              {
                "name": "changeTypeTo",
                "value": "",
                "type": "query",
                "description": "The Type the Workitem to change to."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the specified Work Item."
        },
        {
          "info": {
            "name": "Returns a list of Workflow Actions.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems/:workItemId/actions/getWorkflowActions",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "workItemId",
                "value": "",
                "type": "path",
                "description": "The Work Item ID."
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "revision",
                "value": "",
                "type": "query",
                "description": "The revision ID."
              }
            ]
          },
          "docs": "Returns a list of Workflow Actions."
        },
        {
          "info": {
            "name": "Moves the specified Work Item from the Document.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems/:workItemId/actions/moveFromDocument",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "workItemId",
                "value": "",
                "type": "path",
                "description": "The Work Item ID."
              }
            ]
          },
          "docs": "Moves the specified Work Item from the Document."
        },
        {
          "info": {
            "name": "Moves the specified Work Item to the Document.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems/:workItemId/actions/moveToDocument",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "workItemId",
                "value": "",
                "type": "path",
                "description": "The Work Item ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Moves the specified Work Item to the Document."
        },
        {
          "info": {
            "name": "Returns a list of available options for the requested field for the specified Work Item.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems/:workItemId/fields/:fieldId/actions/getAvailableOptions",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "workItemId",
                "value": "",
                "type": "path",
                "description": "The Work Item ID."
              },
              {
                "name": "fieldId",
                "value": "",
                "type": "path",
                "description": "The Field ID."
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              }
            ]
          },
          "docs": "Returns a list of available options for the requested field for the specified Work Item."
        },
        {
          "info": {
            "name": "Returns a list of selected options for the requested field for specific Work Item.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems/:workItemId/fields/:fieldId/actions/getCurrentOptions",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "workItemId",
                "value": "",
                "type": "path",
                "description": "The Work Item ID."
              },
              {
                "name": "fieldId",
                "value": "",
                "type": "path",
                "description": "The Field ID."
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "revision",
                "value": "",
                "type": "query",
                "description": "The revision ID."
              }
            ]
          },
          "docs": "Returns a list of selected options for the requested field for specific Work Item."
        },
        {
          "info": {
            "name": "Returns a list of Work Item Relationships.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems/:workItemId/relationships/:relationshipId",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "workItemId",
                "value": "",
                "type": "path",
                "description": "The Work Item ID."
              },
              {
                "name": "relationshipId",
                "value": "",
                "type": "path",
                "description": "The Relationship ID."
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "revision",
                "value": "",
                "type": "query",
                "description": "The revision ID."
              }
            ]
          },
          "docs": "Returns a list of Work Item Relationships."
        },
        {
          "info": {
            "name": "Creates a list of Work Item Relationships.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems/:workItemId/relationships/:relationshipId",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "workItemId",
                "value": "",
                "type": "path",
                "description": "The Work Item ID."
              },
              {
                "name": "relationshipId",
                "value": "",
                "type": "path",
                "description": "The Relationship ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a list of Work Item Relationships."
        },
        {
          "info": {
            "name": "Updates a list of Work Item Relationships.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems/:workItemId/relationships/:relationshipId",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "workItemId",
                "value": "",
                "type": "path",
                "description": "The Work Item ID."
              },
              {
                "name": "relationshipId",
                "value": "",
                "type": "path",
                "description": "The Relationship ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a list of Work Item Relationships."
        },
        {
          "info": {
            "name": "Deletes a list of Work Item Relationships.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems/:workItemId/relationships/:relationshipId",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "workItemId",
                "value": "",
                "type": "path",
                "description": "The Work Item ID."
              },
              {
                "name": "relationshipId",
                "value": "",
                "type": "path",
                "description": "The Relationship ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Deletes a list of Work Item Relationships."
        },
        {
          "info": {
            "name": "Returns a list of Test Parameter Definitions for the specified Work Item.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems/:workItemId/testparameterdefinitions",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "workItemId",
                "value": "",
                "type": "path",
                "description": "The Work Item ID."
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "revision",
                "value": "",
                "type": "query",
                "description": "The revision ID."
              }
            ]
          },
          "docs": "Returns a list of Test Parameter Definitions for the specified Work Item."
        },
        {
          "info": {
            "name": "Returns the specified Test Parameter Definition for the specified Work Item.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems/:workItemId/testparameterdefinitions/:testParamId",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "workItemId",
                "value": "",
                "type": "path",
                "description": "The Work Item ID."
              },
              {
                "name": "testParamId",
                "value": "",
                "type": "path",
                "description": "The Test Parameter."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "revision",
                "value": "",
                "type": "query",
                "description": "The revision ID."
              }
            ]
          },
          "docs": "Returns the specified Test Parameter Definition for the specified Work Item."
        },
        {
          "info": {
            "name": "Returns a list of available options for the requested field for the specified Work Item Type.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/workitems/fields/:fieldId/actions/getAvailableOptions",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "fieldId",
                "value": "",
                "type": "path",
                "description": "The Field ID."
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The Type of the object. Use '~' without quotes to represent no target Type."
              }
            ]
          },
          "docs": "Returns a list of available options for the requested field for the specified Work Item Type."
        }
      ]
    }
  ],
  "bundled": true
}