Content body

Get asynchronously converted content body from the id or the current status of the task.

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.

get/wiki/rest/api/contentbody/convert/async/{id}

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/wiki/rest/api/contentbody/convert/async/{id}
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:confluence-content.all

Path parameters

idstring required

The asyncId of the macro task to get the converted body.

Response

Returned if successfully found an async conversion task associated with the id.

valuestring
representation'view' | 'export_view' | 'styled_view' | 'storage' | 'editor' | 'editor2' | 'anonymous_export_view' | 'wiki' | 'atlas_doc_format'
renderTaskIdstring
errorstring
status'WORKING' | 'QUEUED' | 'FAILED' | 'COMPLETED' | 'RERUNNING'

Rerunning is reserved for when the job is working, but there is a previous run's value in the cache. You may choose to continue polling, or use the cached value.

_linksGenericLinks

Changes

No recorded changes to this operation across all 2 revisions of this API.