Class IssueFieldConfigurationsService

This resource represents issue field configurations. Use it to get, set, and delete field configurations and field configuration schemes.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations

Hierarchy

CommonHttpService
- IssueFieldConfigurationsService

Index

Constructors

constructor

Methods

assignFieldConfigurationSchemeToProject createFieldConfiguration createFieldConfigurationScheme deleteFieldConfiguration deleteFieldConfigurationScheme getAllFieldConfigurations getAllFieldConfigurationSchemes getFieldConfigurationItems getFieldConfigurationSchemeMappings getFieldConfigurationSchemeProjectMapping removeIssueTypesFromGlobalFieldConfigurationScheme setFieldConfigurationSchemeMapping updateFieldConfiguration updateFieldConfigurationItems updateFieldConfigurationScheme initialize

Constructors

constructor

new IssueFieldConfigurationsService(getClientInstance): IssueFieldConfigurationsService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns IssueFieldConfigurationsService
Inherited from CommonHttpService.constructor

Methods

assignFieldConfigurationSchemeToProject

assignFieldConfigurationSchemeToProject(params): Promise<void>
Assigns a field configuration scheme to a project. If the field configuration scheme ID is null, the operation assigns the default field configuration scheme.

Field configuration schemes can only be assigned to classic projects.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  fieldConfigurationSchemeProjectAssociation: FieldConfigurationSchemeProjectAssociation;
  }
  - fieldConfigurationSchemeProjectAssociation: FieldConfigurationSchemeProjectAssociation
    Example
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/fieldconfigurationscheme/project @scopes-current manage:jira-configuration @scopes-beta write:field-configuration-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-project-put

createFieldConfiguration

createFieldConfiguration(params): Promise<FieldConfiguration>
Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional.

This operation can only create configurations for use in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  fieldConfigurationDetails: FieldConfigurationDetails;
  }
  - fieldConfigurationDetails: FieldConfigurationDetails
    Example
Returns Promise<FieldConfiguration>
Returned if the request is successful.

example:
```
{
  "description": "My field configuration description",
  "id": 10001,
  "name": "My Field Configuration"
}
```
Path
POST /rest/api/3/fieldconfiguration @scopes-current manage:jira-configuration @scopes-beta read:field-configuration:jira, write:field-configuration:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-post

createFieldConfigurationScheme

createFieldConfigurationScheme(params): Promise<FieldConfigurationScheme>
Creates a field configuration scheme.

This operation can only create field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  updateFieldConfigurationSchemeDetails: UpdateFieldConfigurationSchemeDetails;
  }
  - updateFieldConfigurationSchemeDetails: UpdateFieldConfigurationSchemeDetails
    The details of the field configuration scheme.
    
    Example
Returns Promise<FieldConfigurationScheme>
Returned if the request is successful.

example:
```
{
  "description": "We can use this one for software projects.",
  "id": "10002",
  "name": "Field Configuration Scheme for software related projects"
}
```
Path
POST /rest/api/3/fieldconfigurationscheme @scopes-current manage:jira-configuration @scopes-beta write:field-configuration-scheme:jira, read:field-configuration-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-post

deleteFieldConfiguration

deleteFieldConfiguration(params): Promise<void>
Deletes a field configuration.

This operation can only delete configurations used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the field configuration.
Returns Promise<void>
Returned if the request is successful.

Path
DELETE /rest/api/3/fieldconfiguration/{id} @scopes-current manage:jira-configuration @scopes-beta delete:field-configuration:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-id-delete

deleteFieldConfigurationScheme

deleteFieldConfigurationScheme(params): Promise<void>
Deletes a field configuration scheme.

This operation can only delete field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the field configuration scheme.
Returns Promise<void>
Returned if the request is successful.

Path
DELETE /rest/api/3/fieldconfigurationscheme/{id} @scopes-current manage:jira-configuration @scopes-beta delete:field-configuration-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-id-delete

getAllFieldConfigurations

