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

Class GetContentByIDHistoryByVersionMacroIDByMacroIDV1OperationSpec

java.lang.Object
io.github.primelib.confluence4j.rest.v1.operations.GetContentByIDHistoryByVersionMacroIDByMacroIDV1OperationSpec
@Generated("io.github.primelib.primecodegen") public class GetContentByIDHistoryByVersionMacroIDByMacroIDV1OperationSpec extends Object
GetContentByIDHistoryByVersionMacroIDByMacroIDV1

Returns the body of a macro in storage format, for the given macro ID. This includes information like the name of the macro, the body of the macro, and any macro parameters. This method is mainly used by Cloud apps. About the macro ID: When a macro is created in a new version of content, Confluence will generate a random ID for it, unless an ID is specified (by an app). The macro ID will look similar to this: '50884bd9-0cb8-41d5-98be-f80943c14f96'. The ID is then persisted as new versions of content are created, and is only modified by Confluence if there are conflicting IDs. For Forge macros, the value for macro ID is the "local ID" of that particular ADF node. This value can be retrieved either client-side by calling view.getContext() and accessing "localId" on the resulting object, or server-side by examining the "local-id" parameter node inside the "parameters" node. Note that there are other attributes named "local-id", but only this particular one is used to store the macro ID. Example: <ac:adf-node type="extension"> <ac:adf-attribute key="extension-type">com.atlassian.ecosystem</ac:adf-attribute> <ac:adf-attribute key="parameters"> <ac:adf-parameter key="local-id">e9c4aa10-73fa-417c-888d-48c719ae4165</ac:adf-parameter> </ac:adf-parameter> </ac:adf-node> Note, to preserve backwards compatibility this resource will also match on the hash of the macro body, even if a macro ID is found. This check will eventually become redundant, as macro IDs are generated for pages and transparently propagate out to all instances. This backwards compatibility logic does not apply to Forge macros; those can only be retrieved by their ID. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content that the macro is in.

  • Field Details

    • VALIDATION_ENABLED

      @Experimental public static Boolean VALIDATION_ENABLED
      allows to disable validation of the spec, use with care!

  • Constructor Details

  • Method Details

    • validate

      public void validate()
      Validates the Spec, will throw a exception if required parameters are missing
      Throws:
      NullPointerException

    • id

      public @NonNull String id()
      The ID for the content that contains the macro.

    • version

      public @NonNull Integer version()
      The version of the content that contains the macro. Specifying `0` as the `version` will return the macro body for the latest content version.

    • macroId

      public @NonNull String macroId()
      The ID of the macro. This is usually passed by the app that the macro is in. Otherwise, find the macro ID by querying the desired content and version, then expanding the body in storage format. For example, '/content/196611/version/7?expand=content.body.storage'.

    • id

      public GetContentByIDHistoryByVersionMacroIDByMacroIDV1OperationSpec id(@NonNull String id)
      The ID for the content that contains the macro.
      Returns:
      this.

    • version

      public GetContentByIDHistoryByVersionMacroIDByMacroIDV1OperationSpec version(@NonNull Integer version)
      The version of the content that contains the macro. Specifying `0` as the `version` will return the macro body for the latest content version.
      Returns:
      this.

    • macroId

      public GetContentByIDHistoryByVersionMacroIDByMacroIDV1OperationSpec macroId(@NonNull String macroId)
      The ID of the macro. This is usually passed by the app that the macro is in. Otherwise, find the macro ID by querying the desired content and version, then expanding the body in storage format. For example, '/content/196611/version/7?expand=content.body.storage'.
      Returns:
      this.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object