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:
- 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 required: If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content.
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
to |
String | Yes |
The name of the target format for the content body. Valid values:
|
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 |
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 |
expand[] |
Array | No |
A multi-value parameter indicating which properties of the content to expand and populate. Expands are dependent on the
If rendering to
|
embeddedContentRender |
String | No |
Mode used for rendering embedded content, like attachments.
Valid values:
Default value: "current" |
allowCache |
Boolean | No |
Controls whether conversion results are cached and reused for identical requests.
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'. Valid values:
|
value |
String | Yes |
The body of the content in the relevant format. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.