Atlassian · Schema

AsyncContentBody

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
value string
representation string
renderTaskId string
error string
status string 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.
embeddedContent array
webresource object
mediaToken object
_expandable object
_links object
View JSON Schema on GitHub

JSON Schema

atlassian-asynccontentbody-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AsyncContentBody",
  "title": "AsyncContentBody",
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "example": "example_value"
    },
    "representation": {
      "type": "string",
      "enum": [
        "view",
        "export_view",
        "styled_view",
        "storage",
        "editor",
        "editor2",
        "anonymous_export_view",
        "wiki",
        "atlas_doc_format"
      ],
      "example": "view"
    },
    "renderTaskId": {
      "type": "string",
      "example": "500123"
    },
    "error": {
      "type": "string",
      "example": "example_value"
    },
    "status": {
      "description": "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.",
      "type": "string",
      "enum": [
        "WORKING",
        "QUEUED",
        "FAILED",
        "COMPLETED",
        "RERUNNING"
      ],
      "example": "WORKING"
    },
    "embeddedContent": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EmbeddedContent"
      },
      "example": []
    },
    "webresource": {
      "$ref": "#/components/schemas/WebResourceDependencies"
    },
    "mediaToken": {
      "type": "object",
      "properties": {
        "collectionIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "contentId": {
          "type": "string"
        },
        "expiryDateTime": {
          "type": "string"
        },
        "fileIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "token": {
          "type": "string"
        }
      },
      "example": "example_value"
    },
    "_expandable": {
      "type": "object",
      "properties": {
        "content": {
          "type": "string"
        },
        "embeddedContent": {
          "type": "string"
        },
        "webresource": {
          "type": "string"
        },
        "mediaToken": {
          "type": "string"
        }
      },
      "example": "example_value"
    },
    "_links": {
      "$ref": "#/components/schemas/GenericLinks"
    }
  }
}