Confluence space has Confluence whiteboard

The Teamwork Graph API is coming soon. The relationship types documented here are indicative of what will be available in the Graph via the Teamwork Graph API. Please note that relationships, 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 ConfluenceSpaceHasConfluenceWhiteboard relationship represents the link between a Confluence space and a Confluence whiteboard within the Teamwork Graph. It allows you to:

Retrieve whiteboards within a specific Confluence space
Find which Confluence space a whiteboard belongs to
Traverse and analyze space-whiteboard relationships

Types

From Object Types	To Object Types
`Confluence Space - ati:cloud:confluence:space`	`Confluence Whiteboard - ati:cloud:confluence:whiteboard`

Cypher

Forward Query

GraphQL

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

Params

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.

1
2
{
  "cypherQuery": "MATCH (space:ConfluenceSpace {ari: $id})-[:confluence_space_has_confluence_whiteboard]->(whiteboard:ConfluenceWhiteboard) RETURN whiteboard",
  "params": {
    "id": "$id"
  }
}

Inverse Query

GraphQL

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

Params

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.

1
2
{
  "cypherQuery": "MATCH (space:ConfluenceSpace)-[:confluence_space_has_confluence_whiteboard]->(whiteboard:ConfluenceWhiteboard {ari: $id}) RETURN space",
  "params": {
    "id": "$id"
  }
}