{
  "info": {
    "_postman_id": "4b15f80e-05c2-4bb2-a86e-0b31741c4d32",
    "name": "Capacity Planning Public REST API",
    "description": "Public REST endpoints for capacity-planning-service, served under https://api.atlassian.com/ex/capacity-planning/{cloudId}/v1.",
    "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json"
  },
  "item": [
    {
      "name": "Non-Project Work Items",
      "description": "Manage non-project work items",
      "item": [
        {
          "name": "List non-project work items",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}non-project-work-items",
              "query": [
                {
                  "key": "query",
                  "value": "{{query}}",
                  "disabled": true,
                  "description": "Case-insensitive name filter"
                },
                {
                  "key": "first",
                  "value": "{{first}}",
                  "disabled": true,
                  "description": "Forward page size, between 1 and 100"
                },
                {
                  "key": "after",
                  "value": "{{after}}",
                  "disabled": true,
                  "description": "Cursor for forward pagination"
                },
                {
                  "key": "last",
                  "value": "{{last}}",
                  "disabled": true,
                  "description": "Backward page size, between 1 and 100"
                },
                {
                  "key": "before",
                  "value": "{{before}}",
                  "disabled": true,
                  "description": "Cursor for backward pagination"
                }
              ],
              "variable": []
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Lists non-project work items, optionally filtered by name, with cursor-based pagination.",
            "auth": {
              "type": "basic",
              "basic": {
                "username": "{{username}}",
                "password": "{{apiToken}}"
              }
            }
          },
          "response": []
        },
        {
          "name": "Create a non-project work item",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}non-project-work-items",
              "query": [],
              "variable": []
            },
            "method": "POST",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "description": "Creates a non-project work item.",
            "auth": {
              "type": "basic",
              "basic": {
                "username": "{{username}}",
                "password": "{{apiToken}}"
              }
            },
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        },
        {
          "name": "Get a non-project work item by id",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}non-project-work-items/:id",
              "query": [],
              "variable": [
                {
                  "key": "id",
                  "value": "{{id}}",
                  "description": "Server-allocated UUID of the non-project work item",
                  "disabled": false
                }
              ]
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Retrieves a single non-project work item by its server-allocated UUID.",
            "auth": {
              "type": "basic",
              "basic": {
                "username": "{{username}}",
                "password": "{{apiToken}}"
              }
            }
          },
          "response": []
        },
        {
          "name": "Update a non-project work item",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}non-project-work-items/:id",
              "query": [],
              "variable": [
                {
                  "key": "id",
                  "value": "{{id}}",
                  "description": "Server-allocated UUID of the non-project work item",
                  "disabled": false
                }
              ]
            },
            "method": "PUT",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Updates the mutable fields (name) of an existing non-project work item.",
            "auth": {
              "type": "basic",
              "basic": {
                "username": "{{username}}",
                "password": "{{apiToken}}"
              }
            },
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        }
      ]
    },
    {
      "name": "Contributor Work Associations",
      "description": "Manage associations between contributors and work items",
      "item": [
        {
          "name": "Create contributor work associations",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}contributor-work-associations",
              "query": [],
              "variable": []
            },
            "method": "POST",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Creates associations between contributors and work items. If an association already exists between the specified contributor and work item, it is returned unchanged.",
            "auth": {
              "type": "basic",
              "basic": {
                "username": "{{username}}",
                "password": "{{apiToken}}"
              }
            },
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        },
        {
          "name": "Get work associations for a contributor",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}contributor-work-associations/by-contributor",
              "query": [
                {
                  "key": "contributorDataId",
                  "value": "{{contributorDataId}}",
                  "disabled": false,
                  "description": "ARI of the contributor"
                },
                {
                  "key": "first",
                  "value": "{{first}}",
                  "disabled": true,
                  "description": "Maximum number of results to return (forward pagination)"
                },
                {
                  "key": "after",
                  "value": "{{after}}",
                  "disabled": true,
                  "description": "Cursor for forward pagination"
                },
                {
                  "key": "last",
                  "value": "{{last}}",
                  "disabled": true,
                  "description": "Maximum number of results to return (backward pagination)"
                },
                {
                  "key": "before",
                  "value": "{{before}}",
                  "disabled": true,
                  "description": "Cursor for backward pagination"
                }
              ],
              "variable": []
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Retrieves work items associated with a specific contributor, with cursor-based pagination. Use first/after for forward pagination or last/before for backward pagination.",
            "auth": {
              "type": "basic",
              "basic": {
                "username": "{{username}}",
                "password": "{{apiToken}}"
              }
            }
          },
          "response": []
        },
        {
          "name": "Get contributor associations for a work item",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}contributor-work-associations/by-work",
              "query": [
                {
                  "key": "workDataId",
                  "value": "{{workDataId}}",
                  "disabled": false,
                  "description": "ARI of the work item"
                },
                {
                  "key": "first",
                  "value": "{{first}}",
                  "disabled": true,
                  "description": "Maximum number of results to return (forward pagination)"
                },
                {
                  "key": "after",
                  "value": "{{after}}",
                  "disabled": true,
                  "description": "Cursor for forward pagination"
                },
                {
                  "key": "last",
                  "value": "{{last}}",
                  "disabled": true,
                  "description": "Maximum number of results to return (backward pagination)"
                },
                {
                  "key": "before",
                  "value": "{{before}}",
                  "disabled": true,
                  "description": "Cursor for backward pagination"
                }
              ],
              "variable": []
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Retrieves contributors associated with a specific work item, with cursor-based pagination. Use first/after for forward pagination or last/before for backward pagination.",
            "auth": {
              "type": "basic",
              "basic": {
                "username": "{{username}}",
                "password": "{{apiToken}}"
              }
            }
          },
          "response": []
        },
        {
          "name": "Delete contributor work associations",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}contributor-work-associations:delete",
              "query": [],
              "variable": []
            },
            "method": "POST",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Deletes associations between contributors and work items.",
            "auth": {
              "type": "basic",
              "basic": {
                "username": "{{username}}",
                "password": "{{apiToken}}"
              }
            },
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        }
      ]
    },
    {
      "name": "Contributions",
      "description": "Manage time-allocation contributions for contributor-work pairs",
      "item": [
        {
          "name": "Get contributions for a contributor-work pair",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}contributions",
              "query": [
                {
                  "key": "contributorDataId",
                  "value": "{{contributorDataId}}",
                  "disabled": false,
                  "description": "ARI of the contributor (required)"
                },
                {
                  "key": "workDataId",
                  "value": "{{workDataId}}",
                  "disabled": false,
                  "description": "ARI of the work item (required)"
                },
                {
                  "key": "startDate",
                  "value": "{{startDate}}",
                  "disabled": false,
                  "description": "Start date of the query window (ISO-8601, required)"
                },
                {
                  "key": "endDate",
                  "value": "{{endDate}}",
                  "disabled": false,
                  "description": "End date of the query window (ISO-8601, required). The window from startDate to endDate must not exceed 2 years."
                },
                {
                  "key": "valueType",
                  "value": "{{valueType}}",
                  "disabled": true,
                  "description": "Value type for contribution amounts (default: HOURS)"
                }
              ],
              "variable": []
            },
            "method": "GET",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Returns the time-based allocation breakdown for a specific contributor and work item within the given date range. The query window must not exceed 2 years. Results are split into weekly time periods.",
            "auth": {
              "type": "basic",
              "basic": {
                "username": "{{username}}",
                "password": "{{apiToken}}"
              }
            }
          },
          "response": []
        },
        {
          "name": "Create or update contributions",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}contributions",
              "query": [],
              "variable": []
            },
            "method": "POST",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Sets the allocation for one or more contributor-work pairs within specified date ranges (max 100 per call). A single contribution must not span more than 90 days, the start date must not be more than 2 years in the past, and the end date must not be more than 2 years in the future. If a contribution already exists for the same contributor, work item, and date range it is replaced with the new value; otherwise a new contribution is created.",
            "auth": {
              "type": "basic",
              "basic": {
                "username": "{{username}}",
                "password": "{{apiToken}}"
              }
            },
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        },
        {
          "name": "Clear contributions",
          "request": {
            "url": {
              "protocol": "{{protocol}}",
              "host": "{{host}}",
              "path": "{{basePath}}contributions:clear",
              "query": [],
              "variable": []
            },
            "method": "POST",
            "header": [
              {
                "description": "",
                "disabled": false,
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "description": "",
                "disabled": false,
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "description": "Removes the allocation for the specified contributor-work pairs and date ranges (max 100 per call). Each clear key must have a start date that is not after its end date. After this call, the affected date ranges will return a zero allocation. The response echoes back the keys that were cleared.",
            "auth": {
              "type": "basic",
              "basic": {
                "username": "{{username}}",
                "password": "{{apiToken}}"
              }
            },
            "body": {
              "mode": "raw",
              "raw": ""
            }
          },
          "response": []
        }
      ]
    }
  ],
  "variable": [
    {
      "key": "protocol",
      "name": "Protocol",
      "description": "The HTTP Protocol that should be used for this REST API.",
      "type": "string",
      "value": "https"
    },
    {
      "key": "host",
      "name": "Host",
      "description": "The HTTP host that should be used for this REST API.",
      "type": "string",
      "value": "api.atlassian.com"
    },
    {
      "key": "basePath",
      "name": "Base Path",
      "description": "The path, after the host, of the base of the REST API.",
      "type": "string",
      "value": "ex/capacity-planning/%7BcloudId%7D/v1/"
    }
  ]
}