Class LabelsService

This resource represents available labels. Use it to get available labels for the global label field.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-labels

Hierarchy

CommonHttpService
- LabelsService

Index

Constructors

Methods

getAllLabels initialize

Constructors

constructor

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

Methods

getAllLabels

getAllLabels(params?): Promise<PageBeanString>
Returns a paginated list of labels.
Parameters
- params: {
  maxResults?: number;
  startAt?: number;
  } = {}
  - 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<PageBeanString>
Returned if the request is successful.

example:
```
{
  "isLast": false,
  "maxResults": 2,
  "startAt": 0,
  "total": 100,
  "values": [
    "performance",
    "security"
  ]
}
```
Path
GET /rest/api/3/label @scopes-current read:jira-work @scopes-beta read:label:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-labels#api-rest-api-3-label-get

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize