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

Interface ConfluenceRestClientContentBodyApi

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

  • Method Details

    • PostContentbodyConvertAsyncByToV1

      AsyncId PostContentbodyConvertAsyncByToV1(@NotNull @NotNull String to, @Nullable @Nullable List<String> expand, @Nullable @Nullable String spaceKeyContext, @Nullable @Nullable String contentIdContext, @Nullable @Nullable Boolean allowCache, @Nullable @Nullable String embeddedContentRender, @NotNull @NotNull Map<String,Object> payload)
      PostContentbodyConvertAsyncByToV1 Asynchronously convert content body Converts a content body from one format to another format asynchronously. Returns the asyncId for the asynchronous task. Supported conversions: - atlas_doc_format: editor, export_view, storage, styled_view, view - storage: atlas_doc_format, editor, export_view, styled_view, view - editor: storage No other conversions are supported at the moment. Once a conversion is completed, it will be available for 5 minutes at the result endpoint. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content.
      Parameters:
      to - The name of the target format for the content body.
      expand - A multi-value parameter indicating which properties of the content to expand and populate. Expands are dependent on the `to` conversion format and may be irrelevant for certain conversions (e.g. `macroRenderedOutput` is redundant when converting to `view` format). If rendering to `view` format, and the body content being converted includes arbitrary nested content (such as macros); then it is necessary to include webresource expands in the request. Webresources for content body are the batched JS and CSS dependencies for any nested dynamic content (i.e. macros). - `embeddedContent` returns metadata for nested content (e.g. page included using page include macro) - `mediaToken` returns JWT token for retrieving attachment data from Media API - `macroRenderedOutput` additionally converts body to view format - `webresource.superbatch.uris.js` returns all common JS dependencies as static URLs - `webresource.superbatch.uris.css` returns all common CSS dependencies as static URLs - `webresource.superbatch.uris.all` returns all common dependencies as static URLs - `webresource.superbatch.tags.all` returns all common JS dependencies as html `<script>` tags - `webresource.superbatch.tags.css` returns all common CSS dependencies as html `<style>` tags - `webresource.superbatch.tags.js` returns all common dependencies as html `<script>` and `<style>` tags - `webresource.uris.js` returns JS dependencies specific to conversion - `webresource.uris.css` returns CSS dependencies specific to conversion - `webresource.uris.all` returns all dependencies specific to conversion - `webresource.tags.all` returns common JS dependencies as html `<script>` tags - `webresource.tags.css` returns common CSS dependencies as html `<style>` tags - `webresource.tags.js` returns common dependencies as html `<script>` and `<style>` tags
      spaceKeyContext - The space key used for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link `<ac:link><ri:page ri:content-title="Example page" /><ac:link>` and the `spaceKeyContext=TEST` parameter is provided, then the link will be converted to a link to the "Example page" page in the "TEST" space.
      contentIdContext - The content ID used to find the space for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link `<ac:link><ri:page ri:content-title="Example page" /><ac:link>` and the `contentIdContext=123` parameter is provided, then the link will be converted to a link to the "Example page" page in the same space that has the content with ID=123. Note, `spaceKeyContext` will be ignored if this parameter is provided.
      allowCache - If this field is false, the cache will erase its current value and begin a new conversion. If this field is true, the cache will not erase its current value, and will set the status of the async conversion to RERUNNING. Once the data is updated, the status will change to COMPLETED. Large macros that take long to convert, and whose data need not immediately up to date (same as previous conversion's result within last 5 minutes) should set this fields to true. Cache values are stored per user per content body and expansions.
      embeddedContentRender - Mode used for rendering embedded content, like attachments. - `current` renders the embedded content using the latest version. - `version-at-save` renders the embedded content using the version at the time of save.
      payload - The content body to convert.

    • GetContentbodyConvertAsyncByIDV1

      AsyncContentBody GetContentbodyConvertAsyncByIDV1(@NotNull @NotNull String id)
      GetContentbodyConvertAsyncByIDV1 Get asynchronously converted content body from the id or the current status of the task. Returns the asynchronous content body for the corresponding id if the task is complete or returns the status of the task. After the task is completed, the result can be obtained for 5 minutes, or until an identical conversion request is made again, with allowCache query param set to false. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content.
      Parameters:
      id - The asyncId of the macro task to get the converted body.

    • GetContentbodyConvertAsyncBulkTasksV1

      List<AsyncContentBody> GetContentbodyConvertAsyncBulkTasksV1(@NotNull @NotNull List<String> ids)
      GetContentbodyConvertAsyncBulkTasksV1 Get asynchronous content body conversion task result in bulk Returns the content body for the corresponding `asyncId` of a completed conversion task. If the task is not completed, the task status is returned instead. Once a conversion task is completed, the result can be obtained for up to 5 minutes, or until an identical conversion request is made again with the `allowCache` parameter set to false. Note that there is a maximum limit of 50 task results per request to this endpoint. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      ids - The asyncIds of the conversion tasks.

    • PostContentbodyConvertAsyncBulkTasksV1

      List<AsyncId> PostContentbodyConvertAsyncBulkTasksV1(@NotNull @NotNull List<ContentBodyConversionInput> payload)
      PostContentbodyConvertAsyncBulkTasksV1 Create asynchronous content body conversion tasks in bulk Asynchronously converts content bodies from one format to another format in bulk. Use the Content body REST API to get the status of conversion tasks. Note that there is a maximum limit of 10 conversions per request to this endpoint. Supported conversions: - storage: editor, export_view, styled_view, view - editor: storage Once a conversion task is completed, it is available for polling for up to 5 minutes. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and permission to view the content if the `spaceKeyContext` or `contentIdContext` are present.
      Parameters:
      payload - An array of parameters to create content body conversion tasks.