User collaborated on document

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 UserCollaboratedOnDocument relationship represents the link between an Identity user and an external document they collaborated on within the Teamwork Graph. It allows you to:

Track which users collaborated on specific external documents
Find all external documents that a particular user collaborated on
Traverse and analyze user-document relationships

Types

From Object Types	To Object Types
`Identity User - ati:cloud:identity:user`	`External Document - ati:cloud:jira:document`
`Identity Third Party User - ati:cloud:identity:third-party-user`	`External Document - ati:cloud:graph:document`

Cypher

Forward Query

GraphQL

1
2
query UserCollaboratedOnDocument_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... 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 (user:IdentityUser {ari: $id})-[:user_collaborated_on_document]->(document:GraphDocument) RETURN document",
  "params": {
    "id": "$id"
  }
}

Inverse Query

GraphQL

1
2
query UserCollaboratedOnDocument_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
                }
                ... on ThirdPartyUser {
                  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 (user:IdentityUser)-[:user_collaborated_on_document]->(document:GraphDocument {ari: $id}) RETURN user",
  "params": {
    "id": "$id"
  }
}