Last updated Jan 14, 2025

Test plan

The Test plan object type represents a test plan object. atlassian:test-plan should be used to ingest test plan-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 (User) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Optional]
  └─ lastUpdatedAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ lastUpdatedBy (User) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Optional]
  └─ owners (List<User>) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Optional]
  └─ thumbnail [Optional]
      └─ externalUrl (string) []
  └─ parentKey (EntityKey) [Optional]
      ├─ type (string) [Required]
      └─ value (jsonNode) [Required]
  └─ containerKey (EntityKey) [Optional]
      ├─ type (string) [Required]
      └─ value (jsonNode) [Required]
  └─ permissions [] [Required]
      └─ accessControls []
         └─ principals []
            └─ type (string)
            └─ id (string)
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:test-plan
  └─ (No additional properties for this test plan object type)

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`	`user`	No	The user that created the object. See User to learn more.
`lastUpdatedAt`	`string`	Yes	The date the object was last updated. Format: Instant (ISO8601 / RFC3339)
`lastUpdatedBy`	`user`	No	The user that last updated the object. See User to learn more.
`owners`	`list<User>`	No	List 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.

Test plan properties

The Test plan object type only contains the common properties and no additional test plan-specific properties in this implementation.

Example payload

1
2
{
  "objects" : [ {
    "id" : "test-plan-example-1",
    "updateSequenceNumber" : 1,
    "displayName" : "Test plan noun example",
    "url" : "https://www.atlassian.com/share/test",
    "createdAt" : "2024-07-09T14:27:37.000Z",
    "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
    "createdBy" : {
      "externalId" : "external-id-1"
    },
    "permissions" : {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "EVERYONE"
        } ]
      } ]
    },
    "atlassian:test-plan" : { }
  } ]
}