InternalCreate a new instance of the service.
Converts a content body from one format to another format asynchronously. Returns the asyncId for the asynchronous task.
Supported conversions:
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 required: If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content.
OptionalallowControls whether conversion results are cached and reused for identical requests.
false: Each request creates a new conversion task, even if an identical
request was made previously.true: Enables caching behavior for identical requests from the same user.
The content body to convert.
OptionalcontentThe 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.
OptionalembeddedMode 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.Optionalexpand?: string[]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 APImacroRenderedOutput additionally converts body to view formatwebresource.superbatch.uris.js returns all common JS dependencies as static
URLswebresource.superbatch.uris.css returns all common CSS dependencies as
static URLswebresource.superbatch.uris.all returns all common dependencies as static
URLswebresource.superbatch.tags.all returns all common JS dependencies as html
<script> tagswebresource.superbatch.tags.css returns all common CSS dependencies as html
<style> tagswebresource.superbatch.tags.js returns all common dependencies as html
<script> and <style> tagswebresource.uris.js returns JS dependencies specific to conversionwebresource.uris.css returns CSS dependencies specific to conversionwebresource.uris.all returns all dependencies specific to conversionwebresource.tags.all returns common JS dependencies as html <script> tagswebresource.tags.css returns common CSS dependencies as html <style> tagswebresource.tags.js returns common dependencies as html <script> and
<style> tagsOptionalspaceThe 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.
The name of the target format for the content body.
Returned if the content is added to the messaging queue for conversion. This id will be available for 5 minutes after the conversion is complete.
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.
Permissions required: If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content.
The asyncId of the macro task to get the converted body.
Returned if successfully found an async conversion task associated with the id.
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:
Once a conversion task is completed, it is available for polling for up to 5 minutes.
Permissions required:
'View' permission for the space, and permission to view the content if the
spaceKeyContext or
contentIdContext are present.
An array of parameters to create content body conversion tasks.
Returned if asynchronous tasks are created to convert content bodies. If a conversion task fails to be created, a “FAILED_TO_QUEUE” string will be returned instead of an asyncId.
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 required: Permission to access the Confluence site ('Can use' global permission).
The asyncIds of the conversion tasks.
Returned if asynchronous conversion tasks are successfully found.
Protected Staticinitialize
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body