Class ClassificationLevelService

See

https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level

Hierarchy

CommonHttpService
- ClassificationLevelService

Index

Constructors

Methods

Constructors

constructor

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

Methods

deleteSpaceDefaultClassificationLevel

deleteSpaceDefaultClassificationLevel(params): Promise<void>
Returns the default classification level for a specific space.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and 'Admin' permission for the space.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the space for which default classification level should be deleted.
Returns Promise<void>
Path
DELETE /spaces/{id}/classification-level/default @scopes-current read:space:confluence, write:space:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-spaces-id-classification-level-default-delete

getBlogPostClassificationLevel

getBlogPostClassificationLevel(params): Promise<ClassificationLevel>
Returns the classification level for a specific blog post.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the blog post. 'Permission to edit the blog post is required if trying to view classification level for a draft.
Parameters
- params: {
  id: number;
  status?: "current" | "draft" | "archived";
  }
  - id: number
    The ID of the blog post for which classification level should be returned.
  - Optionalstatus?: "current" | "draft" | "archived"
    Status of blog post from which classification level will fetched.
Returns Promise<ClassificationLevel>
Returned if the requested classification level for a blog post is returned.

Path
GET /blogposts/{id}/classification-level @scopes-current read:page:confluence, write:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-blogposts-id-classification-level-get

getClassificationLevels

getClassificationLevels(): Promise<ClassificationLevel[]>
Returns a list of classification levels available.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission).

Returns Promise<ClassificationLevel[]>
Returned if classifications levels are returned.

Path
GET /classification-levels @scopes-current read:configuration:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-classification-levels-get

getDatabaseClassificationLevel

getDatabaseClassificationLevel(params): Promise<ClassificationLevel>
Returns the classification level for a specific database.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the database.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the database for which classification level should be returned.
Returns Promise<ClassificationLevel>
Returned if the requested classification level for a database is returned.

Path
GET /databases/{id}/classification-level @scopes-current read:database:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-databases-id-classification-level-get

getPageClassificationLevel

getPageClassificationLevel(params): Promise<ClassificationLevel>
Returns the classification level for a specific page.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the page. 'Permission to edit the page is required if trying to view classification level for a draft.
Parameters
- params: {
  id: number;
  status?: "current" | "draft" | "archived";
  }
  - id: number
    The ID of the page for which classification level should be returned.
  - Optionalstatus?: "current" | "draft" | "archived"
    Status of page from which classification level will fetched.
Returns Promise<ClassificationLevel>
Returned if the requested classification level for a page is returned.

Path
GET /pages/{id}/classification-level @scopes-current read:page:confluence, write:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-pages-id-classification-level-get

getSpaceDefaultClassificationLevel

getSpaceDefaultClassificationLevel(params): Promise<ClassificationLevel>
Returns the default classification level for a specific space.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the space.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the space for which default classification level should be returned.
Returns Promise<ClassificationLevel>
Returned if the requested default classification level for a space is returned.

Path
GET /spaces/{id}/classification-level/default @scopes-current read:space:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-spaces-id-classification-level-default-get

getWhiteboardClassificationLevel

getWhiteboardClassificationLevel(params): Promise<ClassificationLevel>
Returns the classification level for a specific whiteboard.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the whiteboard.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the whiteboard for which classification level should be returned.
Returns Promise<ClassificationLevel>
Returned if the requested classification level for a whiteboard is returned.

Path
GET /whiteboards/{id}/classification-level @scopes-current read:whiteboard:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-whiteboards-id-classification-level-get

postBlogPostClassificationLevel

postBlogPostClassificationLevel(params): Promise<void>
Resets the classification level for a specific blog post for the space default classification level.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the blog post.
Parameters
- params: {
      id: number;
      requestBody: {
          status: "current" | "draft";
      } & {
          [key: string]: unknown;
      };
  }
  - id: number
    The ID of the blog post for which classification level should be updated.
  - requestBody: {
    status: "current" | "draft";
    } & {
    [key: string]: unknown;
    }
