Interface ConfluenceRestClientContentLabelsApi

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    DeleteContentByIDLabelByLabelV1(@NotNull String id, @NotNull String label)
    DeleteContentByIDLabelByLabelV1 Remove label from content Removes a label from a piece of content.
    void
    DeleteContentByIDLabelV1(@NotNull String id, @NotNull String name)
    DeleteContentByIDLabelV1 Remove label from content using query parameter Removes a label from a piece of content.
    LabelArray
    PostContentByIDLabelV1(@NotNull String id, @NotNull Object payload)
    PostContentByIDLabelV1 Add labels to content Adds labels to a piece of content.

  • Method Details

    • PostContentByIDLabelV1

      LabelArray PostContentByIDLabelV1(@NotNull @NotNull String id, @NotNull @NotNull Object payload)
      PostContentByIDLabelV1 Add labels to content 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:
      id - The ID of the content that will have labels added to it.
      payload - The labels to add to the content.

    • DeleteContentByIDLabelV1

      void DeleteContentByIDLabelV1(@NotNull @NotNull String id, @NotNull @NotNull String name)
      DeleteContentByIDLabelV1 Remove label from content using query parameter Removes a label from a piece of content. Labels can't be deleted from archived content. This is similar to [Remove label from content](#api-content-id-label-label-delete) except that the label name is specified via a query parameter. Use this method if the label name has "/" characters, as [Remove label from content using query parameter](#api-content-id-label-delete) does not accept "/" characters for the label name. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
      Parameters:
      id - The ID of the content that the label will be removed from.
      name - The name of the label to be removed.

    • DeleteContentByIDLabelByLabelV1

      void DeleteContentByIDLabelByLabelV1(@NotNull @NotNull String id, @NotNull @NotNull String label)
      DeleteContentByIDLabelByLabelV1 Remove label from content Removes a label from a piece of content. Labels can't be deleted from archived content. This is similar to [Remove label from content using query parameter](#api-content-id-label-delete) except that the label name is specified via a path parameter. Use this method if the label name does not have "/" characters, as the path parameter does not accept "/" characters for security reasons. Otherwise, use [Remove label from content using query parameter](#api-content-id-label-delete). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
      Parameters:
      id - The ID of the content that the label will be removed from.
      label - The name of the label to be removed.