Interface ConfluenceRestClientSpaceApi

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

  • Method Details

    • PostSpaceV1

      Space PostSpaceV1(@NotNull @NotNull Map<String,Object> payload)
      PostSpaceV1 Create space Creates a new space. Note, currently you cannot set space labels when creating a space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Create Space(s)' global permission.
      Parameters:
      payload - The space to be created.

    • PostSpacePrivateV1

      Space PostSpacePrivateV1(@NotNull @NotNull Map<String,Object> payload)
      PostSpacePrivateV1 Create private space Creates a new space that is only visible to the creator. This method is the same as the [Create space](#api-space-post) method with permissions set to the current user only. Note, currently you cannot set space labels when creating a space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Create Space(s)' global permission.
      Parameters:
      payload - The space to be created.

    • PutSpaceBySpaceKeyV1

      Space PutSpaceBySpaceKeyV1(@NotNull @NotNull String spaceKey, @NotNull @NotNull Map<String,Object> payload)
      PutSpaceBySpaceKeyV1 Update space Updates the name, description, or homepage of a space. - For security reasons, permissions cannot be updated via the API and must be changed via the user interface instead. - Currently you cannot set space labels when updating a space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
      Parameters:
      spaceKey - The key of the space to update.
      payload - The updated space.

    • DeleteSpaceBySpaceKeyV1

      void DeleteSpaceBySpaceKeyV1(@NotNull @NotNull String spaceKey)
      DeleteSpaceBySpaceKeyV1 Delete space Permanently deletes a space without sending it to the trash. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted yet when this method has returned. Clients should poll the status link that is returned in the response until the task completes. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
      Parameters:
      spaceKey - The key of the space to delete.