Class DataPoliciesService

See

https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-data-policies

Hierarchy

  • CommonHttpService
    • DataPoliciesService

Constructors

constructor

Methods

getDataPolicyMetadata getDataPolicySpaces initialize

Constructors

constructor

  • new DataPoliciesService(getClientInstance): DataPoliciesService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns DataPoliciesService

Methods

getDataPolicyMetadata

getDataPolicySpaces

  • getDataPolicySpaces(params?): Promise<{
        _links?: MultiEntityLinks;
        results?: DataPolicySpace[];
    } & {
        [key: string]: unknown;
    }>

  • Returns all spaces. The results will be sorted by id ascending. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

    Permissions required: Only apps can make this request. Permission to access the Confluence site ('Can use' global permission). Only spaces that the app has permission to view will be returned.

    Parameters

    • params: {
          cursor?: string;
          ids?: number[];
          keys?: string[];
          limit?: number;
          sort?: SpaceSortOrder;
      } = {}
      • Optionalcursor?: string

        Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

      • Optionalids?: number[]

        Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list.

      • Optionalkeys?: string[]

        Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list.

      • Optionallimit?: number

        Maximum number of spaces per result to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.

      • Optionalsort?: SpaceSortOrder

        Used to sort the result by a particular field.

    Returns Promise<{
        _links?: MultiEntityLinks;
        results?: DataPolicySpace[];
    } & {
        [key: string]: unknown;
    }>

    Returned if the requested spaces are returned.

    Path

    GET /data-policies/spaces @scopes-current read:space:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-data-policies#api-data-policies-spaces-get

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods