> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/api/guides/introduction/entities-properties-and-relations.md). # Entities, properties and relations ## Limits To protect the system against extensive memory usage of single query there are global limits applied: * The maximum number of root nodes that can be requested, `rootNodesNumberLimit` – enforces maximum value for the `displayLength` parameter to 100,000. This limit is currently disabled by default on all environments but we recommend to enable it and always use smaller `displayLength` values to ensure a single query does not overuse system resources. * The maximum number of nodes that can be requested in a single page, `pageNodesNumberLimit` – enforces maximum number of both root and children nodes to 1,000,000. This limit is always enabled. All graph queries are internally paged with a page size of 5,000 to produce full result and return it to the API customer. This limit is applied per single page. For endpoints that produce results directly into the response, without producing a file or a job, reaching the limit could lead to partial responses with a 200 OK HTTP status code because results are streamed directly to the response for best performance. You can change the default values for these limits in Collibra Console, in the **Graph query limits** section. | Entity | | | | ---------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------------------------- | | Entity is the base abstract class of all other entities. An abstract entity cannot be queried, thus `Entity` cannot be used in the query tree. | | | | Properties | | | | id | Text (36) | Universally unique identifier (UUID). | |

Resource

Extends Entity

| | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Resource is an abstract entity, which is the base class of most other entities. Most other entities share the following properties and relations. An abstract entity cannot be queried, thus `Resource` cannot be used in the query tree. | | | | Properties | | | | createdOnIsoDate | Number | The creation date expressed as an ISO 8601 formatted date. | | createdOnTimestamp | Number | The creation date expressed as the number of milliseconds since 1/1/1970. | | createdBy | Text | Id of the user who created this Resource. | | lastModifiedIsoDate | Number | The last modification date expressed as an ISO 8601 formatted date. | | lastModifiedTimestamp | Number | The last modification date expressed as the number of milliseconds since 1/1/1970. | | lastModifiedBy | Text | Id of the last user who modified this resource. | | system | Boolean | Is this resource reserved by the system. | | Relations | | | | User | Many-to-one | | |

Representation

Extends Resource

| | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------------------------------------------------------------ | | Representation is an abstract entity, which is the base class for Asset. All assets share the following relationships. An abstract entity cannot be queried, thus `Representation` cannot be used in the query tree. | | | | Properties | | | | / | | | | Relations | | | | Status | Many-to-One | The current status of the representation. | | Domain | Many-to-One | The domain containing the representation. | | AssetType | Many-to-One | The AssetType of the representation. | | Attribute | One-to-Many | The collection of attributes in the representation. | | StringAttribute | One-to-Many | The collection of StringAttributes in the representation. | | ScriptAttribute | One-to-Many | The collection of ScriptAttributes in the representation. | | SingleValueListAttribute | One-to-Many | The collection of SingleValueListAttributes in the representation. | | MultiValueListAttribute | One-to-Many | The collection of MultiValueListAttributes in the representation. | | BooleanAttribute | One-to-Many | The collection of BooleanAttributes in the representation. | | NumericAttribute | One-to-Many | The collection of NumericAttributes in the representation. | | DateTimeAttribute | One-to-Many | The collection of DateTimeAttributes in the representation. | | DateAttribute | One-to-Many | The collection of DateAttributes in the representation. | |

Organization

Extends Resource

| | | | ---------------------------------------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | Represents the hierarchy of organizations available in Collibra. | | | | Properties | | | | Name | Text (255) | The name of the organization. | | description | Text | The description of the organization. | | uri | Text (255) | The URI of the organization. | | language | Text(255) | The name of the language used. | | meta | Boolean | Indicates if the community is related to the meta model, such as a hidden organization. | | hasNonMetaChildren | Boolean | Indicates if the organization contains non-meta subcommunities or domains. | | hasNonMetaChildCommunity | Boolean | Indicates if the organization contains non-meta communities. | | organizationType | Text | Indicates if the organization is a community ("C") or a domain ("D") | | Relations | | | | ParentCommunity | Many-to-One | The parent community of this organization. Null for root communities. Optional. | | Community | One-to-Many | The collection of subcommunities. | | Domain | One-to-Many | The collection of domains contained in the organization. | | Responsibility | One-to-Many | The collection of responsibilities playing a role in the community. | | ViewPermission | One-to-Many | The collection of view permissions assigned to the organization. | | SubCommunities | One-to-Many | The collection of domains contained in the community. | | Comment | One-to-Many | The collection of comments contained in the community. | | Asset | One-to-Many | The collection of assets contained in the community. | | DomainType | One-to-Many | The type of domain. | | Mapping | One-to-Many | The collection of mappings corresponding to this domain. | | Filtering Property | | | | rootCommunity | Boolean | When true, the query engine adds a filter retaining only root communities. Only available when the community is also root of the query tree. | |

Community

Extends Organization

| | -------------------------------------------------------------------------------------------- | | Exact synonym of an organization but with default filtering on organizationType equal to "C" | |

ParentCommunity

Extends Community

| | ------------------------------------------------------------------------------------------------------------------------ | | Exact synonym of a community. It can only be used as a child of the community to disambiguate the relationship followed. | |

Domain

Extends Organization

| | | | --------------------------------------------------------------------------------------------------------------------------------- | ----------- | --------------------- | | Synonym of an organization but with default filtering on organizationType equal to "D" and with overridden relation for Community | | | | Relations | | | | Community | Many-to-One | The parent community. | |

DomainType

Extends Resource

| | | | ---------------------------------------- | ----------- | ----------------------------------------------------------------------------------- | | Each domain has a `DomainType`. | | | | Properties | | | | signifier | Text (255) | The name of the `DomainType`. | | name | | Synonym for signifier. | | description | Text | The description of the `DomainType`. | | meta | Boolean | Indicates if the `DomainType` is related to the Collibra meta model. | | Relations | | | | Domain | One-to-Many | The collection of domain instances of the `DomainType`. | | DomainType | Many-to-One | The parent `DomainType` of the `DomainType`. Null for root `DomainTypes`. Optional. | | ChildDomainTypes | One-to-Many | The collection of `DomainType` children. | |

ChildDomainTypes

Extends DomainTypeCollection of DomainType

| | --------------------------------------------------------------------------------------------------------------------- | | Exact synonym of `DomainType`. Can only be used as a child of `DomainType` to disambiguate the relationship followed. | |

RelationType

Extends Resource

| | | | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | A `RelationType` defines a class of relationship between two `AssetTypes`, also called `AssetTypes`. | | | | Properties | | | | role | Text | The label of the relation when followed from head to tail. | | corole | Text | The label of the reversed relation, when followed from tail to head. | | description | Text | The description of the `RelationType`. | | Relations | | | | Relation | One-to-Many | The collection of relation instances with this `RelationType`. | | SourceAssetType | Many-to-One | The `AssetType` that is head of the `RelationType`. `SourceAssetType` is a synonym of `AssetType` and clarifies which path is followed from the `Relation` entity to its child. In this case, the child node is the head. | | TargetAssetType | Many-to-One | The `AssetType` that is the tail of the `RelationType`. `TargetAssetType` is a synonym of `AssetType` and clarifies which path is followed from the `Relation` entity to its child. In this case, the child node is the tail. | | Parent Relationship Selector | | | | type | This parameter allows specifying which path should be followed from the parent `AssetType` entity to the `RelationType`. The possible values are either `HEAD` or `TAIL`, which tells whether the parent `AssetType` is the head or the tail of the `RelationType`. The default value is `HEAD`. | | |

Relation

Extends Resource

| | | | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | | A `Relation` links two `Assets` together. | | | | Properties | | | | startingDate (deprecated) | Number | The optional start date for this relation. | | endingDate (deprecated) | Number | The optional end date for this relation. | | isGenerated | Boolean | True if this relation was generated. | | Relations | | | | RelationType | Many-to-One | The type of this relation. | | SourceAsset | Many-to-One | The source asset of this relation. | | TargetAsset | Many-to-One | The target asset of this relation. | | Parent relationship selector. Only if the parent is a asset node or is of type inheriting from an asset node. | | | | type | This parameter allows specifying which path should be followed from the parent asset entity to this relation. The possible values are either `SOURCE` or `TARGET`, which tells whether the parent asset is the source or target of the relation. This parameter is mandatory because there is no default value. | | | Filtering Property | | | | typeId | Allows filtering relations using the Id value of their related `RelationType`. | | |

