{
"opencollection": "1.0.0",
"info": {
"name": "Polarion REST Account Plans API",
"version": "v1"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Plans",
"type": "folder"
},
"items": [
{
"info": {
"name": "Returns a list of Plans.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://example.com/polarion/rest/v1/projects/:projectId/plans",
"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."
},
{
"name": "templates",
"value": "",
"type": "query",
"description": "If set to true, only templates will be returned, otherwise only actual instances will be returned."
}
]
},
"docs": "Returns a list of Plans."
},
{
"info": {
"name": "Creates a list of Plans.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://example.com/polarion/rest/v1/projects/:projectId/plans",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a list of Plans."
},
{
"info": {
"name": "Deletes a list of Plans.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://example.com/polarion/rest/v1/projects/:projectId/plans",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Deletes a list of Plans."
},
{
"info": {
"name": "Returns the specified Plan.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://example.com/polarion/rest/v1/projects/:projectId/plans/:planId",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID."
},
{
"name": "planId",
"value": "",
"type": "path",
"description": "The Plan 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 Plan."
},
{
"info": {
"name": "Updates the specified Plan.",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://example.com/polarion/rest/v1/projects/:projectId/plans/:planId",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID."
},
{
"name": "planId",
"value": "",
"type": "path",
"description": "The Plan ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the specified Plan."
},
{
"info": {
"name": "Deletes the specified Plan.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://example.com/polarion/rest/v1/projects/:projectId/plans/:planId",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID."
},
{
"name": "planId",
"value": "",
"type": "path",
"description": "The Plan ID."
}
]
},
"docs": "Deletes the specified Plan."
},
{
"info": {
"name": "Returns a list of Plan Relationships.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://example.com/polarion/rest/v1/projects/:projectId/plans/:planId/relationships/:relationshipId",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID."
},
{
"name": "planId",
"value": "",
"type": "path",
"description": "The Plan 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 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 Plan Relationships."
},
{
"info": {
"name": "Creates the specific Relationships for the Plan.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://example.com/polarion/rest/v1/projects/:projectId/plans/:planId/relationships/:relationshipId",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID."
},
{
"name": "planId",
"value": "",
"type": "path",
"description": "The Plan ID."
},
{
"name": "relationshipId",
"value": "",
"type": "path",
"description": "The Relationship ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates the specific Relationships for the Plan."
},
{
"info": {
"name": "Updates a list of Plan Relationships.",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://example.com/polarion/rest/v1/projects/:projectId/plans/:planId/relationships/:relationshipId",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID."
},
{
"name": "planId",
"value": "",
"type": "path",
"description": "The Plan ID."
},
{
"name": "relationshipId",
"value": "",
"type": "path",
"description": "The Relationship ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a list of Plan Relationships."
},
{
"info": {
"name": "Removes the specific Relationship from the Plan.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://example.com/polarion/rest/v1/projects/:projectId/plans/:planId/relationships/:relationshipId",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The Project ID."
},
{
"name": "planId",
"value": "",
"type": "path",
"description": "The Plan ID."
},
{
"name": "relationshipId",
"value": "",
"type": "path",
"description": "The Relationship ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Removes the specific Relationship from the Plan."
}
]
}
],
"bundled": true
}