Video

The Video object type represents a video content object. atlassian:video should be used to ingest video-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:video
  ├─ thumbnailUrl (string) [Required]
  ├─ embedUrl (string) [Required]
  ├─ durationInSeconds (integer) [Optional]
  ├─ width (integer) [Optional]
  ├─ height (integer) [Optional]
  ├─ commentCount (integer) [Optional]
  ├─ textTracks (List<object>) [Optional]
      ├─ name (string) [Optional]
      ├─ locale (string) [Optional]
      └─ cues (List<Cue>) [Required]
        ├─ id (string) [Optional]
        ├─ startTimeInSeconds (double) [Required]
        ├─ endTimeInSeconds (double) [Optional]
        ├─ text (string) [Required]
  ├─ chapters (List<Chapter>) [Optional]
      ├─ startTimeInSeconds (double) [Required]
      ├─ title (string) [Required]
  └─ contributors (List<object>) [Optional]
      ├─ user (object) [Required]
          ├─ accountId (string) [Optional]
          ├─ email (string) [Optional]
          ├─ externalId (string) [Optional]
          ├─ ari (string) [Optional]
          ├─ name (string) [Optional]
          ├─ userName (string) [Optional]
          ├─ avatar (string) [Optional]
          └─ url (string) [Optional]
      └─ interactionCount (integer) [Required]

Common properties

Video properties

Example payload

1
2
{
  "objects" : [ {
    "id" : "video-1",
    "updateSequenceNumber" : 1,
    "displayName" : "My video",
    "description" : "My first video",
    "url" : "https://www.example-video.com/share/59105659e3b84d2d8491bcc8f608284d",
    "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
    "permissions" : [ {
      "action" : "read",
      "accessControls" : [ {
        "principals" : [ {
          "type" : "EVERYONE"
        } ]
      } ]
    }, {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "MUST_HAVE_VIEWED"
        } ]
      } ]
    } ],
    "atlassian:video" : {
      "thumbnailUrl" : "https://example-video.com/thumbnail/123123",
      "embedUrl" : "https://example-video.com/embed/embed-123",
      "durationInSeconds" : 503,
      "width" : 3840,
      "height" : 2160,
      "commentCount" : 1,
      "textTracks" : [ {
        "name" : "English subtitles",
        "locale" : "en-US",
        "cues" : [ {
          "id" : "cue-intro",
          "startTimeInSeconds" : 0,
          "endTimeInSeconds" : 5.5,
          "text" : "Hello, this is my first video."
        } ]
      } ],
      "chapters" : [ {
        "startTimeInSeconds" : 0,
        "title" : "Introduction"
      }, {
        "startTimeInSeconds" : 90,
        "title" : "Where are we now"
      }, {
        "startTimeInSeconds" : 220,
        "title" : "What do we want to achieve"
      } ],
      "contributors" : [ {
        "user" : {
          "externalId" : "external-id-1"
        },
        "interactionCount" : 5
      } ]
    }
  } ],
  "operationType" : "NORMAL"
}