ComplexRelation

Extends Asset

| | | | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ---------------------------------- | | A `ComplexRelation` is an anonymous asset, whose signifier, or name, has been generated. | | | | Properties | | | | / | | | | Relations | | | | ComplexRelationType | Many-to-One | The type of this complex relation. | | Filtering Property | | | | typeId | Allows filtering ComplexRelations using the Id value of their related ComplexRelationType. | | | Additional Parameters | | | | separator | The character to be used to separate related asset names in an Excel or CSV export. | | | quote | The character to be used to quote related asset names in an Excel or CSV export. | | |

ComplexRelationType

Extends AssetType

| | | | ------------------------------------------------------------------- | --------- | -------------------------------------------------------------------------------------- | | A `ComplexRelationType` determines the type of a `ComplexRelation`. | | | | Properties | | | | / | | | | Relations | | | | ComplexRelation | OneToMany | The collection of `ComplexRelation` instances with the `ComplexRelationType`. | | ComplexRelationLegType | OneToMany | The collection of ComplexRelationLegTypes linked to the `ComplexRelationType`. | | ComplexRelationAttributeType | OneToMany | The collection of `ComplexRelationAttributeTypes` linked to the `ComplexRelationType`. | |

ComplexRelationLegType

Extends Resource

| | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------- | | A `ComplexRelationLegType` is a `RelationType` used in the context of a `ComplexRelationType`. The `SourceAssetType` of those `RelationTypes` of the `ComplexRelationType`. It can only be used as a child of ComplexRelationType. | | | | Properties | | | | min | Number | The minimum occurrences of this `RelationType` in the `ComplexRelationType`. | | max | Number | The maximum occurrences of this `RelationType` in the `ComplexRelationType`. | | legOrder | Number | Order of this `ComplexRelationLegType` in the `ComplexRelationType`. | | Relations | | | | RelationType | Many-to-One | The `RelationType` of the `ComplexRelationLegType`. | |

ComplexRelationAttributeType

Extends Resource

| | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------- | |

A ComplexRelationAttributeType is an AttributeType used in the context of a ComplexRelationType.

Can only be used as a child of ComplexRelationType.

| | | | Properties | | | | min | Number | The minimum occurrences of this AttributeType in the `ComplexRelationType`. | | max | Number | The maximum occurrences of this AttributeType in the `ComplexRelationType`. | | readOnly | Boolean | Indicates if the attribute can be edited or not. | | attributeOrder | Number | Order of this `ComplexRelationAttributeType` in the `ComplexRelationType`. | | Relations | | | | AttributeType | Many-to-One | The AttributeType of this `ComplexRelationAttributeType`. |

Asset

Extends Representation

An Asset is the basic building block capturing information about the assets available in Collibra.
Properties
signifierText (2000)The full name of the asset.
displayNameText (2000)The display name of the asset.
articulationScoreNumberResult of the last calculation of the articulation score.
hasChildrenForRelation (deprecated)Boolean

Virtual calculated property indicating if this asset has children for the relation type defined at the query level. This property takes two additional parameters:

  • the RelationType
  • direction (role or co-role)

For example:

