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 link to an entity or resource on the internet associated with a Compass component.

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

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

Field	Type	Description
`id`	`ID!`	The ARI (ID) of the link.
`name`	`String`	An user-provided name of the link.
`type`	`CompassLinkType`	The type of link.
`url`	`URL`	An URL to the entity or resource on the internet.

Values for CompassLinkType

Value	Description
`CHAT_CHANNEL`	Chat Channels for contacting the owners/support of the component
`DASHBOARD`	A link to the dashboard of the component.
`DOCUMENT`	A link to the documentation of the component.
`ON_CALL`	A link to the on-call schedule of the component.
`OTHER_LINK`	Other link for a Component.
`PROJECT`	A link to the Jira or third-party project of the component.
`REPOSITORY`	A link to the source code repository of the component.

Available relationships

The following relationships are currently supported for Compass component link:

From relationships

To relationships

Relationships where Compass component link is the source object.

Relationship name	From object type	To object type
Compass component link is Jira space	Compass component link	Jira space