Preview features are available to all users and receive the same level of support as generally available features. Schemas, fields, and behavior may still change before general availability (GA), and breaking changes are subject to a minimum 1-month deprecation notice, announced in the Teamwork Graph changelog.

To review the current limitations, see Limitations and considerations.

To share feedback or report an issue, visit the Atlassian developer community.

Represents a software component tracked in Compass, Atlassian's developer experience platform. Components define microservices, libraries, or other software artifacts with associated metadata, ownership, and health metrics.

Available fields and properties

The Teamwork Graph API has the following fields and properties that you can use in your queries:

Object type fields are the core data fields of the object. Use these when you want to retrieve specific information about the object in your queries.
Cypher query properties are metadata properties used for filtering and traversing relationships between different object types in Teamwork Graph. Use Cypher query properties when you need to filter or navigate relationships between this object and other objects in your queries.

Object type fields

Cypher query properties

Object type fields

You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for Compass component.

Field	Type	Description
`description`	`String`	The description of the component.
`id`	`ID!`	The unique identifier (ID) of the component.
`name`	`String!`	The name of the component.
`ownerId`	`ID`	The unique identifier (ID) of the team that owns the component.
`state`	`String`	The state of the component.
`typeId`	`ID!`	The type of component.
`url`	`URL`	The URL to the component in Compass.

Available relationships

The following relationships are currently supported for Compass component:

From relationships

To relationships

Relationships where Compass component is the source object.

Relationship name	From object type	To object type
Compass component has Compass component link	Compass component	Compass component link