{
  "opencollection": "1.0.0",
  "info": {
    "name": "Polarion REST Account Documents API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Returns a list of Documents from all Projects.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/all/documents",
            "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 Documents from all Projects."
        },
        {
          "info": {
            "name": "Creates Branches of Documents.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://example.com/polarion/rest/v1/all/documents/actions/branch",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates Branches of Documents."
        },
        {
          "info": {
            "name": "Returns a list of Documents from the Project context.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/documents",
            "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 Documents from the Project context."
        },
        {
          "info": {
            "name": "Returns a list of available options for the requested field for the specified Document type.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/documents/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 Document type."
        },
        {
          "info": {
            "name": "Returns a list of Documents from a given Project Space.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/documents",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The Space ID. (Use '_default' without quotes to address the default Space.)"
              },
              {
                "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."
              }
            ]
          },
          "docs": "Returns a list of Documents from a given Project Space."
        },
        {
          "info": {
            "name": "Creates a list of Documents.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/documents",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The Space ID. (Use '_default' without quotes to address the default Space.)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a list of Documents."
        },
        {
          "info": {
            "name": "Returns the specified Document.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/documents/:documentName",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The Space ID. (Use '_default' without quotes to address the default Space.)"
              },
              {
                "name": "documentName",
                "value": "",
                "type": "path",
                "description": "The Document name."
              },
              {
                "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 Document."
        },
        {
          "info": {
            "name": "Updates the specified Document.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/documents/:documentName",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The Space ID. (Use '_default' without quotes to address the default Space.)"
              },
              {
                "name": "documentName",
                "value": "",
                "type": "path",
                "description": "The Document name."
              },
              {
                "name": "workflowAction",
                "value": "",
                "type": "query",
                "description": "The Workflow Action."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the specified Document."
        },
        {
          "info": {
            "name": "Creates a Branch of the Document.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/documents/:documentName/actions/branch",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The Space ID. (Use '_default' without quotes to address the default Space.)"
              },
              {
                "name": "documentName",
                "value": "",
                "type": "path",
                "description": "The Document name."
              },
              {
                "name": "revision",
                "value": "",
                "type": "query",
                "description": "The revision ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a Branch of the Document."
        },
        {
          "info": {
            "name": "Creates a copy of the Document.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/documents/:documentName/actions/copy",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The Space ID. (Use '_default' without quotes to address the default Space.)"
              },
              {
                "name": "documentName",
                "value": "",
                "type": "path",
                "description": "The Document name."
              },
              {
                "name": "revision",
                "value": "",
                "type": "query",
                "description": "The revision ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a copy of the Document."
        },
        {
          "info": {
            "name": "Merges Master Work Item changes to the specified Branched Document.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/documents/:documentName/actions/mergeFromMaster",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The Space ID. (Use '_default' without quotes to address the default Space.)"
              },
              {
                "name": "documentName",
                "value": "",
                "type": "path",
                "description": "The Branch Document Name."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Merges Master Work Item changes to the specified Branched Document."
        },
        {
          "info": {
            "name": "Merges Work Item changes from specified Branched Document to Master.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/documents/:documentName/actions/mergeToMaster",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The Space ID. (Use '_default' without quotes to address the default Space.)"
              },
              {
                "name": "documentName",
                "value": "",
                "type": "path",
                "description": "The Branch Document Name."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Merges Work Item changes from specified Branched Document to Master."
        },
        {
          "info": {
            "name": "Returns a list of available options for the requested field in the specified Document.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/documents/:documentName/fields/:fieldId/actions/getAvailableOptions",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The Space ID. (Use '_default' without quotes to address the default Space.)"
              },
              {
                "name": "documentName",
                "value": "",
                "type": "path",
                "description": "The Document name."
              },
              {
                "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 in the specified Document."
        },
        {
          "info": {
            "name": "Returns a list of selected options for the requested field in the specified Document.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/documents/:documentName/fields/:fieldId/actions/getCurrentOptions",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "The Project ID."
              },
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The Space ID. (Use '_default' without quotes to address the default Space.)"
              },
              {
                "name": "documentName",
                "value": "",
                "type": "path",
                "description": "The Document name."
              },
              {
                "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 in the specified Document."
        }
      ]
    }
  ],
  "bundled": true
}