Returns Promise<void>
Path
POST /blogposts/{id}/classification-level/reset @scopes-current write:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-blogposts-id-classification-level-reset-post

postDatabaseClassificationLevel

postDatabaseClassificationLevel(params): Promise<void>
Resets the classification level for a specific database for the space default classification level.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the database.
Parameters
- params: {
      id: number;
      requestBody: {
          status: "current";
      } & {
          [key: string]: unknown;
      };
  }
  - id: number
    The ID of the database for which classification level should be updated.
  - requestBody: {
    status: "current";
    } & {
    [key: string]: unknown;
    }
Returns Promise<void>
Path
POST /databases/{id}/classification-level/reset @scopes-current write:database:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-databases-id-classification-level-reset-post

postPageClassificationLevel

postPageClassificationLevel(params): Promise<void>
Resets the classification level for a specific page for the space default classification level.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the page.
Parameters
- params: {
      id: number;
      requestBody: {
          status: "current" | "draft";
      } & {
          [key: string]: unknown;
      };
  }
  - id: number
    The ID of the page for which classification level should be updated.
  - requestBody: {
    status: "current" | "draft";
    } & {
    [key: string]: unknown;
    }
Returns Promise<void>
Path
POST /pages/{id}/classification-level/reset @scopes-current write:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-pages-id-classification-level-reset-post

postWhiteboardClassificationLevel

postWhiteboardClassificationLevel(params): Promise<void>
Resets the classification level for a specific whiteboard for the space default classification level.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the whiteboard.
Parameters
- params: {
      id: number;
      requestBody: {
          status: "current";
      } & {
          [key: string]: unknown;
      };
  }
  - id: number
    The ID of the whiteboard for which classification level should be updated.
  - requestBody: {
    status: "current";
    } & {
    [key: string]: unknown;
    }
Returns Promise<void>
Path
POST /whiteboards/{id}/classification-level/reset @scopes-current write:whiteboard:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-whiteboards-id-classification-level-reset-post

putBlogPostClassificationLevel

putBlogPostClassificationLevel(params): Promise<void>
Updates the classification level for a specific blog post.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to edit the blog post.
Parameters
- params: {
      id: number;
      requestBody: {
          id: string;
          status: "current" | "draft";
      } & {
          [key: string]: unknown;
      };
  }
  - id: number
    The ID of the blog post for which classification level should be updated.
  - requestBody: {
        id: string;
        status: "current" | "draft";
    } & {
        [key: string]: unknown;
    }
Returns Promise<void>
Path
PUT /blogposts/{id}/classification-level @scopes-current write:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-blogposts-id-classification-level-put

putDatabaseClassificationLevel

putDatabaseClassificationLevel(params): Promise<void>
Updates the classification level for a specific database.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to edit the database.
Parameters
- params: {
      id: number;
      requestBody: {
          id: string;
          status: "current";
      } & {
          [key: string]: unknown;
      };
  }
  - id: number
    The ID of the database for which classification level should be updated.
  - requestBody: {
        id: string;
        status: "current";
    } & {
        [key: string]: unknown;
    }
Returns Promise<void>
Path
PUT /databases/{id}/classification-level @scopes-current write:database:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-databases-id-classification-level-put

putPageClassificationLevel

putPageClassificationLevel(params): Promise<void>
Updates the classification level for a specific page.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to edit the page.
Parameters
- params: {
      id: number;
      requestBody: {
          id: string;
          status: "current" | "draft";
      } & {
          [key: string]: unknown;
      };
  }
  - id: number
    The ID of the page for which classification level should be updated.
  - requestBody: {
        id: string;
        status: "current" | "draft";
    } & {
        [key: string]: unknown;
    }
Returns Promise<void>
Path
PUT /pages/{id}/classification-level @scopes-current write:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-pages-id-classification-level-put

