Atlassian user favorited Confluence whiteboard

The Teamwork Graph API is coming soon. The object and relationship types documented here are indicative of what will be available in the Graph via the Teamwork Graph API. Please note that relationships, objects, their properties, and functionality may change before and during the Early Access Program.

Interested in early access? Express your interest in joining the EAP

The AtlassianUserFavoritedConfluenceWhiteboard relationship represents the link between an Identity user and a Confluence whiteboard they favorited within the Teamwork Graph. It allows you to:

Track which users have favorited specific Confluence whiteboards
Find all Confluence whiteboards that a user has favorited
Traverse and analyze user-whiteboard relationships

Relationship type: Canonical

From object types	To object types
Identity User - `ati:cloud:identity:user`	Confluence Whiteboard - `ati:cloud:confluence:whiteboard`

Cypher

Note

We recommend sending parameterized Cypher queries as below instead of embedding the parameters directly in the query string. This approach will help ensure better performance.

Forward query

GraphQL

1
2
query AtlassianUserFavoritedConfluenceWhiteboard_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on ConfluenceWhiteboard {
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

Params

1
2
{
  "cypherQuery": "MATCH (user:IdentityUser {ari: $id})-[:atlassian_user_favorited_confluence_whiteboard]->(whiteboard:ConfluenceWhiteboard) RETURN whiteboard",
  "params": {
    "id": "$id"
  }
}

Inverse query

GraphQL

1
2
query AtlassianUserFavoritedConfluenceWhiteboard_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on AtlassianAccountUser {
                  id
                }
                ... on CustomerUser {
                  id
                }
                ... on AppUser {
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

Params

1
2
{
  "cypherQuery": "MATCH (user:IdentityUser)-[:atlassian_user_favorited_confluence_whiteboard]->(whiteboard:ConfluenceWhiteboard {ari: $id}) RETURN user",
  "params": {
    "id": "$id"
  }
}