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 thedisplayLength
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.
CommunityExtends Organization |
||
---|---|---|
Exact synonym of an organization but with default filtering on organizationType equal to "C" |
ParentCommunityExtends Community |
||
---|---|---|
Exact synonym of a community. It can only be used as a child of the community to disambiguate the relationship followed. |
ChildDomainTypesExtends DomainType |
||
---|---|---|
Exact synonym of DomainType . Can only be used as a child of DomainType to disambiguate the relationship followed. |
SourceAssetExtends Asset |
||
---|---|---|
Exact synonym of |
TargetAssetExtends Asset |
||
---|---|---|
Exact synonym of Asset . It can only be used as a child of a relation to disambiguate the relationship followed. |
SourceAssetTypeExtends AssetType |
||
---|---|---|
Exact synonym of AssetType . It can only be used as a child of RelationType to disambiguate the relationship followed. |
TargetAssetTypeExtends AssetType |
||
---|---|---|
Exact synonym of AssetType . Can only be used as a child of RelationType to disambiguate the relationship followed. |
ScriptAttributeExtends Attribute |
||
---|---|---|
A ScriptAttribute is an attribute dedicated to script values. |
||
Properties |
||
script |
Text | The script. Obsolete, but returns the same content as Attribute:value . |
SingleValueListAttributeExtends Attribute |
||
---|---|---|
A SingleValueListAttribute is an attribute dedicated to storing a single value selected from a list. |
MultiValueListAttributeExtends Attribute |
||
---|---|---|
A MultiValueListAttribute is an attribute dedicated to storing multiple values selected from a list. |
||
Properties |
||
values |
Text | The multiple values |
BooleanAttributeExtends Attribute |
||
---|---|---|
A BooleanAttribute is an attribute dedicated to Boolean values. |
||
Properties |
||
booleanValue |
Boolean | The value |
NumericAttributeExtends Attribute |
||
---|---|---|
A NumericAttribute is an attribute dedicated to numeric values. |
||
Properties |
||
numericValue |
Number | The stored number. |
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. |
RoleExtends Asset (deprecated) |
||
---|---|---|
The Role that a user plays. For example, Steward or Admin. |
StatusExtends 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. |
ScopeExtends 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 |
ParentCommentExtends Resource |
||
---|---|---|
|
View (deprecated)Extends BaseView |
||
---|---|---|
A view in Collibra. | ||
Properties |
||
Relations |