getAllFieldConfigurations(params?): Promise<PageBeanFieldConfigurationDetails>
Returns a paginated list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria:
- a list of field configuration item IDs.
- whether the field configuration is a default.
- whether the field configuration name or description contains a query string.
Only field configurations used in company-managed (classic) projects are returned.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      id?: number[];
      isDefault?: boolean;
      maxResults?: number;
      query?: string;
      startAt?: number;
  } = {}
  - Optionalid?: number[]
    The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
  - OptionalisDefault?: boolean
    If true returns default field configurations only.
  - OptionalmaxResults?: number
    The maximum number of items to return per page.
  - Optionalquery?: string
    The query string used to match against field configuration names and descriptions.
  - OptionalstartAt?: number
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanFieldConfigurationDetails>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 50,
  "startAt": 0,
  "total": 2,
  "values": [
    {
      "id": 10000,
      "name": "Default Field Configuration",
      "description": "The default field configuration description",
      "isDefault": true
    },
    {
      "id": 10001,
      "name": "My Field Configuration",
      "description": "My field configuration description"
    }
  ]
}
```
Path
GET /rest/api/3/fieldconfiguration @scopes-current manage:jira-configuration @scopes-beta read:field-configuration:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-get

getAllFieldConfigurationSchemes

getAllFieldConfigurationSchemes(params?): Promise<PageBeanFieldConfigurationScheme>
Returns a paginated list of field configuration schemes.

Only field configuration schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      id?: number[];
      maxResults?: number;
      startAt?: number;
  } = {}
  - Optionalid?: number[]
    The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
  - OptionalmaxResults?: number
    The maximum number of items to return per page.
  - OptionalstartAt?: number
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanFieldConfigurationScheme>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 10,
  "startAt": 0,
  "total": 3,
  "values": [
    {
      "id": "10000",
      "name": "Field Configuration Scheme for Bugs",
      "description": "This field configuration scheme is for bugs only."
    },
    {
      "id": "10001",
      "name": "Field Configuration Scheme for software related projects",
      "description": "We can use this one for software projects."
    },
    {
      "id": "10002",
      "name": "Field Configuration Scheme for Epics",
      "description": "Use this one for Epic issue type."
    }
  ]
}
```
Path
GET /rest/api/3/fieldconfigurationscheme @scopes-current manage:jira-configuration @scopes-beta read:field-configuration-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-get

getFieldConfigurationItems

getFieldConfigurationItems(params): Promise<PageBeanFieldConfigurationItem>
Returns a paginated list of all fields for a configuration.

Only the fields from configurations used in company-managed (classic) projects are returned.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      id: number;
      maxResults?: number;
      startAt?: number;
  }
  - id: number
    The ID of the field configuration.
  - OptionalmaxResults?: number
    The maximum number of items to return per page.
  - OptionalstartAt?: number
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanFieldConfigurationItem>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 50,
  "startAt": 0,
  "total": 2,
  "values": [
    {
      "description": "For example operating system, software platform and/or hardware specifications (include as appropriate for the issue).",
      "id": "environment",
      "isHidden": false,
      "isRequired": false
    },
    {
      "id": "description",
      "isHidden": false,
      "isRequired": false
    }
  ]
}
```
Path
GET /rest/api/3/fieldconfiguration/{id}/fields @scopes-current manage:jira-configuration @scopes-beta read:field-configuration:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-id-fields-get

getFieldConfigurationSchemeMappings

getFieldConfigurationSchemeMappings(params?): Promise<PageBeanFieldConfigurationIssueTypeItem>
Returns a paginated list of field configuration issue type items.

Only items used in classic projects are returned.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      fieldConfigurationSchemeId?: number[];
      maxResults?: number;
      startAt?: number;
  } = {}
  - OptionalfieldConfigurationSchemeId?: number[]
    The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand: fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001.
  - OptionalmaxResults?: number
    The maximum number of items to return per page.
  - OptionalstartAt?: number
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanFieldConfigurationIssueTypeItem>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 100,
  "startAt": 0,
  "total": 5,
  "values": [
    {
      "fieldConfigurationSchemeId": "10020",
      "issueTypeId": "10000",
      "fieldConfigurationId": "10010"
    },
    {
      "fieldConfigurationSchemeId": "10020",
      "issueTypeId": "10001",
      "fieldConfigurationId": "10010"
    },
    {
      "fieldConfigurationSchemeId": "10021",
      "issueTypeId": "10002",
      "fieldConfigurationId": "10000"
    },
    {
      "fieldConfigurationSchemeId": "10022",
      "issueTypeId": "default",
      "fieldConfigurationId": "10011"
    },
    {
      "fieldConfigurationSchemeId": "10023",
      "issueTypeId": "default",
      "fieldConfigurationId": "10000"
    }
  ]
}
```
Path
GET /rest/api/3/fieldconfigurationscheme/mapping @scopes-current manage:jira-configuration @scopes-beta read:field-configuration-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-mapping-get

