Project documentation entity

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 ProjectDocumentationEntity relationship represents the link between a Jira project and a documentation entity within the Teamwork Graph. It allows you to:

Retrieve documentation entities for a specific Jira project
Find which Jira projects relate to a documentation entity
Traverse and analyze project-documentation relationships

Types

From Object Types	To Object Types
`Jira Project - ati:cloud:jira:project`	`Confluence Space - ati:cloud:confluence:space`
	`Confluence Page - ati:cloud:confluence:page`
	`External Document - ati:cloud:jira:document`
	`External Document - ati:cloud:graph:document`

Cypher

Forward Query

GraphQL

1
2
query ProjectDocumentationEntity_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on ConfluenceSpace {
                  id
                }
                ... on ConfluencePage {
                  id
                }
                ... on DevOpsDocument {
                  id
                }
                ... on ExternalDocument {
                  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 (project:JiraProject {ari: $id})-[:project_documentation_entity]->(space:ConfluenceSpace) RETURN space",
  "params": {
    "id": "$id"
  }
}

Inverse Query

GraphQL

1
2
query ProjectDocumentationEntity_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on JiraProject {
                  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 (project:JiraProject)-[:project_documentation_entity]->(space:ConfluenceSpace {ari: $id}) RETURN project",
  "params": {
    "id": "$id"
  }
}