Collibra Knowledge Graph API
The Knowledge Graph API is a lightweight graph query engine based on industry-standard GraphQL language. It provides a single API to query most of the Collibra entities, such as assets, communities, domains and types, using SQL-like filtering capabilities. You can also sort entities using any of the available properties and page the results.
API Endpoints
https://<your_collibra_url>/graphql/knowledgeGraph/v1Queries
assets
Description
A list of assets and complex relations.
Response
Returns [Asset]
Arguments
| Name | Description |
|---|---|
limit - Int
|
The maximum items to return. Default = 10 |
offset - Int
|
The number of items to skip. Default = 0 |
order - [AssetOrder]
|
Sorting parameters. |
where - AssetFilter
|
Filtering parameters. |
Example
Query
query Assets(
$limit: Int,
$offset: Int,
$order: [AssetOrder],
$where: AssetFilter
) {
assets(
limit: $limit,
offset: $offset,
order: $order,
where: $where
) {
attributes {
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
system
type {
...AttributeTypeFragment
}
}
booleanAttributes {
booleanValue
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
system
type {
...AttributeTypeFragment
}
}
createdBy {
email
enabled
firstName
fullName
id
lastName
system
}
createdOn
dateAttributes {
createdBy {
...UserFragment
}
createdOn
dateValue
id
modifiedBy {
...UserFragment
}
modifiedOn
system
type {
...AttributeTypeFragment
}
}
displayName
domain {
assets {
...AssetFragment
}
createdBy {
...UserFragment
}
createdOn
description
externalMappings {
...ExternalMappingFragment
}
id
meta
modifiedBy {
...UserFragment
}
modifiedOn
name
parent {
...CommunityFragment
}
readPermissions {
...ReadPermissionFragment
}
responsibilities {
...ResponsibilityFragment
}
system
type {
...DomainTypeFragment
}
}
externalMappings {
createdBy {
...UserFragment
}
createdOn
externalEntityId
externalSystemId
id
modifiedBy {
...UserFragment
}
modifiedOn
system
}
fullName
id
incomingRelations {
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
source {
...AssetFragment
}
system
target {
...AssetFragment
}
type {
...RelationTypeFragment
}
}
modifiedBy {
email
enabled
firstName
fullName
id
lastName
system
}
modifiedOn
multiValueAttributes {
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
stringValues
system
type {
...AttributeTypeFragment
}
}
numericAttributes {
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
numericValue
system
type {
...AttributeTypeFragment
}
}
outgoingRelations {
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
source {
...AssetFragment
}
system
target {
...AssetFragment
}
type {
...RelationTypeFragment
}
}
responsibilities {
asset {
...AssetFragment
}
community {
...CommunityFragment
}
createdBy {
...UserFragment
}
createdOn
domain {
...DomainFragment
}
id
modifiedBy {
...UserFragment
}
modifiedOn
role {
...RoleFragment
}
system
user {
...UserFragment
}
userGroup {
...UserGroupFragment
}
}
status {
createdBy {
...UserFragment
}
createdOn
description
id
modifiedBy {
...UserFragment
}
modifiedOn
name
system
}
stringAttributes {
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
stringValue
system
type {
...AttributeTypeFragment
}
}
system
tags {
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
name
system
}
type {
acronym
children {
...AssetTypeFragment
}
color
createdBy {
...UserFragment
}
createdOn
description
icon
id
modifiedBy {
...UserFragment
}
modifiedOn
name
parent {
...AssetTypeFragment
}
publicId
symbolType
system
}
}
}
Variables
{
"limit": 10,
"offset": 0,
"order": [AssetOrder],
"where": AssetFilter
}
Response
{
"data": {
"assets": [
{
"attributes": [Attribute],
"booleanAttributes": [BooleanAttribute],
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"dateAttributes": [DateAttribute],
"displayName": "abc123",
"domain": Domain,
"externalMappings": [ExternalMapping],
"fullName": "abc123",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"incomingRelations": [Relation],
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"multiValueAttributes": [MultiValueAttribute],
"numericAttributes": [NumericAttribute],
"outgoingRelations": [Relation],
"responsibilities": [Responsibility],
"status": Status,
"stringAttributes": [StringAttribute],
"system": false,
"tags": [Tag],
"type": AssetType
}
]
}
}
communities
Description
A list of communities.
Response
Returns [Community]
Arguments
| Name | Description |
|---|---|
limit - Int
|
The maximum items to return. Default = 10 |
offset - Int
|
The number of items to skip. Default = 0 |
order - [CommunityOrder]
|
Sorting parameters. |
where - CommunityFilter
|
Filtering parameters. |
Example
Query
query Communities(
$limit: Int,
$offset: Int,
$order: [CommunityOrder],
$where: CommunityFilter
) {
communities(
limit: $limit,
offset: $offset,
order: $order,
where: $where
) {
createdBy {
email
enabled
firstName
fullName
id
lastName
system
}
createdOn
description
externalMappings {
createdBy {
...UserFragment
}
createdOn
externalEntityId
externalSystemId
id
modifiedBy {
...UserFragment
}
modifiedOn
system
}
id
meta
modifiedBy {
email
enabled
firstName
fullName
id
lastName
system
}
modifiedOn
name
parent {
createdBy {
...UserFragment
}
createdOn
description
externalMappings {
...ExternalMappingFragment
}
id
meta
modifiedBy {
...UserFragment
}
modifiedOn
name
parent {
...CommunityFragment
}
readPermissions {
...ReadPermissionFragment
}
responsibilities {
...ResponsibilityFragment
}
subCommunities {
...CommunityFragment
}
subDomains {
...DomainFragment
}
subOrganizations {
...OrganizationFragment
}
system
}
readPermissions {
community {
...CommunityFragment
}
createdBy {
...UserFragment
}
createdOn
domain {
...DomainFragment
}
id
modifiedBy {
...UserFragment
}
modifiedOn
system
user {
...UserFragment
}
userGroup {
...UserGroupFragment
}
}
responsibilities {
asset {
...AssetFragment
}
community {
...CommunityFragment
}
createdBy {
...UserFragment
}
createdOn
domain {
...DomainFragment
}
id
modifiedBy {
...UserFragment
}
modifiedOn
role {
...RoleFragment
}
system
user {
...UserFragment
}
userGroup {
...UserGroupFragment
}
}
subCommunities {
createdBy {
...UserFragment
}
createdOn
description
externalMappings {
...ExternalMappingFragment
}
id
meta
modifiedBy {
...UserFragment
}
modifiedOn
name
parent {
...CommunityFragment
}
readPermissions {
...ReadPermissionFragment
}
responsibilities {
...ResponsibilityFragment
}
subCommunities {
...CommunityFragment
}
subDomains {
...DomainFragment
}
subOrganizations {
...OrganizationFragment
}
system
}
subDomains {
assets {
...AssetFragment
}
createdBy {
...UserFragment
}
createdOn
description
externalMappings {
...ExternalMappingFragment
}
id
meta
modifiedBy {
...UserFragment
}
modifiedOn
name
parent {
...CommunityFragment
}
readPermissions {
...ReadPermissionFragment
}
responsibilities {
...ResponsibilityFragment
}
system
type {
...DomainTypeFragment
}
}
subOrganizations {
createdBy {
...UserFragment
}
createdOn
description
id
meta
modifiedBy {
...UserFragment
}
modifiedOn
name
parent {
...CommunityFragment
}
readPermissions {
...ReadPermissionFragment
}
responsibilities {
...ResponsibilityFragment
}
system
}
system
}
}
Variables
{
"limit": 10,
"offset": 0,
"order": [CommunityOrder],
"where": CommunityFilter
}
Response
{
"data": {
"communities": [
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"externalMappings": [ExternalMapping],
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"meta": true,
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"name": "abc123",
"parent": Community,
"readPermissions": [ReadPermission],
"responsibilities": [Responsibility],
"subCommunities": [Community],
"subDomains": [Domain],
"subOrganizations": [Organization],
"system": false
}
]
}
}
complexRelations
Description
A list of complex relations.
Response
Returns [Asset]
Arguments
| Name | Description |
|---|---|
limit - Int
|
The maximum items to return. Default = 10 |
offset - Int
|
The number of items to skip. Default = 0 |
order - [AssetOrder]
|
Sorting parameters. |
where - AssetFilter
|
Filtering parameters. |
Example
Query
query ComplexRelations(
$limit: Int,
$offset: Int,
$order: [AssetOrder],
$where: AssetFilter
) {
complexRelations(
limit: $limit,
offset: $offset,
order: $order,
where: $where
) {
attributes {
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
system
type {
...AttributeTypeFragment
}
}
booleanAttributes {
booleanValue
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
system
type {
...AttributeTypeFragment
}
}
createdBy {
email
enabled
firstName
fullName
id
lastName
system
}
createdOn
dateAttributes {
createdBy {
...UserFragment
}
createdOn
dateValue
id
modifiedBy {
...UserFragment
}
modifiedOn
system
type {
...AttributeTypeFragment
}
}
displayName
domain {
assets {
...AssetFragment
}
createdBy {
...UserFragment
}
createdOn
description
externalMappings {
...ExternalMappingFragment
}
id
meta
modifiedBy {
...UserFragment
}
modifiedOn
name
parent {
...CommunityFragment
}
readPermissions {
...ReadPermissionFragment
}
responsibilities {
...ResponsibilityFragment
}
system
type {
...DomainTypeFragment
}
}
externalMappings {
createdBy {
...UserFragment
}
createdOn
externalEntityId
externalSystemId
id
modifiedBy {
...UserFragment
}
modifiedOn
system
}
fullName
id
incomingRelations {
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
source {
...AssetFragment
}
system
target {
...AssetFragment
}
type {
...RelationTypeFragment
}
}
modifiedBy {
email
enabled
firstName
fullName
id
lastName
system
}
modifiedOn
multiValueAttributes {
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
stringValues
system
type {
...AttributeTypeFragment
}
}
numericAttributes {
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
numericValue
system
type {
...AttributeTypeFragment
}
}
outgoingRelations {
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
source {
...AssetFragment
}
system
target {
...AssetFragment
}
type {
...RelationTypeFragment
}
}
responsibilities {
asset {
...AssetFragment
}
community {
...CommunityFragment
}
createdBy {
...UserFragment
}
createdOn
domain {
...DomainFragment
}
id
modifiedBy {
...UserFragment
}
modifiedOn
role {
...RoleFragment
}
system
user {
...UserFragment
}
userGroup {
...UserGroupFragment
}
}
status {
createdBy {
...UserFragment
}
createdOn
description
id
modifiedBy {
...UserFragment
}
modifiedOn
name
system
}
stringAttributes {
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
stringValue
system
type {
...AttributeTypeFragment
}
}
system
tags {
createdBy {
...UserFragment
}
createdOn
id
modifiedBy {
...UserFragment
}
modifiedOn
name
system
}
type {
acronym
children {
...AssetTypeFragment
}
color
createdBy {
...UserFragment
}
createdOn
description
icon
id
modifiedBy {
...UserFragment
}
modifiedOn
name
parent {
...AssetTypeFragment
}
publicId
symbolType
system
}
}
}
Variables
{
"limit": 10,
"offset": 0,
"order": [AssetOrder],
"where": AssetFilter
}
Response
{
"data": {
"complexRelations": [
{
"attributes": [Attribute],
"booleanAttributes": [BooleanAttribute],
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"dateAttributes": [DateAttribute],
"displayName": "xyz789",
"domain": Domain,
"externalMappings": [ExternalMapping],
"fullName": "abc123",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"incomingRelations": [Relation],
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"multiValueAttributes": [MultiValueAttribute],
"numericAttributes": [NumericAttribute],
"outgoingRelations": [Relation],
"responsibilities": [Responsibility],
"status": Status,
"stringAttributes": [StringAttribute],
"system": false,
"tags": [Tag],
"type": AssetType
}
]
}
}
domains
Description
A list of domains.
Response
Returns [Domain]
Arguments
| Name | Description |
|---|---|
limit - Int
|
The maximum items to return. Default = 10 |
offset - Int
|
The number of items to skip. Default = 0 |
order - [DomainOrder]
|
Sorting parameters. |
where - DomainFilter
|
Filtering parameters. |
Example
Query
query Domains(
$limit: Int,
$offset: Int,
$order: [DomainOrder],
$where: DomainFilter
) {
domains(
limit: $limit,
offset: $offset,
order: $order,
where: $where
) {
assets {
attributes {
...AttributeFragment
}
booleanAttributes {
...BooleanAttributeFragment
}
createdBy {
...UserFragment
}
createdOn
dateAttributes {
...DateAttributeFragment
}
displayName
domain {
...DomainFragment
}
externalMappings {
...ExternalMappingFragment
}
fullName
id
incomingRelations {
...RelationFragment
}
modifiedBy {
...UserFragment
}
modifiedOn
multiValueAttributes {
...MultiValueAttributeFragment
}
numericAttributes {
...NumericAttributeFragment
}
outgoingRelations {
...RelationFragment
}
responsibilities {
...ResponsibilityFragment
}
status {
...StatusFragment
}
stringAttributes {
...StringAttributeFragment
}
system
tags {
...TagFragment
}
type {
...AssetTypeFragment
}
}
createdBy {
email
enabled
firstName
fullName
id
lastName
system
}
createdOn
description
externalMappings {
createdBy {
...UserFragment
}
createdOn
externalEntityId
externalSystemId
id
modifiedBy {
...UserFragment
}
modifiedOn
system
}
id
meta
modifiedBy {
email
enabled
firstName
fullName
id
lastName
system
}
modifiedOn
name
parent {
createdBy {
...UserFragment
}
createdOn
description
externalMappings {
...ExternalMappingFragment
}
id
meta
modifiedBy {
...UserFragment
}
modifiedOn
name
parent {
...CommunityFragment
}
readPermissions {
...ReadPermissionFragment
}
responsibilities {
...ResponsibilityFragment
}
subCommunities {
...CommunityFragment
}
subDomains {
...DomainFragment
}
subOrganizations {
...OrganizationFragment
}
system
}
readPermissions {
community {
...CommunityFragment
}
createdBy {
...UserFragment
}
createdOn
domain {
...DomainFragment
}
id
modifiedBy {
...UserFragment
}
modifiedOn
system
user {
...UserFragment
}
userGroup {
...UserGroupFragment
}
}
responsibilities {
asset {
...AssetFragment
}
community {
...CommunityFragment
}
createdBy {
...UserFragment
}
createdOn
domain {
...DomainFragment
}
id
modifiedBy {
...UserFragment
}
modifiedOn
role {
...RoleFragment
}
system
user {
...UserFragment
}
userGroup {
...UserGroupFragment
}
}
system
type {
children {
...DomainTypeFragment
}
createdBy {
...UserFragment
}
createdOn
description
id
meta
modifiedBy {
...UserFragment
}
modifiedOn
name
parent {
...DomainTypeFragment
}
publicId
system
}
}
}
Variables
{
"limit": 10,
"offset": 0,
"order": [DomainOrder],
"where": DomainFilter
}
Response
{
"data": {
"domains": [
{
"assets": [Asset],
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"externalMappings": [ExternalMapping],
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"meta": true,
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"name": "abc123",
"parent": Community,
"readPermissions": [ReadPermission],
"responsibilities": [Responsibility],
"system": true,
"type": DomainType
}
]
}
}
Types
Asset
Description
A verbal designation of a concept in a specific subject field.
Fields
| Field Name | Description |
|---|---|
attributes - [Attribute!]!
|
The list of all attributes available for this asset. |
Arguments
|
|
booleanAttributes - [BooleanAttribute!]!
|
The boolean attributes of this asset. |
Arguments
|
|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
dateAttributes - [DateAttribute!]!
|
The date attributes of this asset. |
Arguments
|
|
displayName - String
|
The display name of this asset. |
domain - Domain!
|
The parent domain of this asset. |
externalMappings - [ExternalMapping!]!
|
The list of external mappings of this asset. |
Arguments
|
|
fullName - String!
|
The full name of this asset. This value is always unique in its parent domain. |
id - UUID!
|
The universally unique identifier of this node. |
incomingRelations - [Relation!]!
|
The list of incoming relations for this asset. |
Arguments
|
|
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
multiValueAttributes - [MultiValueAttribute!]!
|
The multi-value attributes of this asset. |
Arguments
|
|
numericAttributes - [NumericAttribute!]!
|
The numeric attributes of this asset. |
Arguments
|
|
outgoingRelations - [Relation!]!
|
The list of outgoing relations for this asset. |
Arguments
|
|
responsibilities - [Responsibility!]!
|
The list of responsibilities for this asset. |
Arguments
|
|
status - Status
|
The status of this asset. |
stringAttributes - [StringAttribute!]!
|
The string attributes of this asset. |
Arguments
|
|
system - Boolean!
|
Whether this resource is reserved by the system. |
tags - [Tag!]!
|
The list of tags of this asset. |
Arguments
|
|
type - AssetType!
|
The asset type of this asset. |
Example
{
"attributes": [Attribute],
"booleanAttributes": [BooleanAttribute],
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"dateAttributes": [DateAttribute],
"displayName": "abc123",
"domain": Domain,
"externalMappings": [ExternalMapping],
"fullName": "xyz789",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"incomingRelations": [Relation],
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"multiValueAttributes": [MultiValueAttribute],
"numericAttributes": [NumericAttribute],
"outgoingRelations": [Relation],
"responsibilities": [Responsibility],
"status": Status,
"stringAttributes": [StringAttribute],
"system": true,
"tags": [Tag],
"type": AssetType
}
AssetCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - AssetFilter
|
All items in the collection match the given criteria. |
any - AssetFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - AssetFilter
|
None of the items in the collection matches the given criteria. |
typePublicId - String
|
The type public identifier. |
Example
{
"all": AssetFilter,
"any": AssetFilter,
"empty": false,
"none": AssetFilter,
"typePublicId": "xyz789"
}
AssetFilter
Description
A verbal designation of a concept in a specific subject field.
Fields
| Input Field | Description |
|---|---|
_and - [AssetFilter]
|
|
_or - [AssetFilter]
|
|
attributes - AttributeCollectionFilter
|
The list of all attributes available for this asset. |
booleanAttributes - BooleanAttributeCollectionFilter
|
The boolean attributes of this asset. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
dateAttributes - DateAttributeCollectionFilter
|
The date attributes of this asset. |
displayName - StringFilter
|
The display name of this asset. |
domain - DomainReferenceFilter
|
The parent domain of this asset. |
externalMappings - ExternalMappingCollectionFilter
|
The list of external mappings of this asset. |
fullName - StringFilter
|
The full name of this asset. This value is always unique in its parent domain. |
id - UUIDFilter
|
The universally unique identifier of this node. |
incomingRelations - RelationCollectionFilter
|
The list of incoming relations for this asset. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
multiValueAttributes - MultiValueAttributeCollectionFilter
|
The multi-value attributes of this asset. |
numericAttributes - NumericAttributeCollectionFilter
|
The numeric attributes of this asset. |
outgoingRelations - RelationCollectionFilter
|
The list of outgoing relations for this asset. |
responsibilities - ResponsibilityCollectionFilter
|
The list of responsibilities for this asset. |
status - StatusReferenceFilter
|
The status of this asset. |
stringAttributes - StringAttributeCollectionFilter
|
The string attributes of this asset. |
system - Boolean
|
Whether this resource is reserved by the system. |
tags - TagCollectionFilter
|
The list of tags of this asset. |
type - AssetTypeReferenceFilter
|
The asset type of this asset. |
Example
{
"_and": [AssetFilter],
"_or": [AssetFilter],
"attributes": AttributeCollectionFilter,
"booleanAttributes": BooleanAttributeCollectionFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"dateAttributes": DateAttributeCollectionFilter,
"displayName": StringFilter,
"domain": DomainReferenceFilter,
"externalMappings": ExternalMappingCollectionFilter,
"fullName": StringFilter,
"id": UUIDFilter,
"incomingRelations": RelationCollectionFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"multiValueAttributes": MultiValueAttributeCollectionFilter,
"numericAttributes": NumericAttributeCollectionFilter,
"outgoingRelations": RelationCollectionFilter,
"responsibilities": ResponsibilityCollectionFilter,
"status": StatusReferenceFilter,
"stringAttributes": StringAttributeCollectionFilter,
"system": false,
"tags": TagCollectionFilter,
"type": AssetTypeReferenceFilter
}
AssetOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
displayName - SortOrder
|
The display name of this asset. |
domain - [DomainOrder]
|
The parent domain of this asset. |
fullName - SortOrder
|
The full name of this asset. This value is always unique in its parent domain. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
status - [StatusOrder]
|
The status of this asset. |
system - SortOrder
|
Whether this resource is reserved by the system. |
type - [AssetTypeOrder]
|
The asset type of this asset. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"displayName": "asc",
"domain": [DomainOrder],
"fullName": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"status": [StatusOrder],
"system": "asc",
"type": [AssetTypeOrder]
}
AssetReferenceFilter
Description
A verbal designation of a concept in a specific subject field.
Fields
| Input Field | Description |
|---|---|
_and - [AssetReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [AssetReferenceFilter]
|
|
attributes - AttributeCollectionFilter
|
The list of all attributes available for this asset. |
booleanAttributes - BooleanAttributeCollectionFilter
|
The boolean attributes of this asset. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
dateAttributes - DateAttributeCollectionFilter
|
The date attributes of this asset. |
displayName - StringFilter
|
The display name of this asset. |
domain - DomainReferenceFilter
|
The parent domain of this asset. |
externalMappings - ExternalMappingCollectionFilter
|
The list of external mappings of this asset. |
fullName - StringFilter
|
The full name of this asset. This value is always unique in its parent domain. |
id - UUIDFilter
|
The universally unique identifier of this node. |
incomingRelations - RelationCollectionFilter
|
The list of incoming relations for this asset. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
multiValueAttributes - MultiValueAttributeCollectionFilter
|
The multi-value attributes of this asset. |
numericAttributes - NumericAttributeCollectionFilter
|
The numeric attributes of this asset. |
outgoingRelations - RelationCollectionFilter
|
The list of outgoing relations for this asset. |
responsibilities - ResponsibilityCollectionFilter
|
The list of responsibilities for this asset. |
status - StatusReferenceFilter
|
The status of this asset. |
stringAttributes - StringAttributeCollectionFilter
|
The string attributes of this asset. |
system - Boolean
|
Whether this resource is reserved by the system. |
tags - TagCollectionFilter
|
The list of tags of this asset. |
type - AssetTypeReferenceFilter
|
The asset type of this asset. |
Example
{
"_and": [AssetReferenceFilter],
"_null": false,
"_or": [AssetReferenceFilter],
"attributes": AttributeCollectionFilter,
"booleanAttributes": BooleanAttributeCollectionFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"dateAttributes": DateAttributeCollectionFilter,
"displayName": StringFilter,
"domain": DomainReferenceFilter,
"externalMappings": ExternalMappingCollectionFilter,
"fullName": StringFilter,
"id": UUIDFilter,
"incomingRelations": RelationCollectionFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"multiValueAttributes": MultiValueAttributeCollectionFilter,
"numericAttributes": NumericAttributeCollectionFilter,
"outgoingRelations": RelationCollectionFilter,
"responsibilities": ResponsibilityCollectionFilter,
"status": StatusReferenceFilter,
"stringAttributes": StringAttributeCollectionFilter,
"system": false,
"tags": TagCollectionFilter,
"type": AssetTypeReferenceFilter
}
AssetType
Description
The type of an asset or complex relation.
Fields
| Field Name | Description |
|---|---|
acronym - String
|
The acronym of this type. |
children - [AssetType!]!
|
The list of child asset types of this asset type. |
Arguments
|
|
color - String!
|
The user interface color of this type. |
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
description - String
|
The description of this type. |
icon - String
|
The user interface icon of this type. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
name - String!
|
The name of this type. |
parent - AssetType
|
The parent asset type of this asset type. |
publicId - String!
|
The public identifier of this type. |
symbolType - String
|
|
system - Boolean!
|
Whether this resource is reserved by the system. |
Example
{
"acronym": "xyz789",
"children": [AssetType],
"color": "xyz789",
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"description": "xyz789",
"icon": "abc123",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"name": "abc123",
"parent": AssetType,
"publicId": "xyz789",
"symbolType": "abc123",
"system": false
}
AssetTypeCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - AssetTypeFilter
|
All items in the collection match the given criteria. |
any - AssetTypeFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - AssetTypeFilter
|
None of the items in the collection matches the given criteria. |
Example
{
"all": AssetTypeFilter,
"any": AssetTypeFilter,
"empty": false,
"none": AssetTypeFilter
}
AssetTypeFilter
Description
The type of an asset or complex relation.
Fields
| Input Field | Description |
|---|---|
_and - [AssetTypeFilter]
|
|
_or - [AssetTypeFilter]
|
|
acronym - StringFilter
|
The acronym of this type. |
children - AssetTypeCollectionFilter
|
The list of child asset types of this asset type. |
color - StringFilter
|
The user interface color of this type. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this type. |
icon - StringFilter
|
The user interface icon of this type. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this type. |
parent - AssetTypeReferenceFilter
|
The parent asset type of this asset type. |
publicId - StringFilter
|
The public identifier of this type. |
symbolType - StringFilter
|
|
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [AssetTypeFilter],
"_or": [AssetTypeFilter],
"acronym": StringFilter,
"children": AssetTypeCollectionFilter,
"color": StringFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"icon": StringFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"parent": AssetTypeReferenceFilter,
"publicId": StringFilter,
"symbolType": StringFilter,
"system": false
}
AssetTypeOrder
Fields
| Input Field | Description |
|---|---|
acronym - SortOrder
|
The acronym of this type. |
color - SortOrder
|
The user interface color of this type. |
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
description - SortOrder
|
The description of this type. |
icon - SortOrder
|
The user interface icon of this type. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
name - SortOrder
|
The name of this type. |
parent - [AssetTypeOrder]
|
The parent asset type of this asset type. |
publicId - SortOrder
|
The public identifier of this type. |
symbolType - SortOrder
|
|
system - SortOrder
|
Whether this resource is reserved by the system. |
Example
{
"acronym": "asc",
"color": "asc",
"createdBy": [UserOrder],
"createdOn": "asc",
"description": "asc",
"icon": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"name": "asc",
"parent": [AssetTypeOrder],
"publicId": "asc",
"symbolType": "asc",
"system": "asc"
}
AssetTypeReferenceFilter
Description
The type of an asset or complex relation.
Fields
| Input Field | Description |
|---|---|
_and - [AssetTypeReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [AssetTypeReferenceFilter]
|
|
acronym - StringFilter
|
The acronym of this type. |
children - AssetTypeCollectionFilter
|
The list of child asset types of this asset type. |
color - StringFilter
|
The user interface color of this type. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this type. |
icon - StringFilter
|
The user interface icon of this type. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this type. |
parent - AssetTypeReferenceFilter
|
The parent asset type of this asset type. |
publicId - StringFilter
|
The public identifier of this type. |
symbolType - StringFilter
|
|
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [AssetTypeReferenceFilter],
"_null": false,
"_or": [AssetTypeReferenceFilter],
"acronym": StringFilter,
"children": AssetTypeCollectionFilter,
"color": StringFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"icon": StringFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"parent": AssetTypeReferenceFilter,
"publicId": StringFilter,
"symbolType": StringFilter,
"system": false
}
Attribute
Description
An attribute that is linked to an asset.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
system - Boolean!
|
Whether this resource is reserved by the system. |
type - AttributeType!
|
The attribute type of this attribute. |
Possible Types
| Attribute Types |
|---|
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"system": false,
"type": AttributeType
}
AttributeCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - AttributeFilter
|
All items in the collection match the given criteria. |
any - AttributeFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - AttributeFilter
|
None of the items in the collection matches the given criteria. |
typePublicId - String
|
The type public identifier. |
Example
{
"all": AttributeFilter,
"any": AttributeFilter,
"empty": true,
"none": AttributeFilter,
"typePublicId": "abc123"
}
AttributeFilter
Description
An attribute that is linked to an asset.
Fields
| Input Field | Description |
|---|---|
_and - [AttributeFilter]
|
|
_or - [AttributeFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
system - Boolean
|
Whether this resource is reserved by the system. |
type - AttributeTypeReferenceFilter
|
The attribute type of this attribute. |
Example
{
"_and": [AttributeFilter],
"_or": [AttributeFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"system": false,
"type": AttributeTypeReferenceFilter
}
AttributeOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
system - SortOrder
|
Whether this resource is reserved by the system. |
type - [AttributeTypeOrder]
|
The attribute type of this attribute. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"system": "asc",
"type": [AttributeTypeOrder]
}
AttributeReferenceFilter
Description
An attribute that is linked to an asset.
Fields
| Input Field | Description |
|---|---|
_and - [AttributeReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [AttributeReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
system - Boolean
|
Whether this resource is reserved by the system. |
type - AttributeTypeReferenceFilter
|
The attribute type of this attribute. |
Example
{
"_and": [AttributeReferenceFilter],
"_null": true,
"_or": [AttributeReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"system": false,
"type": AttributeTypeReferenceFilter
}
AttributeType
Description
The type of an attribute.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
description - String
|
The description of this attribute type. |
id - UUID!
|
The universally unique identifier of this node. |
isInteger - Boolean
|
Whether this attribute type defines an integer or a decimal in case of a NUMERIC kind. |
kind - String!
|
The kind of this attribute type. Possible values are: BOOLEAN, STRING, NUMERIC, DATE, DATE_TIME, SINGLE_VALUE_LIST, MULTI_VALUE_LIST, or SCRIPT. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
name - String!
|
The name of this attribute type. |
publicId - String!
|
The public identifier of this attribute type. |
stringType - String
|
The string type of this attribute type in case of a STRING kind. Possible values are: RICH_TEXT or PLAIN_TEXT. |
system - Boolean!
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"isInteger": true,
"kind": "xyz789",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"name": "abc123",
"publicId": "abc123",
"stringType": "xyz789",
"system": true
}
AttributeTypeFilter
Description
The type of an attribute.
Fields
| Input Field | Description |
|---|---|
_and - [AttributeTypeFilter]
|
|
_or - [AttributeTypeFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this attribute type. |
id - UUIDFilter
|
The universally unique identifier of this node. |
isInteger - Boolean
|
Whether this attribute type defines an integer or a decimal in case of a NUMERIC kind. |
kind - StringFilter
|
The kind of this attribute type. Possible values are: BOOLEAN, STRING, NUMERIC, DATE, DATE_TIME, SINGLE_VALUE_LIST, MULTI_VALUE_LIST, or SCRIPT. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this attribute type. |
publicId - StringFilter
|
The public identifier of this attribute type. |
stringType - StringFilter
|
The string type of this attribute type in case of a STRING kind. Possible values are: RICH_TEXT or PLAIN_TEXT. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [AttributeTypeFilter],
"_or": [AttributeTypeFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"id": UUIDFilter,
"isInteger": true,
"kind": StringFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"publicId": StringFilter,
"stringType": StringFilter,
"system": false
}
AttributeTypeOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
description - SortOrder
|
The description of this attribute type. |
id - SortOrder
|
The universally unique identifier of this node. |
isInteger - SortOrder
|
Whether this attribute type defines an integer or a decimal in case of a NUMERIC kind. |
kind - SortOrder
|
The kind of this attribute type. Possible values are: BOOLEAN, STRING, NUMERIC, DATE, DATE_TIME, SINGLE_VALUE_LIST, MULTI_VALUE_LIST, or SCRIPT. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
name - SortOrder
|
The name of this attribute type. |
publicId - SortOrder
|
The public identifier of this attribute type. |
stringType - SortOrder
|
The string type of this attribute type in case of a STRING kind. Possible values are: RICH_TEXT or PLAIN_TEXT. |
system - SortOrder
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"description": "asc",
"id": "asc",
"isInteger": "asc",
"kind": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"name": "asc",
"publicId": "asc",
"stringType": "asc",
"system": "asc"
}
AttributeTypeReferenceFilter
Description
The type of an attribute.
Fields
| Input Field | Description |
|---|---|
_and - [AttributeTypeReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [AttributeTypeReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this attribute type. |
id - UUIDFilter
|
The universally unique identifier of this node. |
isInteger - Boolean
|
Whether this attribute type defines an integer or a decimal in case of a NUMERIC kind. |
kind - StringFilter
|
The kind of this attribute type. Possible values are: BOOLEAN, STRING, NUMERIC, DATE, DATE_TIME, SINGLE_VALUE_LIST, MULTI_VALUE_LIST, or SCRIPT. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this attribute type. |
publicId - StringFilter
|
The public identifier of this attribute type. |
stringType - StringFilter
|
The string type of this attribute type in case of a STRING kind. Possible values are: RICH_TEXT or PLAIN_TEXT. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [AttributeTypeReferenceFilter],
"_null": true,
"_or": [AttributeTypeReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"id": UUIDFilter,
"isInteger": true,
"kind": StringFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"publicId": StringFilter,
"stringType": StringFilter,
"system": true
}
Auditable
Description
An interface implemented by all types holding auditing information.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
system - Boolean!
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"system": true
}
AuditableFilter
Description
An interface implemented by all types holding auditing information.
Fields
| Input Field | Description |
|---|---|
_and - [AuditableFilter]
|
|
_or - [AuditableFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [AuditableFilter],
"_or": [AuditableFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"system": false
}
AuditableReferenceFilter
Description
An interface implemented by all types holding auditing information.
Fields
| Input Field | Description |
|---|---|
_and - [AuditableReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [AuditableReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [AuditableReferenceFilter],
"_null": false,
"_or": [AuditableReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"system": true
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
BooleanAttribute
Description
An attribute that has a boolean value.
Fields
| Field Name | Description |
|---|---|
booleanValue - Boolean
|
The boolean value of this attribute. |
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
system - Boolean!
|
Whether this resource is reserved by the system. |
type - AttributeType!
|
The attribute type of this attribute. |
Example
{
"booleanValue": false,
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"system": false,
"type": AttributeType
}
BooleanAttributeCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - BooleanAttributeFilter
|
All items in the collection match the given criteria. |
any - BooleanAttributeFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - BooleanAttributeFilter
|
None of the items in the collection matches the given criteria. |
typePublicId - String
|
The type public identifier. |
Example
{
"all": BooleanAttributeFilter,
"any": BooleanAttributeFilter,
"empty": false,
"none": BooleanAttributeFilter,
"typePublicId": "xyz789"
}
BooleanAttributeFilter
Description
An attribute that has a boolean value.
Fields
| Input Field | Description |
|---|---|
_and - [BooleanAttributeFilter]
|
|
_or - [BooleanAttributeFilter]
|
|
booleanValue - Boolean
|
The boolean value of this attribute. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
system - Boolean
|
Whether this resource is reserved by the system. |
type - AttributeTypeReferenceFilter
|
The attribute type of this attribute. |
Example
{
"_and": [BooleanAttributeFilter],
"_or": [BooleanAttributeFilter],
"booleanValue": true,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"system": false,
"type": AttributeTypeReferenceFilter
}
BooleanAttributeOrder
Fields
| Input Field | Description |
|---|---|
booleanValue - SortOrder
|
The boolean value of this attribute. |
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
system - SortOrder
|
Whether this resource is reserved by the system. |
type - [AttributeTypeOrder]
|
The attribute type of this attribute. |
Example
{
"booleanValue": "asc",
"createdBy": [UserOrder],
"createdOn": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"system": "asc",
"type": [AttributeTypeOrder]
}
BooleanAttributeReferenceFilter
Description
An attribute that has a boolean value.
Fields
| Input Field | Description |
|---|---|
_and - [BooleanAttributeReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [BooleanAttributeReferenceFilter]
|
|
booleanValue - Boolean
|
The boolean value of this attribute. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
system - Boolean
|
Whether this resource is reserved by the system. |
type - AttributeTypeReferenceFilter
|
The attribute type of this attribute. |
Example
{
"_and": [BooleanAttributeReferenceFilter],
"_null": false,
"_or": [BooleanAttributeReferenceFilter],
"booleanValue": false,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"system": true,
"type": AttributeTypeReferenceFilter
}
Community
Description
A grouping of subcommunities and domains.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
description - String
|
The description of this organization. |
externalMappings - [ExternalMapping!]!
|
The list of external mappings corresponding to this community. |
Arguments
|
|
id - UUID!
|
The universally unique identifier of this node. |
meta - Boolean!
|
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
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
name - String!
|
The name of this organization. |
parent - Community
|
The parent community of this organization. It is null for root communities. |
readPermissions - [ReadPermission!]!
|
The list of all read permissions directly assigned to this organization. This list does not include inherited read permissions. |
Arguments
|
|
responsibilities - [Responsibility!]!
|
The list of all responsibilities directly assigned to this organization. This list does not include inherited responsibilities. |
Arguments
|
|
subCommunities - [Community!]!
|
The list of communities available under this community. |
Arguments
|
|
subDomains - [Domain!]!
|
The list of domains available under this community. |
Arguments
|
|
subOrganizations - [Organization!]!
|
The list of organizations available under this community. |
Arguments
|
|
system - Boolean!
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"description": "xyz789",
"externalMappings": [ExternalMapping],
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"meta": true,
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"name": "xyz789",
"parent": Community,
"readPermissions": [ReadPermission],
"responsibilities": [Responsibility],
"subCommunities": [Community],
"subDomains": [Domain],
"subOrganizations": [Organization],
"system": false
}
CommunityCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - CommunityFilter
|
All items in the collection match the given criteria. |
any - CommunityFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - CommunityFilter
|
None of the items in the collection matches the given criteria. |
Example
{
"all": CommunityFilter,
"any": CommunityFilter,
"empty": true,
"none": CommunityFilter
}
CommunityFilter
Description
A grouping of subcommunities and domains.
Fields
| Input Field | Description |
|---|---|
_and - [CommunityFilter]
|
|
_or - [CommunityFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this organization. |
externalMappings - ExternalMappingCollectionFilter
|
The list of external mappings corresponding to this community. |
id - UUIDFilter
|
The universally unique identifier of this node. |
meta - Boolean
|
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 - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this organization. |
parent - CommunityReferenceFilter
|
The parent community of this organization. It is null for root communities. |
readPermissions - ReadPermissionCollectionFilter
|
The list of all read permissions directly assigned to this organization. This list does not include inherited read permissions. |
responsibilities - ResponsibilityCollectionFilter
|
The list of all responsibilities directly assigned to this organization. This list does not include inherited responsibilities. |
subCommunities - CommunityCollectionFilter
|
The list of communities available under this community. |
subDomains - DomainCollectionFilter
|
The list of domains available under this community. |
subOrganizations - OrganizationCollectionFilter
|
The list of organizations available under this community. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [CommunityFilter],
"_or": [CommunityFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"externalMappings": ExternalMappingCollectionFilter,
"id": UUIDFilter,
"meta": false,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"parent": CommunityReferenceFilter,
"readPermissions": ReadPermissionCollectionFilter,
"responsibilities": ResponsibilityCollectionFilter,
"subCommunities": CommunityCollectionFilter,
"subDomains": DomainCollectionFilter,
"subOrganizations": OrganizationCollectionFilter,
"system": true
}
CommunityOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
description - SortOrder
|
The description of this organization. |
id - SortOrder
|
The universally unique identifier of this node. |
meta - SortOrder
|
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 - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
name - SortOrder
|
The name of this organization. |
parent - [CommunityOrder]
|
The parent community of this organization. It is null for root communities. |
system - SortOrder
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"description": "asc",
"id": "asc",
"meta": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"name": "asc",
"parent": [CommunityOrder],
"system": "asc"
}
CommunityReferenceFilter
Description
A grouping of subcommunities and domains.
Fields
| Input Field | Description |
|---|---|
_and - [CommunityReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [CommunityReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this organization. |
externalMappings - ExternalMappingCollectionFilter
|
The list of external mappings corresponding to this community. |
id - UUIDFilter
|
The universally unique identifier of this node. |
meta - Boolean
|
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 - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this organization. |
parent - CommunityReferenceFilter
|
The parent community of this organization. It is null for root communities. |
readPermissions - ReadPermissionCollectionFilter
|
The list of all read permissions directly assigned to this organization. This list does not include inherited read permissions. |
responsibilities - ResponsibilityCollectionFilter
|
The list of all responsibilities directly assigned to this organization. This list does not include inherited responsibilities. |
subCommunities - CommunityCollectionFilter
|
The list of communities available under this community. |
subDomains - DomainCollectionFilter
|
The list of domains available under this community. |
subOrganizations - OrganizationCollectionFilter
|
The list of organizations available under this community. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [CommunityReferenceFilter],
"_null": true,
"_or": [CommunityReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"externalMappings": ExternalMappingCollectionFilter,
"id": UUIDFilter,
"meta": false,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"parent": CommunityReferenceFilter,
"readPermissions": ReadPermissionCollectionFilter,
"responsibilities": ResponsibilityCollectionFilter,
"subCommunities": CommunityCollectionFilter,
"subDomains": DomainCollectionFilter,
"subOrganizations": OrganizationCollectionFilter,
"system": false
}
Date
Description
An RFC-3339 compliant Full Date Scalar
Example
"2007-12-03"
DateAttribute
Description
An attribute that has a date value.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
dateValue - Date
|
The date value of this attribute. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
system - Boolean!
|
Whether this resource is reserved by the system. |
type - AttributeType!
|
The attribute type of this attribute. |
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"dateValue": "2007-12-03",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"system": false,
"type": AttributeType
}
DateAttributeCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - DateAttributeFilter
|
All items in the collection match the given criteria. |
any - DateAttributeFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - DateAttributeFilter
|
None of the items in the collection matches the given criteria. |
typePublicId - String
|
The type public identifier. |
Example
{
"all": DateAttributeFilter,
"any": DateAttributeFilter,
"empty": false,
"none": DateAttributeFilter,
"typePublicId": "abc123"
}
DateAttributeFilter
Description
An attribute that has a date value.
Fields
| Input Field | Description |
|---|---|
_and - [DateAttributeFilter]
|
|
_or - [DateAttributeFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
dateValue - DateFilter
|
The date value of this attribute. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
system - Boolean
|
Whether this resource is reserved by the system. |
type - AttributeTypeReferenceFilter
|
The attribute type of this attribute. |
Example
{
"_and": [DateAttributeFilter],
"_or": [DateAttributeFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"dateValue": DateFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"system": false,
"type": AttributeTypeReferenceFilter
}
DateAttributeOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
dateValue - SortOrder
|
The date value of this attribute. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
system - SortOrder
|
Whether this resource is reserved by the system. |
type - [AttributeTypeOrder]
|
The attribute type of this attribute. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"dateValue": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"system": "asc",
"type": [AttributeTypeOrder]
}
DateAttributeReferenceFilter
Description
An attribute that has a date value.
Fields
| Input Field | Description |
|---|---|
_and - [DateAttributeReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [DateAttributeReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
dateValue - DateFilter
|
The date value of this attribute. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
system - Boolean
|
Whether this resource is reserved by the system. |
type - AttributeTypeReferenceFilter
|
The attribute type of this attribute. |
Example
{
"_and": [DateAttributeReferenceFilter],
"_null": true,
"_or": [DateAttributeReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"dateValue": DateFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"system": true,
"type": AttributeTypeReferenceFilter
}
DateFilter
Example
{
"eq": "2007-12-03",
"gt": "2007-12-03",
"gte": "2007-12-03",
"lt": "2007-12-03",
"lte": "2007-12-03",
"ne": "2007-12-03",
"null": true
}
DateTime
Description
A slightly refined version of RFC-3339 compliant DateTime Scalar
Example
"2007-12-03T10:15:30Z"
DateTimeFilter
Example
{
"eq": "2007-12-03T10:15:30Z",
"gt": "2007-12-03T10:15:30Z",
"gte": "2007-12-03T10:15:30Z",
"lt": "2007-12-03T10:15:30Z",
"lte": "2007-12-03T10:15:30Z",
"ne": "2007-12-03T10:15:30Z",
"null": true
}
Domain
Description
A logical grouping of assets inside one community.
Fields
| Field Name | Description |
|---|---|
assets - [Asset!]!
|
The list of assets available under this domain. |
Arguments
|
|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
description - String
|
The description of this organization. |
externalMappings - [ExternalMapping!]!
|
The list of external mappings corresponding to this domain. |
Arguments
|
|
id - UUID!
|
The universally unique identifier of this node. |
meta - Boolean!
|
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
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
name - String!
|
The name of this organization. |
parent - Community
|
The parent community of this organization. It is null for root communities. |
readPermissions - [ReadPermission!]!
|
The list of all read permissions directly assigned to this organization. This list does not include inherited read permissions. |
Arguments
|
|
responsibilities - [Responsibility!]!
|
The list of all responsibilities directly assigned to this organization. This list does not include inherited responsibilities. |
Arguments
|
|
system - Boolean!
|
Whether this resource is reserved by the system. |
type - DomainType!
|
The domain type for this domain. |
Example
{
"assets": [Asset],
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"description": "xyz789",
"externalMappings": [ExternalMapping],
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"meta": true,
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"name": "abc123",
"parent": Community,
"readPermissions": [ReadPermission],
"responsibilities": [Responsibility],
"system": false,
"type": DomainType
}
DomainCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - DomainFilter
|
All items in the collection match the given criteria. |
any - DomainFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - DomainFilter
|
None of the items in the collection matches the given criteria. |
typePublicId - String
|
The type public identifier. |
Example
{
"all": DomainFilter,
"any": DomainFilter,
"empty": true,
"none": DomainFilter,
"typePublicId": "xyz789"
}
DomainFilter
Description
A logical grouping of assets inside one community.
Fields
| Input Field | Description |
|---|---|
_and - [DomainFilter]
|
|
_or - [DomainFilter]
|
|
assets - AssetCollectionFilter
|
The list of assets available under this domain. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this organization. |
externalMappings - ExternalMappingCollectionFilter
|
The list of external mappings corresponding to this domain. |
id - UUIDFilter
|
The universally unique identifier of this node. |
meta - Boolean
|
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 - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this organization. |
parent - CommunityReferenceFilter
|
The parent community of this organization. It is null for root communities. |
readPermissions - ReadPermissionCollectionFilter
|
The list of all read permissions directly assigned to this organization. This list does not include inherited read permissions. |
responsibilities - ResponsibilityCollectionFilter
|
The list of all responsibilities directly assigned to this organization. This list does not include inherited responsibilities. |
system - Boolean
|
Whether this resource is reserved by the system. |
type - DomainTypeReferenceFilter
|
The domain type for this domain. |
Example
{
"_and": [DomainFilter],
"_or": [DomainFilter],
"assets": AssetCollectionFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"externalMappings": ExternalMappingCollectionFilter,
"id": UUIDFilter,
"meta": false,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"parent": CommunityReferenceFilter,
"readPermissions": ReadPermissionCollectionFilter,
"responsibilities": ResponsibilityCollectionFilter,
"system": false,
"type": DomainTypeReferenceFilter
}
DomainOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
description - SortOrder
|
The description of this organization. |
id - SortOrder
|
The universally unique identifier of this node. |
meta - SortOrder
|
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 - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
name - SortOrder
|
The name of this organization. |
parent - [CommunityOrder]
|
The parent community of this organization. It is null for root communities. |
system - SortOrder
|
Whether this resource is reserved by the system. |
type - [DomainTypeOrder]
|
The domain type for this domain. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"description": "asc",
"id": "asc",
"meta": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"name": "asc",
"parent": [CommunityOrder],
"system": "asc",
"type": [DomainTypeOrder]
}
DomainReferenceFilter
Description
A logical grouping of assets inside one community.
Fields
| Input Field | Description |
|---|---|
_and - [DomainReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [DomainReferenceFilter]
|
|
assets - AssetCollectionFilter
|
The list of assets available under this domain. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this organization. |
externalMappings - ExternalMappingCollectionFilter
|
The list of external mappings corresponding to this domain. |
id - UUIDFilter
|
The universally unique identifier of this node. |
meta - Boolean
|
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 - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this organization. |
parent - CommunityReferenceFilter
|
The parent community of this organization. It is null for root communities. |
readPermissions - ReadPermissionCollectionFilter
|
The list of all read permissions directly assigned to this organization. This list does not include inherited read permissions. |
responsibilities - ResponsibilityCollectionFilter
|
The list of all responsibilities directly assigned to this organization. This list does not include inherited responsibilities. |
system - Boolean
|
Whether this resource is reserved by the system. |
type - DomainTypeReferenceFilter
|
The domain type for this domain. |
Example
{
"_and": [DomainReferenceFilter],
"_null": true,
"_or": [DomainReferenceFilter],
"assets": AssetCollectionFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"externalMappings": ExternalMappingCollectionFilter,
"id": UUIDFilter,
"meta": true,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"parent": CommunityReferenceFilter,
"readPermissions": ReadPermissionCollectionFilter,
"responsibilities": ResponsibilityCollectionFilter,
"system": false,
"type": DomainTypeReferenceFilter
}
DomainType
Description
The domain type of a resource.
Fields
| Field Name | Description |
|---|---|
children - [DomainType!]!
|
A list of child domain types for this domain type. |
Arguments
|
|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
description - String
|
The description of this domain type. |
id - UUID!
|
The universally unique identifier of this node. |
meta - Boolean
|
Whether this domain type is related to the Collibra metamodel. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
name - String
|
The name of the this domain type. |
parent - DomainType
|
The parent domain type of this domain type. It is null for root types. |
publicId - String
|
The public identifier of this domain type. |
system - Boolean!
|
Whether this resource is reserved by the system. |
Example
{
"children": [DomainType],
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"description": "xyz789",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"meta": true,
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"name": "abc123",
"parent": DomainType,
"publicId": "abc123",
"system": true
}
DomainTypeCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - DomainTypeFilter
|
All items in the collection match the given criteria. |
any - DomainTypeFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - DomainTypeFilter
|
None of the items in the collection matches the given criteria. |
Example
{
"all": DomainTypeFilter,
"any": DomainTypeFilter,
"empty": true,
"none": DomainTypeFilter
}
DomainTypeFilter
Description
The domain type of a resource.
Fields
| Input Field | Description |
|---|---|
_and - [DomainTypeFilter]
|
|
_or - [DomainTypeFilter]
|
|
children - DomainTypeCollectionFilter
|
A list of child domain types for this domain type. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this domain type. |
id - UUIDFilter
|
The universally unique identifier of this node. |
meta - Boolean
|
Whether this domain type is related to the Collibra metamodel. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of the this domain type. |
parent - DomainTypeReferenceFilter
|
The parent domain type of this domain type. It is null for root types. |
publicId - StringFilter
|
The public identifier of this domain type. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [DomainTypeFilter],
"_or": [DomainTypeFilter],
"children": DomainTypeCollectionFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"id": UUIDFilter,
"meta": false,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"parent": DomainTypeReferenceFilter,
"publicId": StringFilter,
"system": true
}
DomainTypeOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
description - SortOrder
|
The description of this domain type. |
id - SortOrder
|
The universally unique identifier of this node. |
meta - SortOrder
|
Whether this domain type is related to the Collibra metamodel. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
name - SortOrder
|
The name of the this domain type. |
parent - [DomainTypeOrder]
|
The parent domain type of this domain type. It is null for root types. |
publicId - SortOrder
|
The public identifier of this domain type. |
system - SortOrder
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"description": "asc",
"id": "asc",
"meta": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"name": "asc",
"parent": [DomainTypeOrder],
"publicId": "asc",
"system": "asc"
}
DomainTypeReferenceFilter
Description
The domain type of a resource.
Fields
| Input Field | Description |
|---|---|
_and - [DomainTypeReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [DomainTypeReferenceFilter]
|
|
children - DomainTypeCollectionFilter
|
A list of child domain types for this domain type. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this domain type. |
id - UUIDFilter
|
The universally unique identifier of this node. |
meta - Boolean
|
Whether this domain type is related to the Collibra metamodel. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of the this domain type. |
parent - DomainTypeReferenceFilter
|
The parent domain type of this domain type. It is null for root types. |
publicId - StringFilter
|
The public identifier of this domain type. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [DomainTypeReferenceFilter],
"_null": false,
"_or": [DomainTypeReferenceFilter],
"children": DomainTypeCollectionFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"id": UUIDFilter,
"meta": true,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"parent": DomainTypeReferenceFilter,
"publicId": StringFilter,
"system": false
}
ExternalMapping
Description
A representation of a link between an external entity from an external system and the corresponding Collibra resource.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
externalEntityId - String!
|
The external entity ID of this mapping. |
externalSystemId - String!
|
The external system ID of this mapping. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
system - Boolean!
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"externalEntityId": "xyz789",
"externalSystemId": "xyz789",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"system": false
}
ExternalMappingCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - ExternalMappingFilter
|
All items in the collection match the given criteria. |
any - ExternalMappingFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - ExternalMappingFilter
|
None of the items in the collection matches the given criteria. |
Example
{
"all": ExternalMappingFilter,
"any": ExternalMappingFilter,
"empty": false,
"none": ExternalMappingFilter
}
ExternalMappingFilter
Description
A representation of a link between an external entity from an external system and the corresponding Collibra resource.
Fields
| Input Field | Description |
|---|---|
_and - [ExternalMappingFilter]
|
|
_or - [ExternalMappingFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
externalEntityId - StringFilter
|
The external entity ID of this mapping. |
externalSystemId - StringFilter
|
The external system ID of this mapping. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [ExternalMappingFilter],
"_or": [ExternalMappingFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"externalEntityId": StringFilter,
"externalSystemId": StringFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"system": true
}
ExternalMappingOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
externalEntityId - SortOrder
|
The external entity ID of this mapping. |
externalSystemId - SortOrder
|
The external system ID of this mapping. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
system - SortOrder
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"externalEntityId": "asc",
"externalSystemId": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"system": "asc"
}
ExternalMappingReferenceFilter
Description
A representation of a link between an external entity from an external system and the corresponding Collibra resource.
Fields
| Input Field | Description |
|---|---|
_and - [ExternalMappingReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [ExternalMappingReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
externalEntityId - StringFilter
|
The external entity ID of this mapping. |
externalSystemId - StringFilter
|
The external system ID of this mapping. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [ExternalMappingReferenceFilter],
"_null": true,
"_or": [ExternalMappingReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"externalEntityId": StringFilter,
"externalSystemId": StringFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"system": false
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
FloatFilter
Example
{
"eq": 987.65,
"gt": 123.45,
"gte": 987.65,
"lt": 123.45,
"lte": 123.45,
"ne": 123.45,
"null": true
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
MultiValueAttribute
Description
An attribute that has multiple values from a predefined list of possible values.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
stringValues - String
|
The list of values of this attribute in the CSV format. |
system - Boolean!
|
Whether this resource is reserved by the system. |
type - AttributeType!
|
The attribute type of this attribute. |
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"stringValues": "xyz789",
"system": false,
"type": AttributeType
}
MultiValueAttributeCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - MultiValueAttributeFilter
|
All items in the collection match the given criteria. |
any - MultiValueAttributeFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - MultiValueAttributeFilter
|
None of the items in the collection matches the given criteria. |
typePublicId - String
|
The type public identifier. |
Example
{
"all": MultiValueAttributeFilter,
"any": MultiValueAttributeFilter,
"empty": false,
"none": MultiValueAttributeFilter,
"typePublicId": "abc123"
}
MultiValueAttributeFilter
Description
An attribute that has multiple values from a predefined list of possible values.
Fields
| Input Field | Description |
|---|---|
_and - [MultiValueAttributeFilter]
|
|
_or - [MultiValueAttributeFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
stringValues - StringFilter
|
The list of values of this attribute in the CSV format. |
system - Boolean
|
Whether this resource is reserved by the system. |
type - AttributeTypeReferenceFilter
|
The attribute type of this attribute. |
Example
{
"_and": [MultiValueAttributeFilter],
"_or": [MultiValueAttributeFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"stringValues": StringFilter,
"system": false,
"type": AttributeTypeReferenceFilter
}
MultiValueAttributeOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
stringValues - SortOrder
|
The list of values of this attribute in the CSV format. |
system - SortOrder
|
Whether this resource is reserved by the system. |
type - [AttributeTypeOrder]
|
The attribute type of this attribute. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"stringValues": "asc",
"system": "asc",
"type": [AttributeTypeOrder]
}
MultiValueAttributeReferenceFilter
Description
An attribute that has multiple values from a predefined list of possible values.
Fields
| Input Field | Description |
|---|---|
_and - [MultiValueAttributeReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [MultiValueAttributeReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
stringValues - StringFilter
|
The list of values of this attribute in the CSV format. |
system - Boolean
|
Whether this resource is reserved by the system. |
type - AttributeTypeReferenceFilter
|
The attribute type of this attribute. |
Example
{
"_and": [MultiValueAttributeReferenceFilter],
"_null": true,
"_or": [MultiValueAttributeReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"stringValues": StringFilter,
"system": true,
"type": AttributeTypeReferenceFilter
}
Node
Description
A base interface implemented by all types.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The universally unique identifier of this node. |
Example
{
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b"
}
NodeFilter
Description
A base interface implemented by all types.
Fields
| Input Field | Description |
|---|---|
_and - [NodeFilter]
|
|
_or - [NodeFilter]
|
|
id - UUIDFilter
|
The universally unique identifier of this node. |
Example
{
"_and": [NodeFilter],
"_or": [NodeFilter],
"id": UUIDFilter
}
NodeReferenceFilter
Description
A base interface implemented by all types.
Fields
| Input Field | Description |
|---|---|
_and - [NodeReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [NodeReferenceFilter]
|
|
id - UUIDFilter
|
The universally unique identifier of this node. |
Example
{
"_and": [NodeReferenceFilter],
"_null": false,
"_or": [NodeReferenceFilter],
"id": UUIDFilter
}
NumericAttribute
Description
An attribute that has a numeric value.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
numericValue - Float
|
The numeric value of this attribute. |
system - Boolean!
|
Whether this resource is reserved by the system. |
type - AttributeType!
|
The attribute type of this attribute. |
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"numericValue": 123.45,
"system": false,
"type": AttributeType
}
NumericAttributeCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - NumericAttributeFilter
|
All items in the collection match the given criteria. |
any - NumericAttributeFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - NumericAttributeFilter
|
None of the items in the collection matches the given criteria. |
typePublicId - String
|
The type public identifier. |
Example
{
"all": NumericAttributeFilter,
"any": NumericAttributeFilter,
"empty": false,
"none": NumericAttributeFilter,
"typePublicId": "abc123"
}
NumericAttributeFilter
Description
An attribute that has a numeric value.
Fields
| Input Field | Description |
|---|---|
_and - [NumericAttributeFilter]
|
|
_or - [NumericAttributeFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
numericValue - FloatFilter
|
The numeric value of this attribute. |
system - Boolean
|
Whether this resource is reserved by the system. |
type - AttributeTypeReferenceFilter
|
The attribute type of this attribute. |
Example
{
"_and": [NumericAttributeFilter],
"_or": [NumericAttributeFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"numericValue": FloatFilter,
"system": false,
"type": AttributeTypeReferenceFilter
}
NumericAttributeOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
numericValue - SortOrder
|
The numeric value of this attribute. |
system - SortOrder
|
Whether this resource is reserved by the system. |
type - [AttributeTypeOrder]
|
The attribute type of this attribute. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"numericValue": "asc",
"system": "asc",
"type": [AttributeTypeOrder]
}
NumericAttributeReferenceFilter
Description
An attribute that has a numeric value.
Fields
| Input Field | Description |
|---|---|
_and - [NumericAttributeReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [NumericAttributeReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
numericValue - FloatFilter
|
The numeric value of this attribute. |
system - Boolean
|
Whether this resource is reserved by the system. |
type - AttributeTypeReferenceFilter
|
The attribute type of this attribute. |
Example
{
"_and": [NumericAttributeReferenceFilter],
"_null": false,
"_or": [NumericAttributeReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"numericValue": FloatFilter,
"system": true,
"type": AttributeTypeReferenceFilter
}
Organization
Description
The parent interface for both Community and Domain types.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
description - String
|
The description of this organization. |
id - UUID!
|
The universally unique identifier of this node. |
meta - Boolean!
|
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
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
name - String!
|
The name of this organization. |
parent - Community
|
The parent community of this organization. It is null for root communities. |
readPermissions - [ReadPermission!]!
|
The list of all read permissions directly assigned to this organization. This list does not include inherited read permissions. |
Arguments
|
|
responsibilities - [Responsibility!]!
|
The list of all responsibilities directly assigned to this organization. This list does not include inherited responsibilities. |
Arguments
|
|
system - Boolean!
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"description": "xyz789",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"meta": true,
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"name": "abc123",
"parent": Community,
"readPermissions": [ReadPermission],
"responsibilities": [Responsibility],
"system": false
}
OrganizationCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - OrganizationFilter
|
All items in the collection match the given criteria. |
any - OrganizationFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - OrganizationFilter
|
None of the items in the collection matches the given criteria. |
Example
{
"all": OrganizationFilter,
"any": OrganizationFilter,
"empty": false,
"none": OrganizationFilter
}
OrganizationFilter
Description
The parent interface for both Community and Domain types.
Fields
| Input Field | Description |
|---|---|
_and - [OrganizationFilter]
|
|
_or - [OrganizationFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this organization. |
id - UUIDFilter
|
The universally unique identifier of this node. |
meta - Boolean
|
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 - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this organization. |
parent - CommunityReferenceFilter
|
The parent community of this organization. It is null for root communities. |
readPermissions - ReadPermissionCollectionFilter
|
The list of all read permissions directly assigned to this organization. This list does not include inherited read permissions. |
responsibilities - ResponsibilityCollectionFilter
|
The list of all responsibilities directly assigned to this organization. This list does not include inherited responsibilities. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [OrganizationFilter],
"_or": [OrganizationFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"id": UUIDFilter,
"meta": false,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"parent": CommunityReferenceFilter,
"readPermissions": ReadPermissionCollectionFilter,
"responsibilities": ResponsibilityCollectionFilter,
"system": true
}
OrganizationOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
description - SortOrder
|
The description of this organization. |
id - SortOrder
|
The universally unique identifier of this node. |
meta - SortOrder
|
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 - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
name - SortOrder
|
The name of this organization. |
parent - [CommunityOrder]
|
The parent community of this organization. It is null for root communities. |
system - SortOrder
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"description": "asc",
"id": "asc",
"meta": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"name": "asc",
"parent": [CommunityOrder],
"system": "asc"
}
OrganizationReferenceFilter
Description
The parent interface for both Community and Domain types.
Fields
| Input Field | Description |
|---|---|
_and - [OrganizationReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [OrganizationReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this organization. |
id - UUIDFilter
|
The universally unique identifier of this node. |
meta - Boolean
|
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 - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this organization. |
parent - CommunityReferenceFilter
|
The parent community of this organization. It is null for root communities. |
readPermissions - ReadPermissionCollectionFilter
|
The list of all read permissions directly assigned to this organization. This list does not include inherited read permissions. |
responsibilities - ResponsibilityCollectionFilter
|
The list of all responsibilities directly assigned to this organization. This list does not include inherited responsibilities. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [OrganizationReferenceFilter],
"_null": false,
"_or": [OrganizationReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"id": UUIDFilter,
"meta": true,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"parent": CommunityReferenceFilter,
"readPermissions": ReadPermissionCollectionFilter,
"responsibilities": ResponsibilityCollectionFilter,
"system": true
}
ReadPermission
Description
A permission to view a resource.
Fields
| Field Name | Description |
|---|---|
community - Community
|
The community related to this permission. |
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
domain - Domain
|
The domain related to this permission. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
system - Boolean!
|
Whether this resource is reserved by the system. |
user - User
|
The user related to this permission. It is empty if the permission is related to a group. |
userGroup - UserGroup
|
The group related to this permission. It is empty if the permission is related to a user. |
Example
{
"community": Community,
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"domain": Domain,
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"system": false,
"user": User,
"userGroup": UserGroup
}
ReadPermissionCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - ReadPermissionFilter
|
All items in the collection match the given criteria. |
any - ReadPermissionFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - ReadPermissionFilter
|
None of the items in the collection matches the given criteria. |
Example
{
"all": ReadPermissionFilter,
"any": ReadPermissionFilter,
"empty": false,
"none": ReadPermissionFilter
}
ReadPermissionFilter
Description
A permission to view a resource.
Fields
| Input Field | Description |
|---|---|
_and - [ReadPermissionFilter]
|
|
_or - [ReadPermissionFilter]
|
|
community - CommunityReferenceFilter
|
The community related to this permission. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
domain - DomainReferenceFilter
|
The domain related to this permission. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
system - Boolean
|
Whether this resource is reserved by the system. |
user - UserReferenceFilter
|
The user related to this permission. It is empty if the permission is related to a group. |
userGroup - UserGroupReferenceFilter
|
The group related to this permission. It is empty if the permission is related to a user. |
Example
{
"_and": [ReadPermissionFilter],
"_or": [ReadPermissionFilter],
"community": CommunityReferenceFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"domain": DomainReferenceFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"system": true,
"user": UserReferenceFilter,
"userGroup": UserGroupReferenceFilter
}
ReadPermissionOrder
Fields
| Input Field | Description |
|---|---|
community - [CommunityOrder]
|
The community related to this permission. |
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
domain - [DomainOrder]
|
The domain related to this permission. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
system - SortOrder
|
Whether this resource is reserved by the system. |
user - [UserOrder]
|
The user related to this permission. It is empty if the permission is related to a group. |
userGroup - [UserGroupOrder]
|
The group related to this permission. It is empty if the permission is related to a user. |
Example
{
"community": [CommunityOrder],
"createdBy": [UserOrder],
"createdOn": "asc",
"domain": [DomainOrder],
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"system": "asc",
"user": [UserOrder],
"userGroup": [UserGroupOrder]
}
ReadPermissionReferenceFilter
Description
A permission to view a resource.
Fields
| Input Field | Description |
|---|---|
_and - [ReadPermissionReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [ReadPermissionReferenceFilter]
|
|
community - CommunityReferenceFilter
|
The community related to this permission. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
domain - DomainReferenceFilter
|
The domain related to this permission. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
system - Boolean
|
Whether this resource is reserved by the system. |
user - UserReferenceFilter
|
The user related to this permission. It is empty if the permission is related to a group. |
userGroup - UserGroupReferenceFilter
|
The group related to this permission. It is empty if the permission is related to a user. |
Example
{
"_and": [ReadPermissionReferenceFilter],
"_null": false,
"_or": [ReadPermissionReferenceFilter],
"community": CommunityReferenceFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"domain": DomainReferenceFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"system": true,
"user": UserReferenceFilter,
"userGroup": UserGroupReferenceFilter
}
Relation
Description
An association between two assets representing the source and target of the relation.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
source - Asset!
|
The source asset or head of this relation. |
system - Boolean!
|
Whether this resource is reserved by the system. |
target - Asset!
|
The target asset or tail of this relation. |
type - RelationType!
|
The relation type of this relation. |
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"source": Asset,
"system": true,
"target": Asset,
"type": RelationType
}
RelationCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - RelationFilter
|
All items in the collection match the given criteria. |
any - RelationFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - RelationFilter
|
None of the items in the collection matches the given criteria. |
typePublicId - String
|
The type public identifier. |
Example
{
"all": RelationFilter,
"any": RelationFilter,
"empty": false,
"none": RelationFilter,
"typePublicId": "abc123"
}
RelationFilter
Description
An association between two assets representing the source and target of the relation.
Fields
| Input Field | Description |
|---|---|
_and - [RelationFilter]
|
|
_or - [RelationFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
source - AssetReferenceFilter
|
The source asset or head of this relation. |
system - Boolean
|
Whether this resource is reserved by the system. |
target - AssetReferenceFilter
|
The target asset or tail of this relation. |
type - RelationTypeReferenceFilter
|
The relation type of this relation. |
Example
{
"_and": [RelationFilter],
"_or": [RelationFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"source": AssetReferenceFilter,
"system": false,
"target": AssetReferenceFilter,
"type": RelationTypeReferenceFilter
}
RelationOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
source - [AssetOrder]
|
The source asset or head of this relation. |
system - SortOrder
|
Whether this resource is reserved by the system. |
target - [AssetOrder]
|
The target asset or tail of this relation. |
type - [RelationTypeOrder]
|
The relation type of this relation. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"source": [AssetOrder],
"system": "asc",
"target": [AssetOrder],
"type": [RelationTypeOrder]
}
RelationReferenceFilter
Description
An association between two assets representing the source and target of the relation.
Fields
| Input Field | Description |
|---|---|
_and - [RelationReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [RelationReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
source - AssetReferenceFilter
|
The source asset or head of this relation. |
system - Boolean
|
Whether this resource is reserved by the system. |
target - AssetReferenceFilter
|
The target asset or tail of this relation. |
type - RelationTypeReferenceFilter
|
The relation type of this relation. |
Example
{
"_and": [RelationReferenceFilter],
"_null": false,
"_or": [RelationReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"source": AssetReferenceFilter,
"system": false,
"target": AssetReferenceFilter,
"type": RelationTypeReferenceFilter
}
RelationType
Description
A class of relation between two asset types.
Fields
| Field Name | Description |
|---|---|
corole - String
|
The label of this relation type, when followed from tail to head. |
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
description - String
|
The description of this relation type. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
publicId - String!
|
The public identifier of this relation type. |
role - String!
|
The label of this relation type when followed from head to tail. |
source - Type!
|
The asset type that is the head of this relation type. |
system - Boolean!
|
Whether this resource is reserved by the system. |
target - AssetType!
|
The asset type that is the tail of the relation type. |
Example
{
"corole": "abc123",
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"description": "xyz789",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"publicId": "abc123",
"role": "xyz789",
"source": Type,
"system": false,
"target": AssetType
}
RelationTypeFilter
Description
A class of relation between two asset types.
Fields
| Input Field | Description |
|---|---|
_and - [RelationTypeFilter]
|
|
_or - [RelationTypeFilter]
|
|
corole - StringFilter
|
The label of this relation type, when followed from tail to head. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this relation type. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
publicId - StringFilter
|
The public identifier of this relation type. |
role - StringFilter
|
The label of this relation type when followed from head to tail. |
source - TypeReferenceFilter
|
The asset type that is the head of this relation type. |
system - Boolean
|
Whether this resource is reserved by the system. |
target - AssetTypeReferenceFilter
|
The asset type that is the tail of the relation type. |
Example
{
"_and": [RelationTypeFilter],
"_or": [RelationTypeFilter],
"corole": StringFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"publicId": StringFilter,
"role": StringFilter,
"source": TypeReferenceFilter,
"system": true,
"target": AssetTypeReferenceFilter
}
RelationTypeOrder
Fields
| Input Field | Description |
|---|---|
corole - SortOrder
|
The label of this relation type, when followed from tail to head. |
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
description - SortOrder
|
The description of this relation type. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
publicId - SortOrder
|
The public identifier of this relation type. |
role - SortOrder
|
The label of this relation type when followed from head to tail. |
source - [TypeOrder]
|
The asset type that is the head of this relation type. |
system - SortOrder
|
Whether this resource is reserved by the system. |
target - [AssetTypeOrder]
|
The asset type that is the tail of the relation type. |
Example
{
"corole": "asc",
"createdBy": [UserOrder],
"createdOn": "asc",
"description": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"publicId": "asc",
"role": "asc",
"source": [TypeOrder],
"system": "asc",
"target": [AssetTypeOrder]
}
RelationTypeReferenceFilter
Description
A class of relation between two asset types.
Fields
| Input Field | Description |
|---|---|
_and - [RelationTypeReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [RelationTypeReferenceFilter]
|
|
corole - StringFilter
|
The label of this relation type, when followed from tail to head. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this relation type. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
publicId - StringFilter
|
The public identifier of this relation type. |
role - StringFilter
|
The label of this relation type when followed from head to tail. |
source - TypeReferenceFilter
|
The asset type that is the head of this relation type. |
system - Boolean
|
Whether this resource is reserved by the system. |
target - AssetTypeReferenceFilter
|
The asset type that is the tail of the relation type. |
Example
{
"_and": [RelationTypeReferenceFilter],
"_null": false,
"_or": [RelationTypeReferenceFilter],
"corole": StringFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"publicId": StringFilter,
"role": StringFilter,
"source": TypeReferenceFilter,
"system": true,
"target": AssetTypeReferenceFilter
}
Responsibility
Description
A link between a user or group with a role and an asset, domain, or community. It is mutually exclusive.
Fields
| Field Name | Description |
|---|---|
asset - Asset
|
The asset related to this responsibility. |
community - Community
|
The community related to this responsibility. |
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
domain - Domain
|
The domain related to this responsibility. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
role - Role!
|
The user role related to this responsibility. |
system - Boolean!
|
Whether this resource is reserved by the system. |
user - User
|
The user related to this responsibility. It is empty if the responsibility is related to a group. |
userGroup - UserGroup
|
The group related to this responsibility. It is empty if the responsibility is related to a user. |
Example
{
"asset": Asset,
"community": Community,
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"domain": Domain,
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"role": Role,
"system": true,
"user": User,
"userGroup": UserGroup
}
ResponsibilityCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - ResponsibilityFilter
|
All items in the collection match the given criteria. |
any - ResponsibilityFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - ResponsibilityFilter
|
None of the items in the collection matches the given criteria. |
Example
{
"all": ResponsibilityFilter,
"any": ResponsibilityFilter,
"empty": true,
"none": ResponsibilityFilter
}
ResponsibilityFilter
Description
A link between a user or group with a role and an asset, domain, or community. It is mutually exclusive.
Fields
| Input Field | Description |
|---|---|
_and - [ResponsibilityFilter]
|
|
_or - [ResponsibilityFilter]
|
|
asset - AssetReferenceFilter
|
The asset related to this responsibility. |
community - CommunityReferenceFilter
|
The community related to this responsibility. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
domain - DomainReferenceFilter
|
The domain related to this responsibility. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
role - RoleReferenceFilter
|
The user role related to this responsibility. |
system - Boolean
|
Whether this resource is reserved by the system. |
user - UserReferenceFilter
|
The user related to this responsibility. It is empty if the responsibility is related to a group. |
userGroup - UserGroupReferenceFilter
|
The group related to this responsibility. It is empty if the responsibility is related to a user. |
Example
{
"_and": [ResponsibilityFilter],
"_or": [ResponsibilityFilter],
"asset": AssetReferenceFilter,
"community": CommunityReferenceFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"domain": DomainReferenceFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"role": RoleReferenceFilter,
"system": true,
"user": UserReferenceFilter,
"userGroup": UserGroupReferenceFilter
}
ResponsibilityOrder
Fields
| Input Field | Description |
|---|---|
asset - [AssetOrder]
|
The asset related to this responsibility. |
community - [CommunityOrder]
|
The community related to this responsibility. |
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
domain - [DomainOrder]
|
The domain related to this responsibility. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
role - [RoleOrder]
|
The user role related to this responsibility. |
system - SortOrder
|
Whether this resource is reserved by the system. |
user - [UserOrder]
|
The user related to this responsibility. It is empty if the responsibility is related to a group. |
userGroup - [UserGroupOrder]
|
The group related to this responsibility. It is empty if the responsibility is related to a user. |
Example
{
"asset": [AssetOrder],
"community": [CommunityOrder],
"createdBy": [UserOrder],
"createdOn": "asc",
"domain": [DomainOrder],
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"role": [RoleOrder],
"system": "asc",
"user": [UserOrder],
"userGroup": [UserGroupOrder]
}
ResponsibilityReferenceFilter
Description
A link between a user or group with a role and an asset, domain, or community. It is mutually exclusive.
Fields
| Input Field | Description |
|---|---|
_and - [ResponsibilityReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [ResponsibilityReferenceFilter]
|
|
asset - AssetReferenceFilter
|
The asset related to this responsibility. |
community - CommunityReferenceFilter
|
The community related to this responsibility. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
domain - DomainReferenceFilter
|
The domain related to this responsibility. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
role - RoleReferenceFilter
|
The user role related to this responsibility. |
system - Boolean
|
Whether this resource is reserved by the system. |
user - UserReferenceFilter
|
The user related to this responsibility. It is empty if the responsibility is related to a group. |
userGroup - UserGroupReferenceFilter
|
The group related to this responsibility. It is empty if the responsibility is related to a user. |
Example
{
"_and": [ResponsibilityReferenceFilter],
"_null": true,
"_or": [ResponsibilityReferenceFilter],
"asset": AssetReferenceFilter,
"community": CommunityReferenceFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"domain": DomainReferenceFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"role": RoleReferenceFilter,
"system": true,
"user": UserReferenceFilter,
"userGroup": UserGroupReferenceFilter
}
Role
Description
The role that a user has, for example, Steward or Admin.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
global - Boolean
|
Whether the role is defined at the global level. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
name - String!
|
The name of this role. |
system - Boolean!
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"global": true,
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"name": "xyz789",
"system": true
}
RoleFilter
Description
The role that a user has, for example, Steward or Admin.
Fields
| Input Field | Description |
|---|---|
_and - [RoleFilter]
|
|
_or - [RoleFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
global - Boolean
|
Whether the role is defined at the global level. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this role. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [RoleFilter],
"_or": [RoleFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"global": true,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"system": true
}
RoleOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
global - SortOrder
|
Whether the role is defined at the global level. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
name - SortOrder
|
The name of this role. |
system - SortOrder
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"global": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"name": "asc",
"system": "asc"
}
RoleReferenceFilter
Description
The role that a user has, for example, Steward or Admin.
Fields
| Input Field | Description |
|---|---|
_and - [RoleReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [RoleReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
global - Boolean
|
Whether the role is defined at the global level. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this role. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [RoleReferenceFilter],
"_null": false,
"_or": [RoleReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"global": true,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"system": false
}
SortOrder
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"asc"
Status
Description
An indication about the status of an asset.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
description - String
|
The description of this status. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
name - String!
|
The name of this status. |
system - Boolean!
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"description": "abc123",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"name": "abc123",
"system": false
}
StatusFilter
Description
An indication about the status of an asset.
Fields
| Input Field | Description |
|---|---|
_and - [StatusFilter]
|
|
_or - [StatusFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this status. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this status. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [StatusFilter],
"_or": [StatusFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"system": false
}
StatusOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
description - SortOrder
|
The description of this status. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
name - SortOrder
|
The name of this status. |
system - SortOrder
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"description": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"name": "asc",
"system": "asc"
}
StatusReferenceFilter
Description
An indication about the status of an asset.
Fields
| Input Field | Description |
|---|---|
_and - [StatusReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [StatusReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this status. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this status. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [StatusReferenceFilter],
"_null": true,
"_or": [StatusReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"system": false
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
StringAttribute
Description
An attribute that has a string value.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
stringValue - String
|
The text value of this attribute. |
system - Boolean!
|
Whether this resource is reserved by the system. |
type - AttributeType!
|
The attribute type of this attribute. |
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"stringValue": "xyz789",
"system": true,
"type": AttributeType
}
StringAttributeCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - StringAttributeFilter
|
All items in the collection match the given criteria. |
any - StringAttributeFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - StringAttributeFilter
|
None of the items in the collection matches the given criteria. |
typePublicId - String
|
The type public identifier. |
Example
{
"all": StringAttributeFilter,
"any": StringAttributeFilter,
"empty": true,
"none": StringAttributeFilter,
"typePublicId": "abc123"
}
StringAttributeFilter
Description
An attribute that has a string value.
Fields
| Input Field | Description |
|---|---|
_and - [StringAttributeFilter]
|
|
_or - [StringAttributeFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
stringValue - StringFilter
|
The text value of this attribute. |
system - Boolean
|
Whether this resource is reserved by the system. |
type - AttributeTypeReferenceFilter
|
The attribute type of this attribute. |
Example
{
"_and": [StringAttributeFilter],
"_or": [StringAttributeFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"stringValue": StringFilter,
"system": false,
"type": AttributeTypeReferenceFilter
}
StringAttributeOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
stringValue - SortOrder
|
The text value of this attribute. |
system - SortOrder
|
Whether this resource is reserved by the system. |
type - [AttributeTypeOrder]
|
The attribute type of this attribute. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"stringValue": "asc",
"system": "asc",
"type": [AttributeTypeOrder]
}
StringAttributeReferenceFilter
Description
An attribute that has a string value.
Fields
| Input Field | Description |
|---|---|
_and - [StringAttributeReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [StringAttributeReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
stringValue - StringFilter
|
The text value of this attribute. |
system - Boolean
|
Whether this resource is reserved by the system. |
type - AttributeTypeReferenceFilter
|
The attribute type of this attribute. |
Example
{
"_and": [StringAttributeReferenceFilter],
"_null": true,
"_or": [StringAttributeReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"stringValue": StringFilter,
"system": true,
"type": AttributeTypeReferenceFilter
}
StringFilter
Fields
| Input Field | Description |
|---|---|
contains - String
|
Contains. |
endsWith - String
|
Ends with. |
eq - String
|
Equals. |
gt - String
|
Greater than. |
gte - String
|
Greater than or equals. |
in - [String!]
|
Is equal to one of the values. |
lt - String
|
Less than. |
lte - String
|
Less than or equals. |
ne - String
|
Does not equal. |
notContains - String
|
Does not contain. |
notEndsWith - String
|
Does not end with. |
notIn - [String!]
|
Is not equal to any of the values. |
notStartsWith - String
|
Does not start with. |
null - Boolean
|
The field value is null. |
startsWith - String
|
Starts with. |
Example
{
"contains": "abc123",
"endsWith": "xyz789",
"eq": "xyz789",
"gt": "xyz789",
"gte": "xyz789",
"in": ["abc123"],
"lt": "abc123",
"lte": "xyz789",
"ne": "xyz789",
"notContains": "abc123",
"notEndsWith": "abc123",
"notIn": ["abc123"],
"notStartsWith": "xyz789",
"null": false,
"startsWith": "xyz789"
}
Tag
Description
A label applied to one or more assets.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
name - String!
|
The name of this tag. |
system - Boolean!
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"name": "xyz789",
"system": false
}
TagCollectionFilter
Fields
| Input Field | Description |
|---|---|
all - TagFilter
|
All items in the collection match the given criteria. |
any - TagFilter
|
Any item in the collection matches the given criteria. |
empty - Boolean
|
The target collection is empty. |
none - TagFilter
|
None of the items in the collection matches the given criteria. |
Example
{
"all": TagFilter,
"any": TagFilter,
"empty": true,
"none": TagFilter
}
TagFilter
Description
A label applied to one or more assets.
Fields
| Input Field | Description |
|---|---|
_and - [TagFilter]
|
|
_or - [TagFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this tag. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [TagFilter],
"_or": [TagFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"system": true
}
TagOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
name - SortOrder
|
The name of this tag. |
system - SortOrder
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"name": "asc",
"system": "asc"
}
TagReferenceFilter
Description
A label applied to one or more assets.
Fields
| Input Field | Description |
|---|---|
_and - [TagReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [TagReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this tag. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [TagReferenceFilter],
"_null": false,
"_or": [TagReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"system": true
}
Type
Description
An abstract parent of all types.
Fields
| Field Name | Description |
|---|---|
acronym - String
|
The acronym of this type. |
color - String!
|
The user interface color of this type. |
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
description - String
|
The description of this type. |
icon - String
|
The user interface icon of this type. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
name - String!
|
The name of this type. |
publicId - String!
|
The public identifier of this type. |
symbolType - String
|
|
system - Boolean!
|
Whether this resource is reserved by the system. |
Possible Types
| Type Types |
|---|
Example
{
"acronym": "xyz789",
"color": "abc123",
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"description": "xyz789",
"icon": "xyz789",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"name": "abc123",
"publicId": "abc123",
"symbolType": "abc123",
"system": true
}
TypeFilter
Description
An abstract parent of all types.
Fields
| Input Field | Description |
|---|---|
_and - [TypeFilter]
|
|
_or - [TypeFilter]
|
|
acronym - StringFilter
|
The acronym of this type. |
color - StringFilter
|
The user interface color of this type. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this type. |
icon - StringFilter
|
The user interface icon of this type. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this type. |
publicId - StringFilter
|
The public identifier of this type. |
symbolType - StringFilter
|
|
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [TypeFilter],
"_or": [TypeFilter],
"acronym": StringFilter,
"color": StringFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"icon": StringFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"publicId": StringFilter,
"symbolType": StringFilter,
"system": true
}
TypeOrder
Fields
| Input Field | Description |
|---|---|
acronym - SortOrder
|
The acronym of this type. |
color - SortOrder
|
The user interface color of this type. |
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
description - SortOrder
|
The description of this type. |
icon - SortOrder
|
The user interface icon of this type. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
name - SortOrder
|
The name of this type. |
publicId - SortOrder
|
The public identifier of this type. |
symbolType - SortOrder
|
|
system - SortOrder
|
Whether this resource is reserved by the system. |
Example
{
"acronym": "asc",
"color": "asc",
"createdBy": [UserOrder],
"createdOn": "asc",
"description": "asc",
"icon": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"name": "asc",
"publicId": "asc",
"symbolType": "asc",
"system": "asc"
}
TypeReferenceFilter
Description
An abstract parent of all types.
Fields
| Input Field | Description |
|---|---|
_and - [TypeReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [TypeReferenceFilter]
|
|
acronym - StringFilter
|
The acronym of this type. |
color - StringFilter
|
The user interface color of this type. |
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
description - StringFilter
|
The description of this type. |
icon - StringFilter
|
The user interface icon of this type. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this type. |
publicId - StringFilter
|
The public identifier of this type. |
symbolType - StringFilter
|
|
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [TypeReferenceFilter],
"_null": false,
"_or": [TypeReferenceFilter],
"acronym": StringFilter,
"color": StringFilter,
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"description": StringFilter,
"icon": StringFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"publicId": StringFilter,
"symbolType": StringFilter,
"system": true
}
UUID
Description
A universally unique identifier compliant UUID Scalar
Example
"329ae3e4-a5f4-400f-93b4-6e3770dbba0b"
UUIDFilter
Example
{
"eq": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"gt": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"gte": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"in": [
"329ae3e4-a5f4-400f-93b4-6e3770dbba0b"
],
"lt": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"lte": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"ne": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"null": true
}
User
Description
A Collibra user. Any resource has a creation date and the last modification date. Collibra also stores which user made each of these operations. The User entity is related to all types as the creator and/or last modifier of the entity.
Fields
| Field Name | Description |
|---|---|
email - String
|
The primary email address of this user. |
enabled - Boolean!
|
Whether the user is enabled. |
firstName - String
|
The first name of this user. |
fullName - String
|
The first name and last name of this user. |
id - UUID!
|
The universally unique identifier of this node. |
lastName - String
|
The last name of this user. |
system - Boolean!
|
Whether this user is reserved by the system. |
Example
{
"email": "abc123",
"enabled": true,
"firstName": "abc123",
"fullName": "abc123",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"lastName": "xyz789",
"system": true
}
UserFilter
Description
A Collibra user. Any resource has a creation date and the last modification date. Collibra also stores which user made each of these operations. The User entity is related to all types as the creator and/or last modifier of the entity.
Fields
| Input Field | Description |
|---|---|
_and - [UserFilter]
|
|
_or - [UserFilter]
|
|
email - StringFilter
|
The primary email address of this user. |
enabled - Boolean
|
Whether the user is enabled. |
firstName - StringFilter
|
The first name of this user. |
fullName - StringFilter
|
The first name and last name of this user. |
id - UUIDFilter
|
The universally unique identifier of this node. |
lastName - StringFilter
|
The last name of this user. |
system - Boolean
|
Whether this user is reserved by the system. |
Example
{
"_and": [UserFilter],
"_or": [UserFilter],
"email": StringFilter,
"enabled": true,
"firstName": StringFilter,
"fullName": StringFilter,
"id": UUIDFilter,
"lastName": StringFilter,
"system": false
}
UserGroup
Description
A group of Collibra users.
Fields
| Field Name | Description |
|---|---|
createdBy - User
|
The user who created this resource. |
createdOn - DateTime
|
The creation date of this resource. |
id - UUID!
|
The universally unique identifier of this node. |
modifiedBy - User
|
The user who last modified this resource. |
modifiedOn - DateTime
|
The last modified date of this resource. |
name - String!
|
The name of this group. |
system - Boolean!
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": User,
"createdOn": "2007-12-03T10:15:30Z",
"id": "329ae3e4-a5f4-400f-93b4-6e3770dbba0b",
"modifiedBy": User,
"modifiedOn": "2007-12-03T10:15:30Z",
"name": "abc123",
"system": true
}
UserGroupFilter
Description
A group of Collibra users.
Fields
| Input Field | Description |
|---|---|
_and - [UserGroupFilter]
|
|
_or - [UserGroupFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this group. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [UserGroupFilter],
"_or": [UserGroupFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"system": false
}
UserGroupOrder
Fields
| Input Field | Description |
|---|---|
createdBy - [UserOrder]
|
The user who created this resource. |
createdOn - SortOrder
|
The creation date of this resource. |
id - SortOrder
|
The universally unique identifier of this node. |
modifiedBy - [UserOrder]
|
The user who last modified this resource. |
modifiedOn - SortOrder
|
The last modified date of this resource. |
name - SortOrder
|
The name of this group. |
system - SortOrder
|
Whether this resource is reserved by the system. |
Example
{
"createdBy": [UserOrder],
"createdOn": "asc",
"id": "asc",
"modifiedBy": [UserOrder],
"modifiedOn": "asc",
"name": "asc",
"system": "asc"
}
UserGroupReferenceFilter
Description
A group of Collibra users.
Fields
| Input Field | Description |
|---|---|
_and - [UserGroupReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [UserGroupReferenceFilter]
|
|
createdBy - UserReferenceFilter
|
The user who created this resource. |
createdOn - DateTimeFilter
|
The creation date of this resource. |
id - UUIDFilter
|
The universally unique identifier of this node. |
modifiedBy - UserReferenceFilter
|
The user who last modified this resource. |
modifiedOn - DateTimeFilter
|
The last modified date of this resource. |
name - StringFilter
|
The name of this group. |
system - Boolean
|
Whether this resource is reserved by the system. |
Example
{
"_and": [UserGroupReferenceFilter],
"_null": true,
"_or": [UserGroupReferenceFilter],
"createdBy": UserReferenceFilter,
"createdOn": DateTimeFilter,
"id": UUIDFilter,
"modifiedBy": UserReferenceFilter,
"modifiedOn": DateTimeFilter,
"name": StringFilter,
"system": false
}
UserOrder
Fields
| Input Field | Description |
|---|---|
email - SortOrder
|
The primary email address of this user. |
enabled - SortOrder
|
Whether the user is enabled. |
firstName - SortOrder
|
The first name of this user. |
fullName - SortOrder
|
The first name and last name of this user. |
id - SortOrder
|
The universally unique identifier of this node. |
lastName - SortOrder
|
The last name of this user. |
system - SortOrder
|
Whether this user is reserved by the system. |
Example
{
"email": "asc",
"enabled": "asc",
"firstName": "asc",
"fullName": "asc",
"id": "asc",
"lastName": "asc",
"system": "asc"
}
UserReferenceFilter
Description
A Collibra user. Any resource has a creation date and the last modification date. Collibra also stores which user made each of these operations. The User entity is related to all types as the creator and/or last modifier of the entity.
Fields
| Input Field | Description |
|---|---|
_and - [UserReferenceFilter]
|
|
_null - Boolean
|
The field value is null. |
_or - [UserReferenceFilter]
|
|
email - StringFilter
|
The primary email address of this user. |
enabled - Boolean
|
Whether the user is enabled. |
firstName - StringFilter
|
The first name of this user. |
fullName - StringFilter
|
The first name and last name of this user. |
id - UUIDFilter
|
The universally unique identifier of this node. |
lastName - StringFilter
|
The last name of this user. |
system - Boolean
|
Whether this user is reserved by the system. |
Example
{
"_and": [UserReferenceFilter],
"_null": true,
"_or": [UserReferenceFilter],
"email": StringFilter,
"enabled": false,
"firstName": StringFilter,
"fullName": StringFilter,
"id": UUIDFilter,
"lastName": StringFilter,
"system": true
}