{ "opencollection": "1.0.0", "info": { "name": "Polarion REST Account Pages API", "version": "v1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Pages", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of Pages from all Projects and Pages on the Repository level.", "type": "http" }, "http": { "method": "GET", "url": "https://example.com/polarion/rest/v1/all/pages", "params": [ { "name": "page[size]", "value": "", "type": "query", "description": "Limit the number of entities returned in a single response. See REST API User Guide for details." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details." }, { "name": "fields", "value": "", "type": "query", "description": "Filter returned resource fields. See REST API User Guide for details." }, { "name": "include", "value": "", "type": "query", "description": "Include related entities. See REST API User Guide 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 Pages from all Projects and Pages on the Repository level." }, { "info": { "name": "Returns a list of all Pages on the Repository level.", "type": "http" }, "http": { "method": "GET", "url": "https://example.com/polarion/rest/v1/pages", "params": [ { "name": "page[size]", "value": "", "type": "query", "description": "Limit the number of entities returned in a single response. See REST API User Guide for details." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details." }, { "name": "fields", "value": "", "type": "query", "description": "Filter returned resource fields. See REST API User Guide for details." }, { "name": "include", "value": "", "type": "query", "description": "Include related entities. See REST API User Guide 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 all Pages on the Repository level." }, { "info": { "name": "Returns a list of Pages from the Project context.", "type": "http" }, "http": { "method": "GET", "url": "https://example.com/polarion/rest/v1/projects/:projectId/pages", "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 REST API User Guide for details." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details." }, { "name": "fields", "value": "", "type": "query", "description": "Filter returned resource fields. See REST API User Guide for details." }, { "name": "include", "value": "", "type": "query", "description": "Include related entities. See REST API User Guide 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 Pages from the Project context." }, { "info": { "name": "Returns a list of Pages from a given Project Space.", "type": "http" }, "http": { "method": "GET", "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/pages", "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 REST API User Guide for details." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details." }, { "name": "fields", "value": "", "type": "query", "description": "Filter returned resource fields. See REST API User Guide for details." }, { "name": "include", "value": "", "type": "query", "description": "Include related entities. See REST API User Guide 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 Pages from a given Project Space." }, { "info": { "name": "Creates a list of Pages.", "type": "http" }, "http": { "method": "POST", "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/pages", "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 Pages." }, { "info": { "name": "Returns the specified Page.", "type": "http" }, "http": { "method": "GET", "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/pages/:pageName", "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": "pageName", "value": "", "type": "path", "description": "The Page name." }, { "name": "fields", "value": "", "type": "query", "description": "Filter returned resource fields. See REST API User Guide for details." }, { "name": "include", "value": "", "type": "query", "description": "Include related entities. See REST API User Guide for details." }, { "name": "revision", "value": "", "type": "query", "description": "The revision ID." } ] }, "docs": "Returns the specified Page." }, { "info": { "name": "Updates the specified Page.", "type": "http" }, "http": { "method": "PATCH", "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/pages/:pageName", "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": "pageName", "value": "", "type": "path", "description": "The Page name." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Page." }, { "info": { "name": "Deletes the specified Page.", "type": "http" }, "http": { "method": "DELETE", "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/pages/:pageName", "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": "pageName", "value": "", "type": "path", "description": "The Page name." } ] }, "docs": "Deletes the specified Page." }, { "info": { "name": "Returns a list of Page Relationships.", "type": "http" }, "http": { "method": "GET", "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/pages/:pageName/relationships/:relationshipId", "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": "pageName", "value": "", "type": "path", "description": "The Page name." }, { "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 REST API User Guide for details." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details." }, { "name": "fields", "value": "", "type": "query", "description": "Filter returned resource fields. See REST API User Guide for details." }, { "name": "include", "value": "", "type": "query", "description": "Include related entities. See REST API User Guide for details." }, { "name": "revision", "value": "", "type": "query", "description": "The revision ID." } ] }, "docs": "Returns a list of Page Relationships." }, { "info": { "name": "Creates a list of Rich Page Relationships.", "type": "http" }, "http": { "method": "POST", "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/pages/:pageName/relationships/:relationshipId", "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": "pageName", "value": "", "type": "path", "description": "The Page name." }, { "name": "relationshipId", "value": "", "type": "path", "description": "The Relationship ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a list of Rich Page Relationships." }, { "info": { "name": "Updates a list of Page Relationships.", "type": "http" }, "http": { "method": "PATCH", "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/pages/:pageName/relationships/:relationshipId", "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": "pageName", "value": "", "type": "path", "description": "The Page name." }, { "name": "relationshipId", "value": "", "type": "path", "description": "The Relationship ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a list of Page Relationships." }, { "info": { "name": "Deletes a list of Page Relationships.", "type": "http" }, "http": { "method": "DELETE", "url": "https://example.com/polarion/rest/v1/projects/:projectId/spaces/:spaceId/pages/:pageName/relationships/:relationshipId", "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": "pageName", "value": "", "type": "path", "description": "The Page name." }, { "name": "relationshipId", "value": "", "type": "path", "description": "The Relationship ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a list of Page Relationships." }, { "info": { "name": "Returns a list of Pages in a given Space on the Repository level.", "type": "http" }, "http": { "method": "GET", "url": "https://example.com/polarion/rest/v1/spaces/:spaceId/pages", "params": [ { "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 REST API User Guide for details." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details." }, { "name": "fields", "value": "", "type": "query", "description": "Filter returned resource fields. See REST API User Guide for details." }, { "name": "include", "value": "", "type": "query", "description": "Include related entities. See REST API User Guide 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 Pages in a given Space on the Repository level." } ] } ], "bundled": true }