"HasChildrenForRelation": {
  "name": "hasChildren",
  "relationTypeId": "00000000-0000-0000-0000-000000007005",
  "roleDirection": true

It can only be used if Asset is a root node of the query. It is not inherited by nodes extending the Asset node.

avgRatingNumberAverage value of all ratings assigned to the asset.
ratingsCountNumberNumber of all ratings signed to the asset.
classText

The class of the asset:TEAssetRLRoleCRComplex relationWDWorkflow definition

The Output Module has a broader interpretation of assets, which includes roles, complex relations, and workflows. Use the class property to differentiate among these subclasses.

Relations
RelationOne-to-ManyThe collection of relations this asset has. See Relation for a mandatory type parameter.
ResponsibilityOne-to-ManyThe collection of responsibilities this asset has.
MappingOne-to-ManyThe related mappings.
TagMany-to-ManyThe collection of tags associated with this asset.
Filtering Property
rootOfRelation

An array relation types/direction pairs. Root assets are not the child of any of the relations.

For example:

"rootOfRelation": [
  {
    "relationTypeId": "00000000-0000-0000-0000-000000007038",
    "roleDirection": true
  },
  {
    "relationTypeId": "00000000-0000-0000-0000-000000007005",
    "roleDirection": true
  }
]
|

SourceAsset

Extends Asset

| | --------------------------------------------------------------------------------------------------------------- | | Exact synonym of `Asset`. It can only be used as a child of relation to disambiguate the relationship followed. | |

TargetAsset

Extends Asset

| | ----------------------------------------------------------------------------------------------------------------- | | Exact synonym of `Asset`. It can only be used as a child of a relation to disambiguate the relationship followed. | |

SourceAssetType

Extends AssetType

| | ------------------------------------------------------------------------------------------------------------------------- | | Exact synonym of `AssetType`. It can only be used as a child of `RelationType` to disambiguate the relationship followed. | |

TargetAssetType

Extends AssetType

| | ---------------------------------------------------------------------------------------------------------------------- | | Exact synonym of `AssetType`. Can only be used as a child of `RelationType` to disambiguate the relationship followed. | |

AssetType

Extends Resource

| | | | --------------------------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------- | | A `AssetType`, also called `AssetType`, determines the type of asset, which is an Asset | | | | Properties | | | | discriminator | Text |

The type of this AssetType. Possible values are:

| | signifier | Text (255) | The name of this `AssetType`. | | name | | Synonym for signifier. | | description | Text | The description of the `AssetType`. | | meta | Boolean | Is the AssetType related to the Collibra meta model. | | color | Text | The color of the `AssetType`. | | icon | Text | The icon of the `AssetType`. | | acronym | Text | The acronym of the `AssetType` | | symbolType | Text | Defines the icon or acronym used in Collibra. Possible values are: `ICON`, `ACRONYM` and `NONE`. | | displayNameEnabled | Boolean | Indicates if the display name is enabled for all assets of this `AssetType`. | | ratingEnabled | Boolean | Are ratings enabled for all assets of this `AssetType`. | | Relations | | | | Asset | One-to-Many | The collection of instances of this `AssetType`. | | AssetType | Many-to-One | The parent AssetType of this `AssetType`. | | ChildAssetTypes | One-to-Many | The collection of concept types that have this AssetType as parent. | |

ChildAssetTypes

Extends AssetTypeCollection of AssetType

| | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

Can only be used as a child of AssetType to disambiguate the relationship followed.

The ComplexRelationType, despite inheriting from AssetType, does not support ChildAssetTypes node.

| |

Attribute

Extends Resource

| | | | ------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Attribute represents an attribute linked to a representation. | | | | Properties | | | | value | Text |

The text value of this attribute.

For date values, a JSON or XML export contains number of milliseconds since 1/1/1970, while a CSV or Excel export contains an ISO 8601 formatted date.

| | class | Text | With other entities, extends attribute. You may use the `class` qualifier to differentiate between the various subclasses. | | Relations | | | | AttributeType | Many-to-One | The type of attribute. | | Asset | Many-to-One | The asset to which the attribute belongs. | | Filtering Property | | | | labelId | Allows filtering the attributes based on the `Id` of their related `AttributeType`. | | |

StringAttribute

Extends Attribute

| | | | ------------------------------------------------------------- | ---- | -------------------------------------------------------------------------------------- | | A `StringAttribute` is an attribute dedicated to text values. | | | | Properties | | | | longExpression | Text | The unbounded text value. Obsolete, but returns the same content as `Attribute:value`. | |

ScriptAttribute

Extends Attribute

| | | | --------------------------------------------------------------- | ---- | ------------------------------------------------------------------------ | | A `ScriptAttribute` is an attribute dedicated to script values. | | | | Properties | | | | script | Text | The script. Obsolete, but returns the same content as `Attribute:value`. | |

SingleValueListAttribute

Extends Attribute

| | ------------------------------------------------------------------------------------------------------ | | A `SingleValueListAttribute` is an attribute dedicated to storing a single value selected from a list. | |

MultiValueListAttribute

Extends Attribute

| | | | ------------------------------------------------------------------------------------------------------ | ---- | ------------------- | | A `MultiValueListAttribute` is an attribute dedicated to storing multiple values selected from a list. | | | | Properties | | | | values | Text | The multiple values | |

BooleanAttribute

Extends Attribute

| | | | ----------------------------------------------------------------- | ------- | --------- | | A `BooleanAttribute` is an attribute dedicated to Boolean values. | | | | Properties | | | | booleanValue | Boolean | The value | |

NumericAttribute

Extends Attribute

| | | | ----------------------------------------------------------------- | ------ | ------------------ | | A `NumericAttribute` is an attribute dedicated to numeric values. | | | | Properties | | | | numericValue | Number | The stored number. | |

DateAttribute

Extends Attribute

| | | | ----------------------------------------------------------- | ------ | ---------------------------------------------------------------------- | | A `DateAttribute` is an attribute dedicated to date values. | | | | Properties | | | | timestamp | Number | The date value expressed as the number of milliseconds since 1/1/1970. | | isoDate | String | The date value expressed as an ISO 8601 formatted date. | |

AttributeType

Extends Resource

| | | | -------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | The `AttributeType` determines the type of an attribute. | | | | Properties | | | | signifier | Text(255) | The name of the `AttributeType`. | | name | | Synonym for signifier. | | description | Text | The description of this `AttributeType`. | | attributeKind | Text(255) | The `AttributeType` kind. The possible values are: BOOLEAN, STRING, NUMERIC,DATE, DATE\_TIME, SINGLE\_VALUE\_LIST, MULTI\_VALUE\_LIST and SCRIPT. | | language | Text(255) | The name of the language used. The kind is SCRIPT. | | isInteger | Boolean | Indicates if the `AttributeType` defines an integer or decimal. If true, it defines an integer. If false, it defines a decimal. The kind is NUMERIC. | | allowedValues | Text | Comma separated list of values. The kind is SINGLE\_VALUE\_LIST or MULTI\_VALUE\_LIST. | | Relations | | | | Attribute | One-to-Many | The collection of `Attributes` of this type | |

User

Extends Resource

| | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | | Represents Collibra users. 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. | | | | Properties | | | | userName | Text | The user name. Requires administrative rights to be queried. | | firstName | Text | The first name. | | lastName | Text | The last name. | | fullName | Text | Virtual property containing the first and last name together, which is useful for filters. | | gender | Text | The gender. Requires administrative rights to be queried. | | language | Text | The user language. Requires administrative rights to be queried. | | activated | Boolean | Indicates if the user is activated. Requires administrative rights to be queried. | | ldapUser | Boolean | Indicates if the user is a LDAP User. Requires administrative rights to be queried. | | apiUser (deprecated) | Boolean | Indicates if this is an API user. | | enabled | Boolean | Indicates if the user is enabled. | | emailAddress | Text | The user's primary email address. | | guest | Boolean | Indicates if this is a guest user. | | Relations | | | | Email | Many-to-Many | The collection of emails owned by the user. | | Phone | Many-to-Many | The collection of phone numbers owned by the user. | | InstantMessagingAccount | Many-to-Many | The collection of `InstantMessagingAccount` accounts owned by this user. | | Website | Many-to-Many | The collection of websites owned by the user. | | Address | Many-to-Many | The collection of addresses owned by the user. | | Community | One-to-Many | The collection of communities created or last modified by the user. | | Domain | One-to-Many | The collection of vocabularies created or last modified by the user. | | DomainType | One-to-Many | The collection of `DomainTypes` created or last modified by the user. | | RelationType | One-to-Many | The collection of `RelationType` created or last modified by the user. | | Relation | One-to-Many | The collection of relations created or last modified by the user. | | ComplexRelation | One-to-Many | The collection of `ComplexRelations` created or last modified by the user. | | Asset | One-to-Many | The collection of assets created or last modified by the user. | | AssetType | One-to-Many | The collection of `AssetTypes` created or last modified by the user. | | Attribute | One-to-Many | The collection of attributes created or last modified by the user. | | StringAttribute | One-to-Many | The collection of `StringAttributes` created or last modified by the user. | | ScriptAttribute | One-to-Many | The collection of ScriptAttributes created or last modified by the user. | | SingleValueListAttribute | One-to-Many | The collection of `SingleValueListAttributes` created or last modified by the user. | | MultiValueListAttribute | One-to-Many | The collection of `MultiValueListAttributes` created or last modified by the user. | | BooleanAttribute | One-to-Many | The collection of `BooleanAttributes` created or last modified by the user. | | NumericAttribute | One-to-Many | The collection of `NumericAttributes` created or last modified by the user. | | DateTimeAttribute | One-to-Many | The collection of `DateTimeAttributes` created or last modified by the user. | | DateAttribute | One-to-Many | The collection of `DateAttributes` created or last modified by the user. | | AttributeType | One-to-Many | The collection of `AttributeTypes` created or last modified by this user. | | User | One-to-Many | The collection of users created or last modified by this user. | | Group | Many-to-Many | The collection of groups to which this user belongs. | | Responsibility | One-to-Many | The collection of responsibilities linking this user to a role on an asset, domain or community. | | Role | One-to-Many | The collection or roles created or last modified by this user. | | Status | One-to-Many | The collection of statuses created or last modified by the user. | | WorkflowTaskInfo (deprecated) | One-to-Many | The collection of `WorkflowTaskInfos` created or last modified by the user. | | Mapping | One-to-Many | The collection of mappings created or last modified by the user. | | Parent Relationship Selector | | | | linkType | This parameter allows specifying the path that should be followed from the parent resource to a user. When the parent resource is responsibility or group, `linkType` is not used and the relationship defined for responsibility or group is used. When a user is the parent node, `linkType` determines the relationship with the child resources that have a created or last modified kind of relationship. See relations above. The possible values are CREATED, MODIFIED, "CREATED\_OR\_MODIFIED or CREATED OR MODIFIED. CREATED\_OR\_MODIFIED is the default value, but can only be used when User is root of the query tree. CREATED\_OR\_MODIFIED turns into a simple CREATED when User is not the root of the query. | | |

Email

Extends Resource

| | | | --------------------------------------------------------------------------------------------------- | ---- | ------------------ | | Email represents one of the user's email addresses. It can only be used as a child of the user ser. | | | | Properties | | | | emailAddress | Text | The email address. | |

Phone

Extends Resource

| | | | --------------------------------------------------------------------------------------------- | ---- | ------------------------------------------------------------ | | Phone represents one of the user's phone numbers. It can only be used as a child of the user. | | | | Properties | | | | phoneNumber | Text | The phone number. | | phoneType | Text | The phone type: FAX, MOBILE, OTHER, PAGER, PRIVATE and WORK. | |

InstantMessagingAccount

Extends Resource

| | | | ----------------------------------------------------------------------------------------------------------------------------- | ---- | ------------------------------------------------------------------------------------------------ | | `InstantMessagingAccount` represents one of the user's instant messaging account. It can only be used as a child of the user. | | | | Properties | | | | account | Text | The account id | | instantMessagingAccountType | Text | The instant messaging type: AOL, GTALK, ICQ, JABBER, LIVE\_MESSENGER, SKYPE or YAHOO\_MESSENGER. | |

Website

Extends Resource

| | | | ------------------------------------------------------------------------------------------ | ---- | --------------------------------------------------------------------- | | Website represents one of the user's websites. It can only be used as a child of the user. | | | | Properties | | | | url | Text | The URL of the website. | | websiteType | Text | The type of website: FACEBOOK, LINKEDIN, MYSPACE, TWITTER or WEBSITE. | |

Address

Extends Resource

| | | | ------------------------------------------------------------------------------------------- | ---- | ------------------------------- | | Address represents one of the user's addresses. It can only be used as a child of the user. | | | | Properties | | | | street | Text | The street. | | number | Text | The street number. | | city | Text | The city. | | postalCode | Text | The zip code. | | state | Text | The state. | | country | Text | The country. | | addressType | Text | The address type: HOME or WORK. | |

Group

Extends Resource

| | | | --------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------- | | A group is a named collection of users. | | | | Properties | | | | groupName | Text | The name of the group. | | Relations | | | | User | One-to-Many | The users that are part of this group. | | Responsibility | One-to-Many | The collection of responsibilities linking this group to a role on an asset, domain or community. | |

Responsibility

Extends Resource

| | | | -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | --------------------------------------------- | | A responsibility links a user or group with a role on an asset, domain or community. Mutually exclusive. | | | | Properties | | | | / | | | | Relations | | | | User | Many-to-One | The related user. Empty if linked to a group. | | Group | Many-to-One | The related group. Empty if linked to a user. | | Role | Many-to-One | The related role. | | Asset | Many-to-One | The associated asset. | | Domain | Many-to-One | The associated domain. | | Community | Many-to-One | The associated community. | | Filtering Property | | | | roleId | Allows filtering responsibilities using the Id property of the related role. | | |

ViewPermission

Extends Resource

| | | | --------------------------------------------------------------------------------------- | ----------- | --------------------------------------------- | | A view permission links a user or group with a domain or community. Mutually exclusive. | | | | Properties | | | | / | | | | Relations | | | | User | Many-to-One | The related user. Empty if linked to a group. | | Group | Many-to-One | The related group. Empty if linked to a user. | | Domain | Many-to-One | The associated domain. | | Community | Many-to-One | The associated community. | |

Role

Extends Asset (deprecated)

| | ---------------------------------------------------------- | | The Role that a user plays. For example, Steward or Admin. | |

Status

Extends Resource

| | | | ------------------------------------ | ----------- | -------------------------- | | The status of an asset. | | | | Properties | | | | signifier | Text(255) | The name of the status. | | description | Text | The status description. | | Relations | | | | Asset | One-to-Many | The assets of this status. | |

WorkflowTaskInfo (deprecated)

Extends Resource

| | | | ------------------------------------------------------------------------ | ------ | -------------------------------------------------------------------------------- | | `WorkflowTaskInfo` holds all information about an ongoing workflow task. | | | | Properties | | | | description | Text | The description of the task. | | title | Text | The title of the task. | | dueDate | Number | The due date of the task expressed as the number of milliseconds since 1/1/1970. | | itemResourceId | Text | The related item Id. | | itemResourceType | Text | The related resource type. | | itemVerbalized | Text | The verbalized version of the related item. | | taskType | Text | The type of task. | | assignee | Text | The id of the assigned user. | | candidateUsers | Text | The ids or candidate users. | | domain | Text | The related domain Id. | | community | Text | The related community Id. | | status | Text | The status of the task. | |

Mapping

Extends Resource

| | | | ------------------------------------------------------------------------------------------ | ----------- | ------------------------------------------------------- | | A `Mapping` links an externally defined entity, such as an asset or domain, to one entity. | | | | Properties | | | | extSystemId | Text | The identifier of the external system. | | extEntityId | Text | The external identifier of the entity. | | extEntityUrl | Text | The external URL of the entity. | | lastSyncDate | Number | The last synchronization date. | | syncAction | Text | The last synchronization action: ADD, UPDATE or REMOVE. | | description | Text | Description of this mapping. | | Relations | | | | Asset | Many-to-One | The related asset. | | Domain | Many-to-One | The related domain. | |

Tag

Extends Resource

| | | | ---------------------------------------------------------------- | ------------ | ----------------------------------- | | A `Tag` allows categorizing assets by adding one or more labels. | | | | Properties | | | | name | Text | The name of the tag. | | assetCount | Number | The number of total related assets. | | Relations | | | | Asset | Many-to-Many | The related assets. | |

DataQualityRule (deprecated)

Extends Resource

| | | | ----------------------------------------------------------------------- | ---- | --------------------------------------- | | A DataQualityRule describes the rules for the data quality of an asset. | | | | Properties | | | | name | Text | The name of the DataQualityRule. | | description | Text | The description of the DataQualityRule. | | Relations | | | |

Scope

Extends Resource

| | | | ----------------------------------------------- | ---- | ----------------------------- | | A `Scope` describes the scope of an assignment. | | | | Properties | | | | name | Text | The name of the scope. | | description | Text | The description of the scope. | | Relations | | | |

Comment

Extends Resource

| | | | -------------------------------------------------- | ----------- | -------------------------------------------------------------------------- | | Comment represents a single comment of a resource. | | | | Properties | | | | content | String | The content of this comment. | | resourceType | String | A type of the resource to which this comment belongs. | | resolved | Boolean | Whether the comment thread has been resolved. | | contentLastModifiedOn | Number | When the last edit ever happened expressed in milliseconds since 1/1/1970. | | Relations | | | | ParentComment | Many-to-One | The parent comment of this comment. | | Comment | One-to-Many | List of subcomments of this comment | | Asset | One-to-One | The asset to which this comment is linked. | | Domain | One-to-One | The domain to which this comment is linked. | | Community | One-to-One | The community to which this comment is linked. | | Filtering property | | | | rootComment | Boolean | When true, the query engine adds a filter retaining only root comments. | |

ParentComment

Extends Resource

| | --------------------------------------------------------------------------------------------------- | | `ParentComment` can only be used as a child of a comment to disambiguate the relationship followed. | |

DataType (deprecated)

Extends Entity

| | | | ------------------------------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------- | | A `DataType` is a Catalog entity that characterizes a data element's data type. | | | | Properties | | | | name | Text | The name of the type: Date or SSN. | | description | Text | Description of the type. | | class | Text | The class of `DataTypes`: BASE and ADVANCED. | | logicalDataType | Text | The corresponding logical data type used by the profiling job. It is one of the base types. | | Relations | | | | DataTypeMatch | One-to-Many | The related `DataTypeMatches` holding a specific percentage of match value for a Data Element instance. | |

AdvancedDataType (deprecated)

Extends DataType

| | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ----------------------------------------------------- | | An `AdvancedDataType` is an extension of one of the base `DataTypes`, for example, Text, Numeric or Date, that provides patterns that help the profiling job detect the Data Type. | | | | Properties | | | | Relations | | | | DataTypePattern | One-to-Many | The patterns associated with this advanced data type. | |

DataTypePattern (deprecated)

Extends Entity

| | | | ----------------------------------------------------------------------------- | ----------- | ----------------------------- | | A `DataTypePattern` contains a pattern associated with an `AdvancedDataType`. | | | | Properties | | | | value | Text | The pattern. | | Relations | | | | AdvancedDataType | Many-to-One | The related AdvancedDataType. | |

DataTypeMatch (deprecated)

Extends Entity

| | | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------------------- | | A `DataTypeMatch` contains profiling results indicating the percentage of the actual data behind a `DataElement` asset that matches a `DataType`. | | | | Properties | | | | percentage | Double | The matching percentage. | | Relations | | | | Asset | Many-to-One | The related Data Element. | | DataType | Many-to-One | The matched `DataType`. | |

BaseView (deprecated)

Extends Resource

| | | | ------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------- | | An abstract entity base class of `View` and `DiagramPicture`. | | | | Properties | | | | name | Text | The name of the `baseView`. | | description | Text | The description of the `baseView`. | | config | Text | The JSON config of the `baseView`. | | originalView | Text | The Id of the `originalView` of this base view, meaning the view from which this base view was created. | | isDefault | Boolean | Indicates if this is a default `baseView`. | | isPreferred | Boolean | Indicates if this a preferred pinned `baseView` | | Relations | | | |

View (deprecated)

Extends BaseView

| | ----------------------------------------------- | | A view in Collibra. | | Properties | | Relations | |

DiagramPicture (deprecated)

Extends BaseView

| | | | --------------------------------------------------------- | ------------ | ------------------------------------------------------------------- | | A diagram illustration. | | | | Properties | | | | svg | Text | Text field containing an SVG representation of the diagram picture. | | Relations | | | | View | Many-to-One | The view used to create ort take the picture. | | DiagramPictureSharingRule | One-to-Many | The sharing rules of the diagram picture. | | AssignmentRule | Many-to-Many | The assignment rules of the diagram picture. | |

DiagramPictureSharingRule (deprecated)

Extends Resource

| | | | -------------------------------------------------------------------------------------------- | ----------- | ------------------------------ | | A `DiagramPicture` sharing rule. A diagram picture can be shared with a user, group or role. | | | | Properties | | | | Relations | | | | Role | Many-to-One | The role linked to this rule. | | Group | Many-to-One | The group linked to this rule. | | User | Many-to-One | The user linked to this rule. | |

AssignmentRule (deprecated)

Extends Resource

| | | | ---------------------------------------------------------------------------------------------------------- | ----------- | ------------------------------ | | An assignment rule, only exposed to the graph query engine to show the asset linked to a `DiagramPicture`. | | | | Properties | | | | Relations | | | | Asset | Many-to-One | The asset linked to this rule. | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developer.collibra.com/api/guides/introduction/entities-properties-and-relations.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.