Class ContentLabelsService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels

Hierarchy

CommonHttpService
- ContentLabelsService

Index

Constructors

Methods

addLabelsToContent removeLabelFromContent removeLabelFromContentUsingQueryParameter initialize

Constructors

constructor

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

Methods

addLabelsToContent

addLabelsToContent(params): Promise<LabelArray>
Adds labels to a piece of content. Does not modify the existing labels.

Notes:
- Labels can also be added when creating content (Create content).
- Labels can be updated when updating content (Update content). This will delete the existing labels and replace them with the labels in the request.
Permissions required: Permission to update the content.
Parameters
- params: {
  id: string;
  requestBody: LabelCreate | LabelCreateArray;
  }
  - id: string
    The ID of the content that will have labels added to it.
  - requestBody: LabelCreate | LabelCreateArray
    The labels to add to the content.
Returns Promise<LabelArray>
Returned if the labels are added to the content.

Path
POST /wiki/rest/api/content/{id}/label @scopes-current write:confluence-content @scopes-beta read:label:confluence, write:label:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels#api-wiki-rest-api-content-id-label-post

removeLabelFromContent

removeLabelFromContent(params): Promise<void>
Removes a label from a piece of content. Labels can't be deleted from archived content. This is similar to Remove label from content using query parameter except that the label name is specified via a path parameter.

Use this method if the label name does not have "/" characters, as the path parameter does not accept "/" characters for security reasons. Otherwise, use Remove label from content using query parameter.

Permissions required: Permission to update the content.
Parameters
- params: {
  id: string;
  label: string;
  }
  - id: string
    The ID of the content that the label will be removed from.
  - label: string
    The name of the label to be removed.
Returns Promise<void>
Path
DELETE /wiki/rest/api/content/{id}/label/{label} @scopes-current write:confluence-content @scopes-beta write:label:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels#api-wiki-rest-api-content-id-label-label-delete

removeLabelFromContentUsingQueryParameter

removeLabelFromContentUsingQueryParameter(params): Promise<void>
Removes a label from a piece of content. Labels can't be deleted from archived content. This is similar to Remove label from content except that the label name is specified via a query parameter.

Use this method if the label name has "/" characters, as Remove label from content using query parameter does not accept "/" characters for the label name.

Permissions required: Permission to update the content.
Parameters
- params: {
  id: string;
  name: string;
  }
  - id: string
    The ID of the content that the label will be removed from.
  - name: string
    The name of the label to be removed.
Returns Promise<void>
Path
DELETE /wiki/rest/api/content/{id}/label @scopes-current write:confluence-content @scopes-beta write:label:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels#api-wiki-rest-api-content-id-label-delete

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize