Skip to main content

System Attributes

The following system attributes can be used in the SELECT list, FROM clause and WHERE clause of a MQL Query.

System attribute name

Description

Value examples

Value data type

Supported operators in WHERE

Supported in ORDER BY

Supported in FACET

"Business Description" (Deprecated)

Business Description. The custom attribute "Definition" replaces and merges "Description" and "Business Description"

A unique number for each customer

String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS, [NOT] STARTS WITH, [NOT] ENDS WITH, [NOT] CONTAINS

Yes

No

"Certified By"

The user who certified the object

[{

"id": "-1_204",

"name": "Bob",

"fullName": "Robert Robertson",

"type": "User",

"description": "",

"email": ""

}]

Array of Grantee objects

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS Specify the name(s) of user(s) as filter values.

No

Yes

Certified

Whether or not the object is certified

true

Boolean

=, !=, [NOT] EXISTS

Yes

No

Children (Deprecated)

Names of the children

["EmployeeId", "FirstName", "LastName", "Address"]

Array of String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

No

Collections

Collections

["Hot Reports", "New Tables"]

Array of String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

No

"Column Histogram"

Column histogram

[{"count": 1,

"lower": "1930-01-01 00:00:00",

"upper": "1940-01-01 00:00:00"

}, {

"count": 1,

"lower": "1940-01-01 00:00:00",

"upper": "1950-01-01 00:00:00"

}, {

"count": 3,

"lower": "1950-01-01 00:00:00",

"upper": "1960-01-01 00:00:00"

}, {

"count": 4,

"lower": "1960-01-01 00:00:00",

"upper": "1970-01-01 00:00:00"

}]

Array of DataProfile_Histogram

[NOT] EXISTS

No

No

"Column Statistics"

Column statistics

{ "DistinctRows": 9,

"DuplicateRows": 0,

"ValidRows": 9,

"EmptyRows": 0,

"InvalidRows": 0

}

DataProfile_Statistics

[NOT] EXISTS

No

No

"Comment Count"

Comment count

2

Integer

=, !=, = ANY (...), != ANY (...), [NOT] EXISTS, <, <=, >, >= and BETWEEN … AND …

Yes

Yes

"Commented By"

The users who commented on the object

[{

"id": "-1_204",

"name": "Bob",

"fullName": "Robert Robertson",

"type": "User",

"description": "",

"email": ""

}, {

"id": "-1_390",

"name": "Susan",

"fullName": "Susan Smith",

"type": "User",

"description": "",

"email": ""

}]

Array of Grantee objects

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

Specify the name(s) of user(s) as filter values.

No

Yes

"Conditional Labels"

Conditional labels associated with the object

[{

"name": "Endorsed",

"description": "Endorsed objects"

}]

Array of ConditionalLabel objects

=, ANY (...), = ALL (...)

No

No

Context

Context (or model path)

[{

"id": "204_1",

"objectType": {

"name": "Meta Integration (Glossary).Glossary"

},

"name": "Finance Glossary"

}, {

"id": "204_2",

"objectType": {

"name": "Meta Integration (Glossary).Category"

},

"name": "Domains"

}]

Array of Entity

[NOT] EXISTS

No

No

"Created Date"

For Imported Objects: Created date in the source system for some models. (not all bridges will have this information. )

For Custom Model Objects: The time the object was created. If an object was restored (from repository backup) it will not have a created date as the history is never backed up and thus not restored.

2018-09-24 13:25:17

Date

=, BEFORE, AFTER, BETWEEN ... AND ... , [NOT] EXISTS

Yes

Yes

"Created By"

The user who created the object. Supported on custom model objects, physical data model objects, semantic mapping objects and data mapping objects.

{

"id": "-1_204",

"name": "Bob",

"fullName": "Robert Robertson",

"type": "User",

"description": "",

"email": ""

}

Grantee

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

Specify the name of user as filter value.

Yes

Yes

"Data Classifications"

Names of the proposed or approved data classes. Run GET /repository/dataClasses/{objectId} to get a list of available data classes

["Airport Code", "Airport Name"]

Array of String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

Yes

"Data Classifications Proposed"

Names of the proposed data classes. Run GET /repository/dataClasses/{objectId} to get a list of available data classes

["Airport Code", "Airport Name"]

Array of String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

Yes

"Data Classifications Approved"

Names of the approved data classes. Run GET /repository/dataClasses/{objectId} to get a list of available data classes

["Airport Code", "Airport Name"]

Array of String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

Yes

"Data Classifications Matched"

Names of the matched data classes. Run GET /repository/dataClasses/{objectId} to get a list of available data classes

["Airport Code", "Airport Name"]

Array of String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

Yes

"Data Classifications Rejected"

Names of the rejected data classes. Run GET /repository/dataClasses/{objectId} to get a list of available data classes

["Airport Code", "Airport Name"]

Array of String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

Yes

"Data Profiling"

Data profiling data

{ "totalProfiledRows": 9,

"profilingDate": "2020-01-23 23:18:49",

"statistics": {

"distinctRows": 4,

...,

"maxLength": 24

},

"inferredDataTypes": {

"string": 9

},

"invalidDataTypeValues": [],

"patterns": {

"Aaaaa Aaaaaaa": 1,

...,

"Aaaaa Aaaaaaaaaaaaaa": 6

},

"values": {

"Vice President, Sales": 1,

"Sales Representative": 6,

"Inside Sales Coordinator": 1,

"Sales Manager": 1

},

"histogram": []

}

DataProfile

[NOT] EXISTS

No

No

"Data Quality Latest Date"

Most recent date the data quality of the object was imported

2024-03-13 15:36:44

Date

=, BEFORE, AFTER, BETWEEN ... AND ... , [NOT] EXISTS

Yes

Yes

"Data Quality Latest Score"

More recent score of the data quality of the object

90

Integer

=, !=, = ANY (...), != ANY (...), [NOT] EXISTS, <, <=, >, >= and BETWEEN … AND …

Yes

Yes

"Data Quality Latest Status"

Most recent status of the data quality of the object

Good

Enumeration: Good, Acceptable, Bad

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS, [NOT] STARTS WITH, [NOT] ENDS WITH, [NOT] CONTAINS

Yes

Yes

"Data Sampling"

Data sampling data

{ "header": ["city", "birthdate"],

"samples": [["Seattle", "New York", "San Francisco"],

["1970-01-01", "2001-10-20", "1990-10-02"]]

}

DataSample

[NOT] EXISTS

No

No

"Data Select Method"

How the data query should select the rows of the profiled object

Top Rows

Enumeration: Default, Top Rows, Random Rows, Custom

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS, [NOT] STARTS WITH, [NOT] ENDS WITH, [NOT] CONTAINS

Yes

Yes

"Data Select Query"

Custom SELECT SQL statement to use to retrieve the most relevant data for profiling and sampling rows of this object

String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS, [NOT] STARTS WITH, [NOT] ENDS WITH, [NOT] CONTAINS

No

No

Destination

The destination objects of a complex relationship object

[{

"id": "5091_3",

"name": "Employees",

"objectType": {

"name": "Table",

"displayName": "Table"

}

}]

Array of Entity

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

No

"Destination Model"

The models of the destination objects of a complex relationship object

[{

"id": "5090_1",

"name": "Accounts Payable erwin",

"objectType": {

"name": "DataModel",

"displayName": "DataModel"

}

}]

Array of Entity

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

No

Documentation

The summarized documentation of the object. The summarized documentation returns the first documentation found on the object following the following priority: Business Documentation > Term Documentation > Mapped Documentation > Inferred Documentation > Imported (Documentation) > Searched (Documentation). Warning: Using this attribute may cause bad performance.

The original Documentation of glossary terms has been renamed to "Long Description" to not conflict with the new "Documentation" attribute described above.

[{

"type": "MAPPED",

"entity": {

"id": "8366_23",

"name": "Account",

"objectType": {

"name": "Term",

"displayName": "Term"

},

"attributes": null

}

}]

Array of SemanticEntity

[NOT] EXISTS

No

No

Editors

Editors of worksheets, collections and dashboards

[{

"id": "-1_204",

"name": "Bob",

"fullName": "Robert Robertson",

"type": "User",

"description": "",

"email": ""

}, {

"id": "-1_390",

"name": "Susan",

"fullName": "Susan Smith",

"type": "User",

"description": "",

"email": ""

}]

Array of Grantee objects

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

Specify the name(s) of user(s) or group(s) as filter values.

No

Yes

"Endorsement Count"

Endorsement count

4

Integer

=, !=, = ANY (...), != ANY (...), [NOT] EXISTS, <, <=, >, >= and BETWEEN … AND …

Yes

Yes

"Endorsed By"

The users who endorsed the object

[{

"id": "-1_204",

"name": "Bob",

"fullName": "Robert Robertson",

"type": "User",

"description": "",

"email": ""

}, {

"id": "-1_390",

"name": "Susan",

"fullName": "Susan Smith",

"type": "User",

"description": "",

"email": ""

}]

Array of Grantee objects

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

Specify the name(s) of user(s) as filter values.

No

Yes

"Has Data Impact"

Has Data Impact

true

Boolean

=, !=, [NOT] EXISTS

No

No

"Has Data Lineage"

Has Data Lineage

true

Boolean

=, !=, [NOT] EXISTS

No

No

"Has Semantic Definition"

Has Semantic Definition

true

Boolean

=, !=, [NOT] EXISTS

No

No

"Has Semantic Usage"

Whether or not a term is used.

true

Boolean

=, !=, [NOT] EXISTS

No

No

"Imported Date"

For Imported Objects: The last time the object was imported (possibly after incremental harvesting), which might be newer than the Updated Date. This date is critical to assess the freshness / accuracy of the Updated Dates, when the import is manual, or on a slow pace weekly / monthly schedule.

For Custom Model Objects: Not Applicable

2023-09-24 13:25:17

Date

=, BEFORE, AFTER, BETWEEN ... AND ... , [NOT] EXISTS

Yes

Yes

"Import Bridge"

For Imported Objects: The name of the bridge used to import the object.

For Custom Model Objects: Not Applicable

Microsoft Azure Power BI Service (Repository)

String

=, !=, = ANY (...), != ANY (...), [NOT] EXISTS, [NOT] STARTS WITH, [NOT] ENDS WITH, [NOT] CONTAINS

No

No

"Inferred Documentation"

The list of terms (name and description) indirectly documenting the objects through its pass-through data lineage / impact. Warning: Using this attribute may cause bad performance.

[{

"type": "SEARCHED",

"entity": {

"id": "8366_23",

"name": "Account",

"objectType": {

"name": "Term",

"displayName": "Term"

},

"attributes": null

}

}]

Array of Semantic Entity

[NOT] EXISTS

No

No

Labels

Labels

["Jons Tasks", "Obsolete"]

Array of String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

Yes

"Last Change Event"

The description of the last change made on the object

Business Name was changed to "NorthwindCustomers"

String

None

No

No

"Mapped Documentation"

The list of semantically mapped objects (name and description) documenting the object. Warning: Using this attribute may cause bad performance.

[{

"type": "MAPPED",

"entity": {

"id": "8366_23",

"name": "Account",

"objectType": {

"name": "Term",

"displayName": "Term"

},

"attributes": null

}

}]

Array of Semantic Entity

[NOT] EXISTS

No

No

"Mentioned Objects"

Object(s) mentioned in an object

[{

"id": "5091_3",

"name": "Employees",

"objectType": {

"name": "Table",

"displayName": "Table"

}}]

Array of Entity

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), =WHERE(…), !=WHERE(...), [NOT] EXISTS

Specify the stable id(s) of object(s) as filter values

No

No

"Mentioned Users"

User(s) and group(s) mentioned in an object

[{

"id": "-1_204",

 "name": "Bob",

 "fullName": "Robert Robertson",

  "type": "User",

  "description": "",

 "email": ""

}]

Array of Grantee objects

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

Specify the name(s) of user(s) or group(s) as filter values.

No

Yes

"Model Definition"

Definition on the repository model

Accounts Payable

String

None

No

No

Model

Name of the repository model. If the model is a nested model, it will be "multi-model"."single model"

Northwind.dbo

String

=, !=, = ANY (...), != ANY (...), =WHERE(…), !=WHERE(...)

Yes

Yes

"Model Id"

Model Id

35913

Integer

=, !=, = ANY (...), != ANY (...)

Yes

Yes

"Model Name"

Name of the root repository model

Accounts Payable

String

None

No

No

"Modified Date"

For Imported Objects: Modified date in the source system for some models. (not all bridges will have this information. ) Snowflake is an example of a bridge which supports this feature.

For Custom Model Objects: Not Applicable

2018-09-24 13:25:17

Date

=, BEFORE, AFTER, BETWEEN ... AND ... , [NOT] EXISTS

Yes

Yes

"My Workflow Tasks"

Workflow step-based actions on a custom model object available to you with the workflow role assignments you have

["Discard", "Mark for Deprecation", "Start Review", "Submit for Approval"]

Array of String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

No

Name

Name

Custom ID

String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS, [NOT] STARTS WITH, [NOT] ENDS WITH, [NOT] CONTAINS

Yes

Yes

"Native Id"

Native ID

{799A0437-D91A-4CC5-998A-7C23E2130F39}+00000001

String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS, [NOT] STARTS WITH, [NOT] ENDS WITH, [NOT] CONTAINS

Yes

Yes

"Object Id"

Object Identifier

123_45678

String

=, !=, = ANY (...), != ANY (...)

Yes

No

"Object Image"

Object Image

{

"type": IMAGE,

"name": "image",

"location": "USSocialSecurityCard.png",

"size": "8450"

}

Attachment

[NOT] EXISTS

No

No

"Object Profile"

Profile Name. Run GET /types/listProfiles to get a list of profile names

Tableau (Business)

String

=, !=, = ANY (...), != ANY (...)

No

No

"Object StableId"

Object stable identifier encoded in Base 64

AAAC0AAa1sJ7wyKdA0EUkZYCu9hE_-v4uQ

String

=, !=, = ANY (...), != ANY (...)

No

No

"Object System Type"

Entity System Type: Entity Group, Relationship Group, Classifier, Feature, Diagram, Connection, Schema, Content, System, Hierarchy, Model, Namespace, Key, or Custom Attribute

Classifier

String

=, !=, = ANY (...), != ANY (...)

Yes

Yes

"Object Type"

Entity Type. Run GET /types/listEntityTypes to get a list of entity types of a profile

Table

String

=, !=, = ANY (...), != ANY (...)

Yes

Yes

"Object Type Id"

Entity Type ID

277000016

Integer

=, !=, = ANY (...), != ANY (...)

Yes

Yes

"Open In Tool"

The URL which opens a report in the supported tool

null

String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS, [NOT] STARTS WITH, [NOT] ENDS WITH, [NOT] CONTAINS

No

No

Owner

The user who is the owner of a worksheet, collection, or dashboard.

{

"id": "-1_204",

"name": "Bob",

"fullName": "Robert Robertson",

"type": "User",

"description": "",

"email": ""

}

Grantee

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

Specify the name of user as filter value.

No

Yes

Parent

The name of the parent

dbo

String

=, = ANY (...)

No

No

"Physical Name"

Physical Name

CustomID

String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS, [NOT] STARTS WITH, [NOT] ENDS WITH, [NOT] CONTAINS

Yes

Yes

"Replication Quality"

The replication quality of a replication link

{

"featureMappings": [

{

"sourceField": "1597_222",

"destinationField": "1601_114"

},

{

"sourceField": "1597_223",

"destinationField": "1601_115"

}

],

"numberOfSourceFields": 3,

"numberOfDestinationFields": 4

}

ReplicationQuality

None

No

No

"Sensitivity Label"

The current (approved, data proposed, or lineage proposed) sensitivity label associated with the object. Run GET /repository/sensitivityLabels to get a list of available sensitivity labels

{

"name": "Top Secret",

"position": 5,

"description": "",

"status": "APPROVED",

"foregroundColor": "",

"backgroundColor": ""

}

SensitivityLabelWithStatus

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

No

"Sensitivity Label Approved"

Approved sensitivity label. Run GET /repository/sensitivityLabels to get a list of available sensitivity labels

{

"name": "Confidential",

"position": 4,

"description": "",

"status": "APPROVED",

"foregroundColor": "",

"backgroundColor": ""

}

SensitivityLabelWithStatus

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

Yes

"Sensitivity Label Lineage Proposed"

Sensitivity label inferred from other objects using data flow analysis. Run GET /repository/sensitivityLabels to get a list of available sensitivity labels

{

"name": "Confidential",

"position": 4,

"description": "",

"status": "INFERRED",

"foregroundColor": "",

"backgroundColor": ""

}

SensitivityLabelWithStatus

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

No

"Sensitivity Labels Data Proposed"

Sensitivity labels detected during the data classification process and thus associated with this object. Run GET /repository/sensitivityLabels to get a list of available sensitivity labels

[{

"status": "PROPOSED",

"name": "Confidential",

"position": 4,

"description": "",

"foregroundColor": "",

"backgroundColor": ""

}, {

"status": "PROPOSED",

"name": "Prohibit export",

"position": 2,

"description": "",

"foregroundColor": "",

"backgroundColor": ""

}]

Array of SensitivityLabelWithStatus

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

Yes

"Sensitivity Labels Rejected"

Rejected sensitivity labels. Run GET /repository/sensitivityLabels to get a list of available sensitivity labels

[{

"status": "REJECTED",

"name": "Top Secret",

"position": 5,

"description": "",

"foregroundColor": "",

"backgroundColor": ""

}]

Array of SensitivityLabelWithStatus

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

Yes

Source

The source objects of a complex relationship object

[{

"id": "5091_3",

"name": "Employees",

"objectType": {

"name": "Table",

"displayName": "Table"

}

}]

Array of Entity

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

No

"Source Model"

The models of the source objects of a complex relationship object

[{

"id": "5090_1",

"name": "Accounts Payable erwin",

"objectType": {

"name": "DataModel",

"displayName": "DataModel"

}

}]

Array of Entity

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

No

"Source System Definition"

"Source System Definition" on imported objects replaces any use of "Definition", "Description", or "Comment" in the source system metamodel (profile) imported from data modeling, data integration, and business intelligence tools

Custom's identifier

String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS, [NOT] STARTS WITH, [NOT] ENDS WITH, [NOT] CONTAINS

No

No

"System Description"

Replaces "Description"

Custom's identifier

String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS, [NOT] STARTS WITH, [NOT] ENDS WITH, [NOT] CONTAINS

Yes

No

Term (Deprecated)

Names of the terms used to define the object

["Address", "AddressLine"]

Array of String

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

No

No

"Term Documentation" (Deprecated)

The list of terms (name and description) documenting the object. Also known as "Is Defined By" custom relationship

[{

"type": "CLASSIFIED",

"entity": {

"id": "8366_23",

"name": "Account",

"objectType": {

"name": "Term",

"displayName": "Term"

},

"attributes": null

}

}]

Array of SemanticEntity

None. Use Term system attribute, or "Is Defined By" custom relationship.

No

No

"Updated By"

The user who made the last update

{

"id": "-1_204",

"name": "Bob",

"fullName": "Robert Robertson",

"type": "User",

"description": "",

"email": ""

}

Grantee

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

Specify the name of user as filter value.

Yes

Yes

"Updated Date"

The date when an object of authored content was last updated, including custom model objects (e.g.glossary terms). Or for imported objects, it is the last date the repository object was updated, not the last date the object was updated in the source system.

2018-09-24 13:25:17

Date

=, BEFORE, AFTER, BETWEEN ... AND ... , [NOT] EXISTS

Yes

Yes

Viewers

Viewers of worksheets, collections, and dashboards

[{

"id": "-1_204",

"name": "Bob",

"fullName": "Robert Robertson",

"type": "User",

"description": "",

"email": ""

}, {

"id": "-1_390",

"name": "Susan",

"fullName": "Susan Smith",

"type”: “User",

"description": "",

"email": ""

}]

Array of Grantee objects

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

Specify the name(s) of user(s) or group(s) as filter values.

No

Yes

"Warning Count"

Warning count

1

Integer

=, !=, = ANY (...), != ANY (...), [NOT] EXISTS, <, <=, >, >= and BETWEEN … AND …

Yes

Yes

"Warned By"

The users who put a warning on the object

[{

"id": "-1_204",

"name": "Bob",

"fullName": "Robert Robertson",

"type": "User",

"description": "",

"email": ""

}, {

"id": "-1_390",

"name": "Susan",

"fullName": "Susan Smith",

"type": "User",

"description": "",

"email": ""

}]

Array of Grantee objects

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

Specify the name(s) of user(s) as filter values.

No

Yes

Watchers

Users and groups who are the watchers of the model. It returns null if the object is not a model.
For any name specified as a value of the filter, the name is treated as a user if there exist a user and a group by the same name. To avoid ambiguity, avoid naming users and groups by the same names.

[{

"id": "-1_204",

"name": "Bob",

"fullName": "Robert Robertson",

"type": "User",

"description": "",

"email": ""

}, {

"id": "-1_39",

"name": "Data Lake Data Analyst",

"fullName": "",

"type": "UserGroup",

"description": "",

"email": ""

}]

Array of Grantee objects

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

Specify the name(s) of user(s) or group(s) as filter values.

No

No

"Workflow Assignees"

Users and groups who can perform any transitions on the object.
For any name specified as a value of the filter, the name is treated as a user if there exist a user and a group by the same name. To avoid ambiguity, avoid naming users and groups by the same names.

[{

"id": "-1_204",

"name": "Bob",

"fullName": "Robert Robertson",

"type": "User",

"description": "",

"email": ""

}, {

"id": "-1_39",

"name": "Data Lake Data Analyst",

"fullName": "",

"type": "UserGroup",

"description": "",

"email": ""

}]

Array of Grantee objects

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS

Specify the name(s) of user(s) or group(s) as filter values.

No

No

"Workflow Deprecation Requested"

Return value true or false indicates whether an object has been requested for deprecation. Null is returned if the object belongs to a model which is not workflow enabled.

true

Boolean

=, !=, [NOT] EXISTS

No

No

"Workflow State"

Current workflow state of a custom model object

Approved

Enumeration: Draft, Under Review, Pending Approval, Approved, Published, Deprecated

Note: the workflow state is localized.

=, !=, = ANY (...), != ANY (...), = ALL (...), != ALL (...), [NOT] EXISTS, [NOT] STARTS WITH, [NOT] ENDS WITH, [NOT] CONTAINS

Yes

Yes

"Workflow Published"

Return value true or false indicates whether an object belongs to the editable version of a workflow enabled custom model and the object exists in the published version of the model. Null is returned if the object belongs to a non-editable version, or the model is not workflow enabled.

true

Boolean

=, !=, [NOT] EXISTS

No

No

Unlike profile attributes, custom attributes and UDPs, which normally hold scalar values (except for multi-valued custom attributes), the value of a system attribute can be an object or an array of scalar values or objects. For example, the value of Context is an array of Entity objects.

System attributes can be used in the SELECT list and WHERE clause of any MQL query, which can be used to define a Worksheet in MM Explorer or used as an input parameter or part of the body parameter to some REST API methods. Some system attributes can also be used in the Order By clause of a MQL query.

The following REST API methods take a SELECT query parameter, or a QueryInput body parameter which contains a SELECT clause. For more information about the REST API methods, refer to the MM REST API documentation.

  • GET /entities/validateMQLQuery
  • POST /entities/executeMQLQuery
  • GET /entities/{objectId}
  • GET /relationships/{objectId}

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!