Atlassian · Schema

ContentCreate

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
id string The ID of the draft content. Required when publishing a draft.
title string
type string The type of the new content. Custom content types defined by apps are also supported. eg. 'page', 'blogpost', 'comment' etc.
space object The space that the content is being created in.
status string The status of the new content.
container object The container of the content. Required if type is `comment` or certain types of custom content. If you are trying to create a comment that is a child of another comment, specify the parent comment in
ancestors array The parent content of the new content. If you are creating a top-level `page` or `comment`, this can be left blank. If you are creating a child page, this is where the parent page id goes. If you are
body object The body of the new content. Does not apply to attachments. Only one body format should be specified as the property for this object, e.g. `storage`. Note, `editor2` format is used by Atlassian only.
View JSON Schema on GitHub

JSON Schema

atlassian-contentcreate-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ContentCreate",
  "title": "ContentCreate",
  "required": [
    "type"
  ],
  "type": "object",
  "nullable": true,
  "additionalProperties": true,
  "properties": {
    "id": {
      "nullable": true,
      "type": "string",
      "description": "The ID of the draft content. Required when publishing a draft."
    },
    "title": {
      "nullable": true,
      "maxLength": 255,
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "The type of the new content. Custom content types defined by apps are also supported. eg. 'page', 'blogpost', 'comment' etc."
    },
    "space": {
      "nullable": true,
      "required": [
        "key"
      ],
      "type": "object",
      "properties": {
        "id": {
          "nullable": true,
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "nullable": true,
          "type": "string"
        },
        "icon": {
          "$ref": "#/components/schemas/Icon"
        },
        "identifiers": {
          "$ref": "#/components/schemas/GlobalSpaceIdentifier"
        },
        "description": {
          "type": "object",
          "nullable": true,
          "properties": {
            "plain": {
              "$ref": "#/components/schemas/SpaceDescription"
            },
            "view": {
              "$ref": "#/components/schemas/SpaceDescription"
            },
            "_expandable": {
              "type": "object",
              "properties": {
                "view": {
                  "type": "string"
                },
                "plain": {
                  "type": "string"
                }
              }
            }
          }
        },
        "homepage": {
          "$ref": "#/components/schemas/Content"
        },
        "type": {
          "nullable": true,
          "type": "string"
        },
        "metadata": {
          "nullable": true,
          "type": "object",
          "properties": {
            "labels": {
              "$ref": "#/components/schemas/LabelArray"
            },
            "_expandable": {
              "type": "object"
            }
          }
        },
        "operations": {
          "nullable": true,
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/OperationCheckResult"
          }
        },
        "permissions": {
          "nullable": true,
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/SpacePermission"
          }
        },
        "status": {
          "nullable": true,
          "type": "string"
        },
        "settings": {
          "$ref": "#/components/schemas/SpaceSettings"
        },
        "theme": {
          "$ref": "#/components/schemas/Theme"
        },
        "lookAndFeel": {
          "$ref": "#/components/schemas/LookAndFeel"
        },
        "history": {
          "required": [
            "createdDate"
          ],
          "type": "object",
          "properties": {
            "createdDate": {
              "type": "string",
              "format": "date-time"
            },
            "createdBy": {
              "$ref": "#/components/schemas/User"
            }
          }
        },
        "key": {
          "type": "string",
          "description": "The key of the space."
        },
        "links": {
          "nullable": true,
          "type": "object",
          "additionalProperties": true
        }
      },
      "description": "The space that the content is being created in."
    },
    "status": {
      "type": "string",
      "description": "The status of the new content.",
      "default": "current",
      "enum": [
        "current",
        "deleted",
        "historical",
        "draft"
      ]
    },
    "container": {
      "nullable": true,
      "required": [
        "id",
        "type"
      ],
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "id": {
          "oneOf": [
            {
              "type": "integer"
            },
            {
              "type": "string"
            }
          ],
          "description": "The `id` of the container."
        },
        "type": {
          "type": "string",
          "description": "The `type` of the container."
        }
      },
      "description": "The container of the content. Required if type is `comment` or certain types of\ncustom content. If you are trying to create a comment that is a child of another comment,\nspecify the parent comment in the ancestors field, not in this field."
    },
    "ancestors": {
      "nullable": true,
      "type": "array",
      "description": "The parent content of the new content.  If you are creating a top-level `page` or `comment`,\nthis can be left blank. If you are creating a child page, this is where the parent page id goes.\nIf you are creating a child comment, this is where the parent comment id goes. Only one parent\ncontent id can be specified.",
      "items": {
        "required": [
          "id"
        ],
        "type": "object",
        "additionalProperties": true,
        "properties": {
          "id": {
            "type": "string",
            "description": "The `id` of the parent content."
          }
        }
      }
    },
    "body": {
      "type": "object",
      "properties": {
        "view": {
          "$ref": "#/components/schemas/ContentBodyCreate"
        },
        "export_view": {
          "$ref": "#/components/schemas/ContentBodyCreate"
        },
        "styled_view": {
          "$ref": "#/components/schemas/ContentBodyCreate"
        },
        "storage": {
          "$ref": "#/components/schemas/ContentBodyCreate"
        },
        "editor": {
          "$ref": "#/components/schemas/ContentBodyCreate"
        },
        "editor2": {
          "$ref": "#/components/schemas/ContentBodyCreate"
        },
        "wiki": {
          "$ref": "#/components/schemas/ContentBodyCreate"
        },
        "anonymous_export_view": {
          "$ref": "#/components/schemas/ContentBodyCreate"
        },
        "plain": {
          "$ref": "#/components/schemas/ContentBodyCreate"
        },
        "atlas_doc_format": {
          "$ref": "#/components/schemas/ContentBodyCreate"
        },
        "raw": {
          "$ref": "#/components/schemas/ContentBodyCreate"
        }
      },
      "description": "The body of the new content. Does not apply to attachments.\nOnly one body format should be specified as the property for\nthis object, e.g. `storage`.\n\nNote, `editor2` format is used by Atlassian only. `anonymous_export_view` is\nthe same as `export_view` format but only content viewable by an anonymous\nuser is included."
    }
  }
}