{
  "opencollection": "1.0.0",
  "info": {
    "name": "Atlassian Admin Account Screens API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Screens",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Atlassian Get Screens For A Field",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/field/:fieldId/screens",
            "params": [
              {
                "name": "fieldId",
                "value": "",
                "type": "path",
                "description": "The ID of the field to return screens for."
              },
              {
                "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": "expand",
                "value": "",
                "type": "query",
                "description": "Use [expand](#expansion) to include additional information about screens in the response. This parameter accepts `tab` which returns details about the screen tabs the field is used in."
              }
            ]
          },
          "docs": "Returns a [paginated](#pagination) list of the screens a field is used in.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Add Field To Default Screen",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/rest/api/3/screens/addToDefault/:fieldId",
            "params": [
              {
                "name": "fieldId",
                "value": "",
                "type": "path",
                "description": "The ID of the field."
              }
            ]
          },
          "docs": "Adds a field to the default tab of the default screen.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Update Screen",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/rest/api/3/screens/:screenId",
            "params": [
              {
                "name": "screenId",
                "value": "",
                "type": "path",
                "description": "The ID of the screen."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a screen. Only screens used in classic projects can be updated.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Delete Screen",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/rest/api/3/screens/:screenId",
            "params": [
              {
                "name": "screenId",
                "value": "",
                "type": "path",
                "description": "The ID of the screen."
              }
            ]
          },
          "docs": "Deletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft.<br><br>Only screens used in classic projects can be deleted."
        },
        {
          "info": {
            "name": "Atlassian Get Available Screen Fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/screens/:screenId/availableFields",
            "params": [
              {
                "name": "screenId",
                "value": "",
                "type": "path",
                "description": "The ID of the screen."
              }
            ]
          },
          "docs": "Returns the fields that can be added to a tab on a screen.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Get Screens",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/screens",
            "params": [
              {
                "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": "id",
                "value": "",
                "type": "query",
                "description": "The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`."
              },
              {
                "name": "queryString",
                "value": "",
                "type": "query",
                "description": "String used to perform a case-insensitive partial match with screen name."
              },
              {
                "name": "scope",
                "value": "",
                "type": "query",
                "description": "The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, `scope=GLOBAL&scope=PROJECT`."
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "[Order](#ordering) the results by a field:\n\n *  `id` Sorts by screen ID.\n *  `name` Sorts by screen name."
              }
            ]
          },
          "docs": "Returns a [paginated](#pagination) list of all screens or those specified by one or more screen IDs.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Create Screen",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/rest/api/3/screens",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a screen with a default field tab.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        }
      ]
    }
  ],
  "bundled": true
}