0

Get field configuration items

by
Published Nov 2, 2023

Returns a [paginated](#pagination) list of all fields for a configuration. Only the fields from configurations used in company-managed (classic) projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Script jira
  • Submitted by hugo697 Typescript (fetch-only)
    Created 525 days ago
    1
    type Jira = {
    2
      username: string;
    3
      password: string;
    4
      domain: string;
    5
    };
    6
    /**
    7
     * Get field configuration items
    8
     * Returns a [paginated](#pagination) list of all fields for a configuration.
    9
    
    
    10
    Only the fields from configurations used in company-managed (classic) projects are returned.
    11
    
    
    12
    **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
    13
     */
    14
    export async function main(
    15
      auth: Jira,
    16
      id: string,
    17
      startAt: string | undefined,
    18
      maxResults: string | undefined
    19
    ) {
    20
      const url = new URL(
    21
        `https://${auth.domain}.atlassian.net/rest/api/2/fieldconfiguration/${id}/fields`
    22
      );
    23
      for (const [k, v] of [
    24
        ["startAt", startAt],
    25
        ["maxResults", maxResults],
    26
      ]) {
    27
        if (v !== undefined && v !== "") {
    28
          url.searchParams.append(k, v);
    29
        }
    30
      }
    31
      const response = await fetch(url, {
    32
        method: "GET",
    33
        headers: {
    34
          Authorization: "Basic " + btoa(`${auth.username}:${auth.password}`),
    35
        },
    36
        body: undefined,
    37
      });
    38
      if (!response.ok) {
    39
        const text = await response.text();
    40
        throw new Error(`${response.status} ${text}`);
    41
      }
    42
      return await response.json();
    43
    }
    44