The Software service object type represents services in third parties. atlassian:software-service should be used to ingest software service-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) [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:software-service
  ├─ associationsMetadata (object) [Optional]
  ├─ namespace (string) [Optional]
  ├─ environment (string) [Optional]
  ├─ tags (List<string>) [Optional]
  ├─ tier (string) [Optional]
  └─ serviceType (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.

Software Service properties

Property	Type	Required	Description
`associationsMetadata`	`object`	No	A map that stores extra information about associations. Each key has a list of related metadata. Validation: max-length: 500
`namespace`	`string`	No	The namespace of this software service. It is usually used to separate organizations. Validation: max-length: 255
`environment`	`string`	No	The environment where the software service runs, for example: production, staging, or development. Validation: max-length: 255
`tags`	`List<string>`	No	Tags for this software service. Tags help to group or filter services. Validation: max-length: 500
`tier`	`string`	No	The importance level of the service, for example: Tier 1, Tier 2, or Tier 3. Validation: max-length: 255
`serviceType`	`string`	No	The type of service, for example: API, database, frontend, or backend. Validation: max-length: 255

Example payload

1
2
{
  "objects" : [ {
    "schemaVersion" : "2.0",
    "id" : "service-1",
    "updateSequenceNumber" : 123,
    "displayName" : "My Software Service",
    "description" : "A service that handles user authentication",
    "url" : "https://example-service.com",
    "createdAt" : "2024-04-16T09:01:32+00:00",
    "createdBy" : {
      "externalId" : "external-id-1",
      "email" : "user1@example.com"
    },
    "lastUpdatedAt" : "2024-04-16T09:01:42+00:00",
    "lastUpdatedBy" : {
      "externalId" : "external-id-2",
      "email" : "user2@example.com"
    },
    "permissions" : [ {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "ATLASSIAN_WORKSPACE"
        } ]
      } ]
    } ],
    "atlassian:software-service" : {
      "namespace" : "ns1",
      "environment" : "staging",
      "tags" : [ "authentication", "backend" ],
      "tier" : "1",
      "serviceType" : "API",
      "associationsMetadata" : {
        "svc2" : [ {
          "associationType" : "CALLS",
          "experience" : "ext"
        } ]
      }
    }
  } ]
}