Class ExperimentalService

APIs in this section can change without any prior deprecation notice.

See

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

Hierarchy

CommonHttpService
- ExperimentalService

Index

Constructors

constructor

Methods

addLabelsToSpace deleteLabelFromSpace deletePageTree getLabelsForSpace initialize

Constructors

constructor

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

Methods

addLabelsToSpace

addLabelsToSpace(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: {
  labelCreates: LabelCreate[];
  spaceKey: string;
  }
  - labelCreates: LabelCreate[]
    The labels to add to the content.
  - spaceKey: string
    The key of the space to add labels to.
Returns Promise<LabelArray>
Returned if the labels are added to the content.

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

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-experimental#api-wiki-rest-api-space-spacekey-label-post

deleteLabelFromSpace

deleteLabelFromSpace(params): Promise<void>
Parameters
- params: {
      name: string;
      prefix?: string;
      spaceKey: string;
  }
  - name: string
    The name of the label to remove
  - Optionalprefix?: string
    The prefix of the label to remove. If not provided defaults to global.
  - spaceKey: string
    The key of the space to remove a labels from.
Returns Promise<void>
Path
DELETE /wiki/rest/api/space/{spaceKey}/label @scopes-current write:confluence-space @scopes-beta write:label:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-experimental#api-wiki-rest-api-space-spacekey-label-delete

deletePageTree

deletePageTree(params): Promise<LongTask>
Moves a pagetree rooted at a page to the space's trash:
- If the content's type is page and its status is current, it will be trashed including all its descendants.
- For every other combination of content type and status, this API is not supported.
This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously.

Response example:
```
 {
      "id" : "1180606",
      "links" : {
           "status" : "/rest/api/longtask/1180606"
      }
 }
```
Use the /longtask/<taskId> REST API to get the copy task status.

Permissions required: 'Delete' permission for the space that the content is in.
Parameters
- params: {
  id: string;
  }
  - id: string
    The ID of the content which forms root of the page tree, to be deleted.
Returns Promise<LongTask>
Returned if the request to trash content and all its current page descendants, is successfully accepted.

Path
DELETE /wiki/rest/api/content/{id}/pageTree @scopes-current write:confluence-content @scopes-beta delete:content:confluence

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

getLabelsForSpace

getLabelsForSpace(params): Promise<LabelArray>
Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different types of labels.
Parameters
- params: {
      limit?: number;
      prefix?: "global" | "my" | "team";
      spaceKey: string;
      start?: number;
  }
  - Optionallimit?: number
    The maximum number of labels to return per page. Note, this may be restricted by fixed system limits.
  - Optionalprefix?: "global" | "my" | "team"
    Filters the results to labels with the specified prefix. If this parameter is not specified, then labels with any prefix will be returned.
    
    global prefix is used by labels that are on content within the provided space.
    
    my prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'.
    
    team prefix is used for labels applied to the space.
  - spaceKey: string
    The key of the space to get labels for.
  - Optionalstart?: number
    The starting index of the returned labels.
Returns Promise<LabelArray>
Returned if the list of labels is returned.

Path
GET /wiki/rest/api/space/{spaceKey}/label @scopes-current read:confluence-space.summary @scopes-beta read:label:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-experimental#api-wiki-rest-api-space-spacekey-label-get

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize

Class ExperimentalService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns ExperimentalService

Methods

addLabelsToSpace

Parameters

labelCreates: LabelCreate[]

spaceKey: string

Returns Promise<LabelArray>

Path

See

deleteLabelFromSpace

Parameters

name: string

Optionalprefix?: string

spaceKey: string

Returns Promise<void>

Path

See

deletePageTree

Parameters

id: string

Returns Promise<LongTask>

Path

See

getLabelsForSpace

Parameters

Optionallimit?: number

Optionalprefix?: "global" | "my" | "team"

spaceKey: string

Optionalstart?: number

Returns Promise<LabelArray>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`prefix?: string

`Optional`limit?: number

`Optional`prefix?: "global" | "my" | "team"

`Optional`start?: number

`Protected` `Static`initialize