POST /wiki/rest/api/contentbody/convert/async/{to}

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.

Servers

Path parameters

Name Type Required Description
to String Yes

The name of the target format for the content body.

Possible values:

  • "export_view"

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
contentIdContext String No

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.

spaceKeyContext String No

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.

expand[] Array No

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
embeddedContentRender String No

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.

Possible values:

  • "version-at-save"
  • "current"

Default value: "current"

allowCache Boolean No

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.

Default value: false

Request body fields

Name Type Required Description
representation String Yes

The content format type. Set the value of this property to the name of the format being used, e.g. 'storage'.

Possible values:

  • "editor"
  • "wiki"
  • "atlas_doc_format"
  • "export_view"
  • "storage"
  • "plain"
  • "raw"
  • "view"
  • "styled_view"
  • "editor2"
  • "anonymous_export_view"
value String Yes

The body of the content in the relevant format.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.