Package io.github.primelib.confluence4j.rest.v1.client

Interface ConfluenceRestClientExperimentalApi

@Generated("io.github.primelib.primecodegen") public interface ConfluenceRestClientExperimentalApi
ConfluenceRestClientExperimentalApi APIs in this section can change without any prior deprecation notice.

  • Method Details

    • DeleteContentByIDPageTreeV1

      void DeleteContentByIDPageTreeV1(@NotNull @NotNull String id)
      DeleteContentByIDPageTreeV1 Delete page tree Moves a pagetree rooted at a page to the space's trash: - If the content's type is `page` and its status is `current`, it will be trashed including all its descendants. - For every other combination of content type and status, this API is not supported. This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously. Response example: <pre><code> { "id" : "1180606", "links" : { "status" : "/rest/api/longtask/1180606" } } </code></pre> Use the `/longtask/<taskId>` REST API to get the copy task status. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the content is in.
      Parameters:
      id - The ID of the content which forms root of the page tree, to be deleted.

    • GetSpaceBySpaceKeyLabelV1

      LabelArray GetSpaceBySpaceKeyLabelV1(@NotNull @NotNull String spaceKey, @Nullable @Nullable String prefix, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      GetSpaceBySpaceKeyLabelV1 Get Space Labels Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different types of labels.
      Parameters:
      spaceKey - The key of the space to get labels for.
      prefix - Filters the results to labels with the specified prefix. If this parameter is not specified, then labels with any prefix will be returned. - `global` prefix is used by labels that are on content within the provided space. - `my` prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'. - `team` prefix is used for labels applied to the space.
      start - The starting index of the returned labels.
      limit - The maximum number of labels to return per page. Note, this may be restricted by fixed system limits.

    • PostSpaceBySpaceKeyLabelV1

      LabelArray PostSpaceBySpaceKeyLabelV1(@NotNull @NotNull String spaceKey, @NotNull @NotNull List<Map<String,Object>> payload)
      PostSpaceBySpaceKeyLabelV1 Add labels to a space Adds labels to a piece of content. Does not modify the existing labels. Notes: - Labels can also be added when creating content ([Create content](#api-content-post)). - Labels can be updated when updating content ([Update content](#api-content-id-put)). This will delete the existing labels and replace them with the labels in the request. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
      Parameters:
      spaceKey - The key of the space to add labels to.
      payload - The labels to add to the content.

    • DeleteSpaceBySpaceKeyLabelV1

      void DeleteSpaceBySpaceKeyLabelV1(@NotNull @NotNull String spaceKey, @NotNull @NotNull String name, @Nullable @Nullable String prefix)
      DeleteSpaceBySpaceKeyLabelV1 Remove label from a space
      Parameters:
      spaceKey - The key of the space to remove a labels from.
      name - The name of the label to remove
      prefix - The prefix of the label to remove. If not provided defaults to global.