ConfluenceRestClientSpaceSettingsApi (java (v0.3.2) - java)

@Generated("io.github.primelib.primecodegen") public interface ConfluenceRestClientSpaceSettingsApi

ConfluenceRestClientSpaceSettingsApi

Method Summary

Modifier and Type

Method

Description

SpaceSettings

GetSpaceBySpaceKeySettingsV1(@NotNull String spaceKey)

GetSpaceBySpaceKeySettingsV1 Get space settings Returns the settings of a space.

SpaceSettings

PutSpaceBySpaceKeySettingsV1(@NotNull String spaceKey, @NotNull SpaceSettingsUpdate payload)

PutSpaceBySpaceKeySettingsV1 Update space settings Updates the settings for a space.

Method Details
- GetSpaceBySpaceKeySettingsV1
  
  SpaceSettings GetSpaceBySpaceKeySettingsV1(@NotNull @NotNull String spaceKey)
  
  GetSpaceBySpaceKeySettingsV1 Get space settings Returns the settings of a space. Currently only the `routeOverrideEnabled` setting can be returned. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
  
  Parameters:
  
  spaceKey - The key of the space to be queried for its settings.
- PutSpaceBySpaceKeySettingsV1
  
  SpaceSettings PutSpaceBySpaceKeySettingsV1(@NotNull @NotNull String spaceKey, @NotNull @NotNull SpaceSettingsUpdate payload)
  
  PutSpaceBySpaceKeySettingsV1 Update space settings Updates the settings for a space. Currently only the `routeOverrideEnabled` setting can be updated. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
  
  Parameters:
  
  spaceKey - The key of the space whose settings will be updated.
  
  payload - The space settings to update.