Community
A grouping of subcommunities and domains.
type Community implements Auditable, Node, Organization {
createdBy: User
createdOn: DateTime
description: String
externalMappings(
limit: Int = 10
offset: Int = 0
order: [[ExternalMappingOrder]]
where: ExternalMappingFilter
): [ExternalMapping!]!
id: UUID!
meta: Boolean!
modifiedBy: User
modifiedOn: DateTime
name: String!
parent: Community
readPermissions(
limit: Int = 10
offset: Int = 0
order: [[ReadPermissionOrder]]
where: ReadPermissionFilter
): [ReadPermission!]!
responsibilities(
limit: Int = 10
offset: Int = 0
order: [[ResponsibilityOrder]]
where: ResponsibilityFilter
): [Responsibility!]!
subCommunities(
limit: Int = 10
offset: Int = 0
order: [[CommunityOrder]]
where: CommunityFilter
): [Community!]!
subDomains(
limit: Int = 10
offset: Int = 0
order: [[DomainOrder]]
where: DomainFilter
): [Domain!]!
subOrganizations(
limit: Int = 10
offset: Int = 0
order: [[OrganizationOrder]]
where: OrganizationFilter
): [Organization!]!
system: Boolean!
}Fields
createdBy ● User object
The user who created this resource.
createdOn ● DateTime scalar
The creation date of this resource.
description ● String scalar
The description of this organization.
externalMappings ● [ExternalMapping!]! non-null object
The list of external mappings corresponding to this community.
limit ● Int scalar
The maximum items to return.
offset ● Int scalar
The number of items to skip.
order ● [[ExternalMappingOrder]] list input
Sorting parameters.
where ● ExternalMappingFilter input
Filtering parameters.
id ● UUID! non-null scalar
The universally unique identifier of this node.
meta ● Boolean! non-null scalar
When true, this organization is not listed in the community or domain tree in the UI. Typically used for hidden domains such as *Issues*.
modifiedBy ● User object
The user who last modified this resource.
modifiedOn ● DateTime scalar
The last modified date of this resource.
name ● String! non-null scalar
The name of this organization.
parent ● Community object
The parent community of this organization. It is null for root communities.
readPermissions ● [ReadPermission!]! non-null object
The list of all read permissions directly assigned to this organization. This list does not include inherited read permissions.
limit ● Int scalar
The maximum items to return.
offset ● Int scalar
The number of items to skip.
order ● [[ReadPermissionOrder]] list input
Sorting parameters.
where ● ReadPermissionFilter input
Filtering parameters.
responsibilities ● [Responsibility!]! non-null object
The list of all responsibilities directly assigned to this organization. This list does not include inherited responsibilities.
limit ● Int scalar
The maximum items to return.
offset ● Int scalar
The number of items to skip.
order ● [[ResponsibilityOrder]] list input
Sorting parameters.
where ● ResponsibilityFilter input
Filtering parameters.
subCommunities ● [Community!]! non-null object
The list of communities available under this community.
limit ● Int scalar
The maximum items to return.
offset ● Int scalar
The number of items to skip.
order ● [[CommunityOrder]] list input
Sorting parameters.
where ● CommunityFilter input
Filtering parameters.
subDomains ● [Domain!]! non-null object
The list of domains available under this community.
limit ● Int scalar
The maximum items to return.
offset ● Int scalar
The number of items to skip.
order ● [[DomainOrder]] list input
Sorting parameters.
where ● DomainFilter input
Filtering parameters.
subOrganizations ● [Organization!]! non-null interface
The list of organizations available under this community.
limit ● Int scalar
The maximum items to return.
offset ● Int scalar
The number of items to skip.
order ● [[OrganizationOrder]] list input
Sorting parameters.
where ● OrganizationFilter input
Filtering parameters.
system ● Boolean! non-null scalar
Whether this resource is reserved by the system.
Interfaces
Auditable interface
An interface implemented by all types holding auditing information.
Node interface
A base interface implemented by all types.
Organization interface
The parent interface for both Community and Domain types.
Returned By
communities query
Member Of
Community object ● Domain object ● Organization interface ● ReadPermission object ● Responsibility object
Last updated
Was this helpful?