Class SpacePropertiesService

See

https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties

Hierarchy

  • CommonHttpService
    • SpacePropertiesService

Constructors

constructor

Methods

createSpaceProperty deleteSpacePropertyById getSpaceProperties getSpacePropertyById updateSpacePropertyById initialize

Constructors

constructor

  • new SpacePropertiesService(getClientInstance): SpacePropertiesService
  • Internal

    Create a new instance of the service.

    Parameters

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

        • Returns CommonHttpClient

    Returns SpacePropertiesService

Methods

createSpaceProperty

deleteSpacePropertyById

getSpaceProperties

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

  • Returns all properties for the given space. Space properties are a key-value storage associated with a space. The limit parameter specifies the maximum number of results returned in a single response. Use the link response header to paginate through additional results.

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

    Parameters

    • params: {
          cursor?: string;
          key?: string;
          limit?: number;
          spaceId: number;
      }
      • 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.

      • Optionalkey?: string

        The key of the space property to retrieve. This should be used when a user knows the key of their property, but needs to retrieve the id for use in other methods.

      • Optionallimit?: number

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

      • spaceId: number

        The ID of the space for which space properties should be returned.

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

    Returned if the requested space properties are returned. results may be empty if no results were found.

    Path

    GET /spaces/{space-id}/properties @scopes-current read:space:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-get

getSpacePropertyById

updateSpacePropertyById

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