putSpaceDefaultClassificationLevel

putSpaceDefaultClassificationLevel(params): Promise<void>
Update the default classification level for a specific space.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and 'Admin' permission for the space.
Parameters
- params: {
      id: number;
      requestBody: {
          id: string;
      } & {
          [key: string]: unknown;
      };
  }
  - id: number
    The ID of the space for which default classification level should be updated.
  - requestBody: {
    id: string;
    } & {
    [key: string]: unknown;
    }
Returns Promise<void>
Path
PUT /spaces/{id}/classification-level/default @scopes-current read:space:confluence, write:space:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-spaces-id-classification-level-default-put

putWhiteboardClassificationLevel

putWhiteboardClassificationLevel(params): Promise<void>
Updates the classification level for a specific whiteboard.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to edit the whiteboard.
Parameters
- params: {
      id: number;
      requestBody: {
          id: string;
          status: "current";
      } & {
          [key: string]: unknown;
      };
  }
  - id: number
    The ID of the whiteboard for which classification level should be updated.
  - requestBody: {
        id: string;
        status: "current";
    } & {
        [key: string]: unknown;
    }
Returns Promise<void>
Path
PUT /whiteboards/{id}/classification-level @scopes-current write:whiteboard:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level#api-whiteboards-id-classification-level-put

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize

Class ClassificationLevelService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns ClassificationLevelService

Methods

deleteSpaceDefaultClassificationLevel

Parameters

id: number

Returns Promise<void>

Path

See

getBlogPostClassificationLevel

Parameters

id: number

Optionalstatus?: "current" | "draft" | "archived"

Returns Promise<ClassificationLevel>

Path

See

getClassificationLevels

Returns Promise<ClassificationLevel[]>

Path

See

getDatabaseClassificationLevel

Parameters

id: number

Returns Promise<ClassificationLevel>

Path

See

getPageClassificationLevel

Parameters

id: number

Optionalstatus?: "current" | "draft" | "archived"

Returns Promise<ClassificationLevel>

Path

See

getSpaceDefaultClassificationLevel

Parameters

id: number

Returns Promise<ClassificationLevel>

Path

See

getWhiteboardClassificationLevel

Parameters

id: number

Returns Promise<ClassificationLevel>

Path

See

postBlogPostClassificationLevel

Parameters

id: number

requestBody: { status: "current" | "draft"; } & { [key: string]: unknown; }

Returns Promise<void>

Path

See

postDatabaseClassificationLevel

Parameters

id: number

requestBody: { status: "current"; } & { [key: string]: unknown; }

Returns Promise<void>

Path

See

postPageClassificationLevel

Parameters

id: number

requestBody: { status: "current" | "draft"; } & { [key: string]: unknown; }

Returns Promise<void>

Path

See

postWhiteboardClassificationLevel

Parameters

id: number

requestBody: { status: "current"; } & { [key: string]: unknown; }

Returns Promise<void>

`Optional`status?: "current" | "draft" | "archived"

`Optional`status?: "current" | "draft" | "archived"

requestBody: {
status: "current" | "draft";
} & {
[key: string]: unknown;
}

requestBody: {
status: "current";
} & {
[key: string]: unknown;
}

requestBody: {
status: "current" | "draft";
} & {
[key: string]: unknown;
}

requestBody: {
status: "current";
} & {
[key: string]: unknown;
}

requestBody: {
id: string;
status: "current" | "draft";
} & {
[key: string]: unknown;
}

requestBody: {
id: string;
status: "current";
} & {
[key: string]: unknown;
}

requestBody: {
id: string;
status: "current" | "draft";
} & {
[key: string]: unknown;
}

requestBody: {
id: string;
} & {
[key: string]: unknown;
}

requestBody: {
id: string;
status: "current";
} & {
[key: string]: unknown;
}

`Protected` `Static`initialize