User member of conversation

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 UserMemberOfConversation relationship represents the link between an Identity third-party user and an external conversation they are a member of within the Teamwork Graph. It allows you to:

Identify which conversations a specific third-party user is a member of
Find all third-party users that are members of a particular conversation
Traverse and analyze user-conversation relationships

Types

From Object Types	To Object Types
`Identity Third Party User - ati:cloud:identity:third-party-user`	`External Conversation - ati:cloud:graph:conversation`
`Identity User - ati:cloud:identity:user`

Cypher

Forward Query

GraphQL

1
2
query UserMemberOfConversation_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on ExternalConversation {
                  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:IdentityThirdPartyUser {ari: $id})-[:user_member_of_conversation]->(conversation:GraphConversation) RETURN conversation",
  "params": {
    "id": "$id"
  }
}

Inverse Query

GraphQL

1
2
query UserMemberOfConversation_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on ThirdPartyUser {
                  id
                }
                ... on AtlassianAccountUser {
                  id
                }
                ... on CustomerUser {
                  id
                }
                ... on AppUser {
                  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:IdentityThirdPartyUser)-[:user_member_of_conversation]->(conversation:GraphConversation {ari: $id}) RETURN user",
  "params": {
    "id": "$id"
  }
}