The Test status object type represents the status information of tests in third parties. atlassian:test-status should be used to ingest Test Status noun 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 (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]
  └─ owners (List<userReference>) [Optional]
  └─ thumbnail (Thumbnail) [Optional]
  └─ parentKey (EntityKey) [Optional]
  └─ permissions [] [Required]
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []

  atlassian:test-status
  ├─ status (string) [Required]
  ├─ statusPrecedence (string) [Optional]
  ├─ version (string) [Optional]
  └─ environment (string) [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`	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.
`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 status properties

Property	Type	Required	Description
`status`	`string`	Yes	Used to maintain the status of the Test Status entity. Example of values: PASSED, FAILED, SKIPPED, IN_PROGRESS, etc. Validation: max-length: 255
`statusPrecedence`	`string`	No	Used to define which status calculation logic is being accounted for, particularly whether final status takes precedence over non-final status or not. Allowed values: `final`, `non_final` Validation: max-length: 255
`version`	`string`	No	Used to specify a scope of the test status, in this case the respective test version. Example of values: 1, 1.2, 2-ix123. Validation: max-length: 255
`environment`	`string`	No	Used to specify a scope of the test status, in this case the respective environment where the test was executed. Example of values: QE, STAG, PROD. Validation: max-length: 255

Example payload

1
2
{
  "entities" : [ {
    "schemaVersion" : "2.0",
    "id" : "test-status-example-1",
    "updateSequenceNumber" : 1,
    "displayName" : "Test Status noun example",
    "description" : "Test Status noun ingestion request body example",
    "url" : "https://www.atlassian.com/share/test-status",
    "thumbnail" : {
      "externalUrl" : "https://thumbnail.com"
    },
    "createdAt" : "2024-07-09T14:27:37.000Z",
    "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
    "createdBy" : {
      "externalId" : "external-id-1"
    },
    "lastUpdatedBy" : {
      "email" : "e-mail@user2.com"
    },
    "permissions" : {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "EVERYONE"
        } ]
      } ]
    },
    "associations" : {
      "set" : [ {
        "associationType" : "issueIdOrKeys",
        "values" : [ "753042" ]
      } ]
    },
    "atlassian:test-status" : {
      "status" : "PASSED",
      "statusPrecedence" : "final",
      "version" : "1.0",
      "environment" : "production"
    }
  } ],
  "operationType" : "NORMAL"
}