getFieldConfigurationSchemeProjectMapping

getFieldConfigurationSchemeProjectMapping(params): Promise<PageBeanFieldConfigurationSchemeProjects>
Returns a paginated list of field configuration schemes and, for each scheme, a list of the projects that use it.

The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme.

Only field configuration schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      maxResults?: number;
      projectId: number[];
      startAt?: number;
  }
  - OptionalmaxResults?: number
    The maximum number of items to return per page.
  - projectId: number[]
    The list of project IDs. To include multiple projects, separate IDs with ampersand: projectId=10000&projectId=10001.
  - OptionalstartAt?: number
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanFieldConfigurationSchemeProjects>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 50,
  "startAt": 0,
  "total": 5,
  "values": [
    {
      "projectIds": [
        "10",
        "11"
      ]
    },
    {
      "fieldConfigurationScheme": {
        "id": "10002",
        "name": "Field Configuration Scheme for software related projects",
        "description": "We can use this one for software projects."
      },
      "projectIds": [
        "12",
        "13",
        "14"
      ]
    }
  ]
}
```
Path
GET /rest/api/3/fieldconfigurationscheme/project @scopes-current manage:jira-configuration @scopes-beta read:field-configuration-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-project-get

removeIssueTypesFromGlobalFieldConfigurationScheme

removeIssueTypesFromGlobalFieldConfigurationScheme(params): Promise<void>
Removes issue types from the field configuration scheme.

This operation can only modify field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: number;
  issueTypeIdsToRemove: IssueTypeIdsToRemove;
  }
  - id: number
    The ID of the field configuration scheme.
  - issueTypeIdsToRemove: IssueTypeIdsToRemove
    The issue type IDs to remove.
    
    Example
Returns Promise<void>
Returned if the request is successful.

Path
POST /rest/api/3/fieldconfigurationscheme/{id}/mapping/delete @scopes-current manage:jira-configuration @scopes-beta write:field-configuration-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-id-mapping-delete-post

setFieldConfigurationSchemeMapping

setFieldConfigurationSchemeMapping(params): Promise<void>
Assigns issue types to field configurations on field configuration scheme.

This operation can only modify field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  associateFieldConfigurationsWithIssueTypesRequest: AssociateFieldConfigurationsWithIssueTypesRequest;
  id: number;
  }
  - associateFieldConfigurationsWithIssueTypesRequest: AssociateFieldConfigurationsWithIssueTypesRequest
    Example
  - id: number
    The ID of the field configuration scheme.
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/fieldconfigurationscheme/{id}/mapping @scopes-current manage:jira-configuration @scopes-beta write:field-configuration-scheme:jira, read:field-configuration-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-id-mapping-put

updateFieldConfiguration

updateFieldConfiguration(params): Promise<void>
Updates a field configuration. The name and the description provided in the request override the existing values.

This operation can only update configurations used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  fieldConfigurationDetails: FieldConfigurationDetails;
  id: number;
  }
  - fieldConfigurationDetails: FieldConfigurationDetails
    Example
  - id: number
    The ID of the field configuration.
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/fieldconfiguration/{id} @scopes-current manage:jira-configuration @scopes-beta write:field-configuration:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-id-put

updateFieldConfigurationItems

updateFieldConfigurationItems(params): Promise<void>
Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values.

This operation can only update field configurations used in company-managed (classic) projects.

The operation can set the renderer for text fields to the default text renderer (text-renderer) or wiki style renderer (wiki-renderer). However, the renderer cannot be updated for fields using the autocomplete renderer (autocomplete-renderer).

Permissions required: Administer Jira global permission.
Parameters
- params: {
  fieldConfigurationItemsDetails: FieldConfigurationItemsDetails;
  id: number;
  }
  - fieldConfigurationItemsDetails: FieldConfigurationItemsDetails
    Example
  - id: number
    The ID of the field configuration.
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/fieldconfiguration/{id}/fields @scopes-current manage:jira-configuration @scopes-beta write:field-configuration:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-id-fields-put

updateFieldConfigurationScheme

updateFieldConfigurationScheme(params): Promise<void>
Updates a field configuration scheme.

This operation can only update field configuration schemes used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: number;
  updateFieldConfigurationSchemeDetails: UpdateFieldConfigurationSchemeDetails;
  }
  - id: number
    The ID of the field configuration scheme.
  - updateFieldConfigurationSchemeDetails: UpdateFieldConfigurationSchemeDetails
    The details of the field configuration scheme.
    
    Example
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/fieldconfigurationscheme/{id} @scopes-current manage:jira-configuration @scopes-beta write:field-configuration-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-id-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class IssueFieldConfigurationsService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssueFieldConfigurationsService

Methods

assignFieldConfigurationSchemeToProject

Parameters

fieldConfigurationSchemeProjectAssociation: FieldConfigurationSchemeProjectAssociation

Example

Returns Promise<void>

Path

See

createFieldConfiguration

Parameters

fieldConfigurationDetails: FieldConfigurationDetails

Example

Returns Promise<FieldConfiguration>

Path

See

createFieldConfigurationScheme

Parameters

updateFieldConfigurationSchemeDetails: UpdateFieldConfigurationSchemeDetails

Example

Returns Promise<FieldConfigurationScheme>

Path

See

deleteFieldConfiguration

Parameters

id: number

Returns Promise<void>

Path

See

deleteFieldConfigurationScheme

Parameters

id: number

Returns Promise<void>

Path

See

getAllFieldConfigurations

Parameters

Optionalid?: number[]

OptionalisDefault?: boolean

OptionalmaxResults?: number

Optionalquery?: string

OptionalstartAt?: number

Returns Promise<PageBeanFieldConfigurationDetails>

Path

See

getAllFieldConfigurationSchemes

Parameters

Optionalid?: number[]

OptionalmaxResults?: number

OptionalstartAt?: number

Returns Promise<PageBeanFieldConfigurationScheme>

Path

See

getFieldConfigurationItems

Parameters

id: number

OptionalmaxResults?: number

OptionalstartAt?: number

Returns Promise<PageBeanFieldConfigurationItem>

Path

See

getFieldConfigurationSchemeMappings

Parameters

OptionalfieldConfigurationSchemeId?: number[]

OptionalmaxResults?: number

OptionalstartAt?: number

Returns Promise<PageBeanFieldConfigurationIssueTypeItem>

Path

See

getFieldConfigurationSchemeProjectMapping

`Optional`id?: number[]

`Optional`isDefault?: boolean

`Optional`maxResults?: number

`Optional`query?: string

`Optional`startAt?: number

`Optional`id?: number[]

`Optional`maxResults?: number

`Optional`startAt?: number

`Optional`maxResults?: number

`Optional`startAt?: number

`Optional`fieldConfigurationSchemeId?: number[]

`Optional`maxResults?: number

`Optional`startAt?: number

`Optional`maxResults?: number

`Optional`startAt?: number

`Protected` `Static`initialize