POST /wiki/rest/api/contentbody/convert/async/bulk/tasks
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 required:
'View' permission for the space, and permission to view the content if the spaceKeyContext
or
contentIdContext
are present.
Servers
- https://your-domain.atlassian.net
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
[] |
Array | Yes | |
[].to |
String | Yes |
The name of the target format for the content body conversion. |
[].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, comma-separated 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, such as attachments. - Possible values:
Default value: "current" |
[].body |
Object | Yes |
This object is used when creating or updating content. |
[].body.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:
|
[].body.value |
String | Yes |
The body of the content in the relevant format. |
[].allowCache |
Boolean | No |
If Default value: false |
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.