{ "opencollection": "1.0.0", "info": { "name": "Polarion REST Account Projects API", "version": "v1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of Projects.", "type": "http" }, "http": { "method": "GET", "url": "https://example.com/polarion/rest/v1/projects", "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 Projects." }, { "info": { "name": "Returns the specified Project.", "type": "http" }, "http": { "method": "GET", "url": "https://example.com/polarion/rest/v1/projects/:projectId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The Project ID." }, { "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 Project." }, { "info": { "name": "Updates the specified Project.", "type": "http" }, "http": { "method": "PATCH", "url": "https://example.com/polarion/rest/v1/projects/:projectId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The Project ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Project." }, { "info": { "name": "Deletes the specified Project.", "type": "http" }, "http": { "method": "DELETE", "url": "https://example.com/polarion/rest/v1/projects/:projectId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The Project ID." } ] }, "docs": "Deletes the specified Project." }, { "info": { "name": "Moves project to a different location", "type": "http" }, "http": { "method": "POST", "url": "https://example.com/polarion/rest/v1/projects/:projectId/actions/moveProject", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The Project ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves project to a different location" }, { "info": { "name": "Unmarks the Project.", "type": "http" }, "http": { "method": "POST", "url": "https://example.com/polarion/rest/v1/projects/:projectId/actions/unmarkProject", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The Project ID." } ] }, "docs": "Unmarks the Project." }, { "info": { "name": "Returns a list of Test Parameter Definitions for the specified Project.", "type": "http" }, "http": { "method": "GET", "url": "https://example.com/polarion/rest/v1/projects/:projectId/testparameterdefinitions", "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." } ] }, "docs": "Returns a list of Test Parameter Definitions for the specified Project." }, { "info": { "name": "Creates a list of Test Parameter Definitions for the specified Project.", "type": "http" }, "http": { "method": "POST", "url": "https://example.com/polarion/rest/v1/projects/:projectId/testparameterdefinitions", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The Project ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a list of Test Parameter Definitions for the specified Project." }, { "info": { "name": "Deletes a list of Test Parameter Definitions for the specified Project.", "type": "http" }, "http": { "method": "DELETE", "url": "https://example.com/polarion/rest/v1/projects/:projectId/testparameterdefinitions", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The Project ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a list of Test Parameter Definitions for the specified Project." }, { "info": { "name": "Returns the specified Test Parameter Definition for the specified Project.", "type": "http" }, "http": { "method": "GET", "url": "https://example.com/polarion/rest/v1/projects/:projectId/testparameterdefinitions/:testParamId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The Project ID." }, { "name": "testParamId", "value": "", "type": "path", "description": "The Test Parameter." }, { "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." } ] }, "docs": "Returns the specified Test Parameter Definition for the specified Project." }, { "info": { "name": "Deletes the specified Test Parameter Definition for the specified Project.", "type": "http" }, "http": { "method": "DELETE", "url": "https://example.com/polarion/rest/v1/projects/:projectId/testparameterdefinitions/:testParamId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The Project ID." }, { "name": "testParamId", "value": "", "type": "path", "description": "The Test Parameter." } ] }, "docs": "Deletes the specified Test Parameter Definition for the specified Project." }, { "info": { "name": "Creates a new Project", "type": "http" }, "http": { "method": "POST", "url": "https://example.com/polarion/rest/v1/projects/actions/createProject", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Project" }, { "info": { "name": "Marks the Project.", "type": "http" }, "http": { "method": "POST", "url": "https://example.com/polarion/rest/v1/projects/actions/markProject", "body": { "type": "json", "data": "{}" } }, "docs": "Marks the Project." } ] } ], "bundled": true }