{
  "opencollection": "1.0.0",
  "info": {
    "name": "Atlassian Admin Account Project Components API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Project Components",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Atlassian Get Component",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/component/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the component."
              }
            ]
          },
          "docs": "Returns a component.<br><br>This operation can be accessed anonymously.<br><br>**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for project containing the component."
        },
        {
          "info": {
            "name": "Atlassian Update Component",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/rest/api/3/component/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the component."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a component. Any fields included in the request are overwritten. If `leadAccountId` is an empty string (\"\") the component lead is removed.<br><br>This operation can be accessed anonymously.<br><br>**[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the component or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Delete Component",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/rest/api/3/component/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the component."
              },
              {
                "name": "moveIssuesTo",
                "value": "",
                "type": "query",
                "description": "The ID of the component to replace the deleted component. If this value is null no replacement is made."
              }
            ]
          },
          "docs": "Deletes a component.<br><br>This operation can be accessed anonymously.<br><br>**[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the component or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Get Component Issues Count",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/component/:id/relatedIssueCounts",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the component."
              }
            ]
          },
          "docs": "Returns the counts of issues assigned to the component.<br><br>This operation can be accessed anonymously.<br><br>**Deprecation notice:** The required OAuth 2.0 scopes will be updated on June 15, 2024.<br><br> *  **Classic**: `read:jira-work`<br> *  **Granular**: `read:field:jira`, `read:project.component:jira`<br><br>**[Permissions](#permissions) required:** None."
        },
        {
          "info": {
            "name": "Atlassian Get Project Components Paginated",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey/component",
            "params": [
              {
                "name": "projectIdOrKey",
                "value": "",
                "type": "path",
                "description": "The project ID or project key (case sensitive)."
              },
              {
                "name": "startAt",
                "value": "",
                "type": "query",
                "description": "The index of the first item to return in a page of results (page offset)."
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return per page."
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "[Order](#ordering) the results by a field:\n\n *  `description` Sorts by the component description.\n *  `issueCount` Sorts by the count of issues associated with the component.\n *  `lead` Sorts by the user key of the component's project lead.\n *  `name` Sorts by component name."
              },
              {
                "name": "componentSource",
                "value": "",
                "type": "query",
                "description": "The source of the components to return. Can be `jira` (default), `compass` or `auto`. When `auto` is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to `jira`."
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "Filter the results using a literal string. Components with a matching `name` or `description` are returned (case insensitive)."
              }
            ]
          },
          "docs": "Returns a [paginated](#pagination) list of all components in a project. See the [Get project components](#api-rest-api-3-project-projectIdOrKey-components-get) resource if you want to get a full list of versions without pagination.<br><br>If your project uses Compass components, this API will return a list of Compass components that are linked to issues in that project.<br><br>This operation can be accessed anonymously.<br><br>**[Permissions](#permissions) required:** *Browse Projects* [project "
        },
        {
          "info": {
            "name": "Atlassian Get Project Components",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey/components",
            "params": [
              {
                "name": "projectIdOrKey",
                "value": "",
                "type": "path",
                "description": "The project ID or project key (case sensitive)."
              },
              {
                "name": "componentSource",
                "value": "",
                "type": "query",
                "description": "The source of the components to return. Can be `jira` (default), `compass` or `auto`. When `auto` is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to `jira`."
              }
            ]
          },
          "docs": "Returns all components in a project. See the [Get project components paginated](#api-rest-api-3-project-projectIdOrKey-component-get) resource if you want to get a full list of components with pagination.<br><br>If your project uses Compass components, this API will return a paginated list of Compass components that are linked to issues in that project.<br><br>This operation can be accessed anonymously.<br><br>**[Permissions](#permissions) required:** *Browse Projects* [project permission](https"
        },
        {
          "info": {
            "name": "Atlassian Find Components For Projects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/component",
            "params": [
              {
                "name": "projectIdsOrKeys",
                "value": "",
                "type": "query",
                "description": "The project IDs and/or project keys (case sensitive)."
              },
              {
                "name": "startAt",
                "value": "",
                "type": "query",
                "description": "The index of the first item to return in a page of results (page offset)."
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return per page."
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "[Order](#ordering) the results by a field:\n\n *  `description` Sorts by the component description.\n *  `name` Sorts by component name."
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "Filter the results using a literal string. Components with a matching `name` or `description` are returned (case insensitive)."
              }
            ]
          },
          "docs": "Returns a [paginated](#pagination) list of all components in a project, including global (Compass) components when applicable.<br><br>This operation can be accessed anonymously.<br><br>**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project."
        },
        {
          "info": {
            "name": "Atlassian Create Component",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/rest/api/3/component",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a component. Use components to provide containers for issues within a project. Use components to provide containers for issues within a project.<br><br>This operation can be accessed anonymously.<br><br>**[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the component is created or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        }
      ]
    }
  ],
  "bundled": true
}