1
2
  object
  ├─ schemaVersion (string) [Required]
  ├─ id (string) [Required]
  ├─ updateSequenceNumber (long) [Required]
  ├─ displayName (string) [Required]
  ├─ description (string) [Optional]
  ├─ url (string) [Required]
  ├─ createdAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ createdBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Optional]
  └─ lastUpdatedAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ lastUpdatedBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Optional]
  └─ containerKey (EntityKey) [Required]
      ├─ type (string) [Required]
      └─ value (jsonNode) [Required]
  └─ permissions [] [Required]
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:build
  ├─ pipelineId (string) [Required]
  ├─ buildNumber (long) [Required]
  ├─ state (string) [Required]
  ├─ label (string) [Optional]
  ├─ duration (long) [Optional]
  ├─ testInfo [Optional]
  │   ├─ totalNumber (int) [Required]
  │   ├─ numberPassed (int) [Required]
  │   ├─ numberFailed (int) [Required]
  │   └─ numberSkipped (int) [Optional]
  └─ references [] [Optional]
      ├─ commit [Optional]
      │   ├─ id (string) [Required]
      │   └─ repositoryUri (string) [Required]
      └─ ref [Optional]
          ├─ name (string) [Required]
          └─ uri (string) [Required]

You may send the container repository as a separate entity in the same payload or in a separate request.

Common properties

Property	Type	Required	Description
`schemaVersion`	`string`	Yes	The schema version of the object.
`id`	`string`	Yes	The ID of the object in the source system.
`updateSequenceNumber`	`long`	Yes	A sequence number to compare when writing to the database. Objects are written following a last write wins strategy, therefore an object with a greater `UpdateSequenceNumber` is considered a more recently updated object.
`displayName`	`string`	Yes	The display name of the object.
`description`	`string`	No	The description of the object.
`url`	`string`	Yes	The URL from the provider which the object is accessible from.
`createdAt`	`string`	Yes	The date the object was created. Format: Instant (ISO8601 / RFC3339)
`createdBy`	`userReference`	No	A reference to the user that created the object. See userReference to learn more.
`lastUpdatedAt`	`string`	Yes	The date the object was last updated. Format: Instant (ISO8601 / RFC3339)
`lastUpdatedBy`	`userReference`	No	A reference to the user that last updated the object. See userReference to learn more.
`owners`	`list<userReference>`	No	List of references of users that own the object.
`thumbnail`	`thumbnail`	No	The thumbnail of the object. See Thumbnail to learn more.
`parentKey`	`entityKey`	No	The ID of the parent object. If null, it is a standalone object. See Entity key to learn more.
`containerKey`	`entityKey`	Yes	The container identifier that this object belongs to. See Entity key to learn more.
`permissions`	`list<Permissions>`	Yes	The permissions configuration of the object. See Permissions to learn more.
`associations`	`association`	No	List of objects associated with the object. Generally used to link an external object to a Atlassian object. See Association to learn more.

Build properties

Property	Type	Required	Description
`pipelineId`	`string`	Yes	An ID that relates a sequence of Builds. Depending on the use case, this might be a project ID, pipeline ID, plan key, etc. Whatever logical unit you use to group a sequence of Builds. The combination of `pipelineId` and `buildNumber` must uniquely identify the provided Build. Maximum length: 255
`buildNumber`	`long`	Yes	Identifies a Build within the sequence of Builds with the same `pipelineId`. Used to identify the "most recent" build in that sequence of Builds. The combination of `pipelineId` and `buildNumber` must uniquely identify the provided Build.
`state`	`string`	Yes	The state of the build. Allowed values: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, UNKNOWN
`label`	`string`	No	A human-readable text that provides information about the build. Maximum length: 255
`duration`	`long`	No	The duration of the build in seconds.
`testInfo`	`object`	No	The information about the tests in the build. Properties: `totalNumber` (int, required): The total number of tests considered during a build `numberPassed` (int, required): The number of tests that passed during a build `numberFailed` (int, required): The number of tests that failed during a build `numberSkipped` (int, optional): The number of tests that were skipped during a build
`references`	`array`	No	The references of the build. Maximum 5 references. Properties: `commit` (object, optional): The commit reference from which the build ran `id` (string, required): The ID of the commit. This must be the same as the commit hash. Maximum length: 255 `repositoryUri` (string, required): An identifier for the repository containing the commit `ref` (object, optional): The origin reference (eg tag, branch) from which the build ran `name` (string, required): The name of the reference the build ran on. Maximum length: 255 `uri` (string, required): An identifier for the reference

Example payload

1
2
{
  "objects" : [ {
    "id" : "repo-1",
    "updateSequenceNumber" : 1,
    "displayName" : "My Repository",
    "description" : "This is a test repository",
    "url" : "https://bitbucket.org/myproject/myrepo/src/master/",
    "lastUpdatedAt" : "2023-07-19T15:27:37.000Z",
    "atlassian:repository" : {
      "forkOf" : "repo-2",
      "avatar" : "avatar.png",
      "avatarDescription" : "something cool idk"
    }
  }, {
    "schemaVersion" : "2.0",
    "id" : "pipelineId/my-build-plan/buildId/16",
    "updateSequenceNumber" : 1,
    "displayName" : "My Project build #16",
    "description" : "My Project build #16: Successful deployment",
    "url" : "https://build.example.com/project1/build/16",
    "createdAt" : "2024-01-15T10:00:00.000Z",
    "createdBy" : {
      "accountId" : "accountId",
      "ari" : "ari:cloud:identity::third-party-user/abc/123"
    },
    "lastUpdatedAt" : "2024-01-20T14:30:00.000Z",
    "lastUpdatedBy" : {
      "accountId" : "accountId",
      "ari" : "ari:cloud:identity::third-party-user/abc/123"
    },
    "containerKey" : {
      "type" : "atlassian:repository",
      "value" : {
        "repositoryId" : "repo-1"
      }
    },
    "permissions" : [ {
      "action" : "read",
      "accessControls" : [ {
        "principals" : [ {
          "type" : "EVERYONE"
        } ]
      } ]
    } ],
    "atlassian:build" : {
      "pipelineId" : "my-build-plan",
      "buildNumber" : 16,
      "label" : "Release v2.1.0",
      "duration" : 47,
      "state" : "SUCCESSFUL",
      "testInfo" : {
        "totalNumber" : 150,
        "numberPassed" : 145,
        "numberFailed" : 5,
        "numberSkipped" : 0
      },
      "references" : [ {
        "commit" : {
          "id" : "08cd9c26b2b8d7cf6e6af6b49da8895d065c259f",
          "repositoryUri" : "https://bitbucket.org/atlassian/biij-vendor-api"
        },
        "ref" : {
          "name" : "feature/ISSUE-123-some-work",
          "uri" : "https://bitbucket.org/atlassian/biij-vendor-api/refs/feature/ISSUE-123-some-work"
        }
      } ]
    }
  } ]
}