1
2
  objects {}
  ├─ schemaVersion (string) [Required]
  ├─ id (string) [Required]
  ├─ updateSequenceNumber (long) [Required]
  ├─ displayName (string) [Required]
  ├─ description (string) [Required]
  ├─ url (string) [Required]
  ├─ createdAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ createdBy (userReference) [Required]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  └─ lastUpdatedAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ lastUpdatedBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  └─ permissions [] [Required]
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:project
  ├─ key (string) [Optional]
  ├─ dueDate (string) [Optional]
  ├─ priority (string) [Optional]
  ├─ assignee (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  ├─ status (string) [Required]
  ├─ statusCategory (string) [Optional]
  ├─ attachments (List<Attachment>) [Optional]
      ├─ url (string) [Optional]
      ├─ thumbnailUrl (string) [Optional]
      ├─ title (string) [Optional]
      ├─ mimeType (string) [Optional]
      ├─ byteSize (long) [Optional]
      └─ fileType (string) [Optional]
  ├─ labels (List<string>) [Optional]
  ├─ environment (string) [Optional]
  ├─ resolution (string) [Optional]
  ├─ votesCount (integer) [Optional]
  └─ watchersCount (integer) [Optional]

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`	Yes	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`	Yes	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`	No	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.

Project properties

Property	Type	Required	Description
`key`	`string`	No	The key of the project. Validation: max-length: 255
`dueDate`	`string`	No	The due date for the project. Format: Instant (ISO8601 / RFC3339)
`priority`	`string`	No	The priority level of the project.
`assignee`	`userReference`	No	A reference to the user assigned to the project.
`status`	`string`	Yes	The current status of the project.
`statusCategory`	`string`	No	The status category of the project. Allowed values: `pending`, `in_progress`, `completed`
`attachments`	`List<Attachment>`	No	The attachments of the project. Validation: max-length: 10
`attachments.url`	`string`	No	The attachment URL. Format: Valid URL
`attachments.thumbnailUrl`	`string`	No	The attachment thumbnail URL. Format: Valid URL
`attachments.title`	`string`	No	The attachment title. Validation: max-length: 255
`attachments.mimeType`	`string`	No	The attachment file MIME type. Format: Valid MIME Type
`attachments.byteSize`	`long`	No	The size of the attachment in bytes. Format: int64
`attachments.fileType`	`string`	No	The file type of the attachment. Allowed values: `pdf`, `image`, `document`, `presentation`, `spreadsheet`, `video`, `audio`, `other`
`labels`	`List<string>`	No	The labels of the project. Validation: max-length: 100
`environment`	`string`	No	The environment of the project. Validation: max-length: 255
`resolution`	`string`	No	The resolution of the project. Validation: max-length: 255
`votesCount`	`integer`	No	The votes count of the project. Format: int64
`watchersCount`	`integer`	No	The watchers count of the project. Format: int64

Example payload

1
2
{
  "objects" : [ {
    "schemaVersion" : "2.0",
    "id" : "111212121",
    "updateSequenceNumber" : 1,
    "displayName" : "My project",
    "description" : "The project description",
    "url" : "https://www.example-project.com/share/projectId1",
    "createdAt" : "2024-04-16T09:31:32+00:00",
    "createdBy" : {
      "externalId" : "external-id-1"
    },
    "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
    "lastUpdatedBy" : {
      "externalId" : "external-id-1"
    },
    "permissions" : [ {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "ATLASSIAN_WORKSPACE"
        } ]
      } ]
    } ],
    "atlassian:project" : {
      "key" : "projectKey1",
      "priority" : "high",
      "status" : "In Progress",
      "statusCategory" : "in_progress",
      "environment" : "production",
      "resolution" : "Unresolved",
      "votesCount" : 1,
      "watchersCount" : 1,
      "dueDate" : "2024-04-16T09:31:32+00:00",
      "assignee" : {
        "externalId" : "external-id-2"
      },
      "attachments" : [ {
        "url" : "https://example-project.com/files/img_4659.png",
        "mimeType" : "image/png",
        "title" : "title",
        "byteSize" : 140288,
        "fileType" : "image"
      } ],
      "labels" : [ "label1", "label2" ]
    }
  } ]
}