Document

The Document object type represents a document object. atlassian:document should be used to ingest document-specific fields.

Payload structure

1
2
  objects {}
  ├─ schemaVersion (string) [Required]
  ├─ id (string) [Required]
  ├─ updateSequenceNumber (long) [Required]
  ├─ displayName (string) [Required]
  ├─ description (string) [Optional]
  ├─ url (string) [Required]
  ├─ createdAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ createdBy [] [Optional]
      ├─ accountId (string)
      └─ ari (string)
  └─ lastUpdatedAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ lastUpdatedBy [] [Required]
      ├─accountId (string)
      └─ ari
  └─ permissions 
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:document
  ├─ type (DocumentType) [Required]
      ├─ category (string) [Required]
      ├─ mimeType (string) [Required]
      ├─ iconUrl (string) [Optional]
      └─ fileExtension (string) [Optional]
  ├─ content (DocumentContent) [Required]
      ├─ mimeType (string) [Required]
      ├─ binary (string) [Optional]
      └─ text (string) [Optional]
  ├─ collaborators (List<UserReference>) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      ├─ externalId (string) [Optional]
      ├─ ari (string) [Optional]
      ├─ name (string) [Optional]
      ├─ userName (string) [Optional]
      ├─ avatar (string) [Optional]
      └─ url (string) [Optional]
  ├─ byteSize (integer) [Optional]
  ├─ exportLinks (List<ExportLink>) [Optional]
      ├─ mimeType (string) [Optional]
      ├─ url (string) [Required]
  ├─ labels (List<string>) [Optional]
  └─ reactions (List<Reaction>) [Optional]
      ├─ reactionType (string) [Required]
      └─ total (integer) [Required]

Common properties

Document properties

Example payload

1
2
{
  "objects" : [ {
    "schemaVersion" : "1.0",
    "id" : "my-document",
    "updateSequenceNumber" : 123,
    "displayName" : "My Document",
    "url" : "https://document.com",
    "thumbnail" : {
      "externalUrl" : "https://document-thumbnail.com"
    },
    "createdAt" : "2024-04-16T09:01:32+00:00",
    "parentKey" : {
      "type" : "atlassian:document",
      "value" : {
        "entityId" : "another-document"
      }
    },
    "permissions" : [ {
      "action" : "read",
      "accessControls" : [ {
        "principals" : [ {
          "type" : "EVERYONE"
        } ]
      } ]
    } ],
    "atlassian:document" : {
      "type" : {
        "category" : "document",
        "iconUrl" : "http://example-icon.com/icon/111"
      },
      "content" : {
        "mimeType" : "text/plain",
        "text" : "Really large content here..."
      },
      "byteSize" : 456,
      "labels" : [ "label1", "label2" ],
      "reactions" : [ {
        "type" : "LIKE",
        "total" : 1
      } ],
      "exportLinks" : [ {
        "mimeType" : "text/plain",
        "url" : "http://localhost"
      } ]
    },
    "containerKey" : {
      "type" : "atlassian:space",
      "value" : {
        "entityId" : "CFG3W7TKJ"
      }
    }
  } ],
  "operationType" : "NORMAL"
}