API docs by Redocly

Folio Query Tool API (v1)

Folio Query Tool API

entity-types

getEntityType

Get definition of an Entity Type.

path Parameters
entityTypeId
required
string <uuid> (UUID)

UUID of the entity type

query Parameters
includeHidden
boolean
Default: false

Include the hidden column in the display

Responses

Response samples

Content type
application/json
{
  • "id": "0cb79a4c-f7eb-4941-a104-745224ae0292",
  • "name": "item_details",
  • "private": false,
  • "columns": [ ]
}

updateEntityTypeUsedBy

Update the usedBy information for an Entity Type.

path Parameters
entityTypeId
required
string <uuid> (UUID)

UUID of the entity type

Request Body schema: application/json
required
name
string

The name of the consumer to add/remove.

operation
required
string
Enum: "add" "remove"

The operation to perform.

Responses

Request samples

Content type
application/json
{
  • "name": "my-module",
  • "operation": "add"
}

Response samples

Content type
application/json
{
  • "id": "0cb79a4c-f7eb-4941-a104-745224ae0292",
  • "name": "item_details",
  • "private": false,
  • "columns": [ ],
  • "usedBy": [
    ]
}

getColumnValues

Get the values of an entity type column.

path Parameters
entityTypeId
required
string <uuid> (UUID)

UUID of the entity type

columnName
required
string

Name of an entity type column

query Parameters
search
string

A search text that can be used to filter column values. If provided, only the values that begins with the given text will be returned in API response.

Responses

Response samples

Content type
application/json
{
  • "content": [
    ]
}

createCustomEntityType

Create a custom entity type

Request Body schema: application/json
required

Custom entity type definition

id
required
string

A UUID identifying entity type

name
required
string

The unique name of entity type like User, Loan, Item, etc.

description
string

A description of the entity type

labelAlias
string

The identifier used for a localized label/name for this entity.

private
required
boolean

This flag denotes whether the entity type is private or not. Private entity types cannot be accessed by users for querying.

customFieldEntityTypeId
string

The IDs of the custom field entity type

Array of objects (Entity Type Column Schema)
Default: []
Array
name
required
string

The name of this field.

required
object (EntityDataType)
labelAlias
string

A pre-localized identifier used to label/name this column.

queryable
boolean

Indicates whether this column can be used in a query.

queryOnly
boolean

Indicates whether this column can be used for querying only. If true, the column can be used in a query but cannot be included in results.

object (Source of an entity type column)

Source of an entity type column, from where the values for the column can be derived

object (Value source API config)

Configuration for a column's value source API, where the available values can be accessed

valueGetter
string

Configuration defining how to fetch values of this column from the underlying datasource.

filterValueGetter
string

Configuration defining how to filter values of this column from the underlying datasource when indexed values aren't very user-friendly.

idColumnName
string

Name of the corresponding ID column, if this column contains the value of an ID.

valueFunction
string

Configuration defining how to transform a static value for comparison with values produced by the filterValueGetter. This is useful when the filterValueGetter does extra processing that is not visible to the user. The static value can be referenced with ':value'

hidden
boolean
Default: false

Indicates if the field is hidden in UI

Array of objects (Column value with label Schema)

Array of values for this column

ecsOnly
boolean

Indicates if the field is available only in ECS environments

visibleByDefault
boolean

Indicates if the column should be shown by default when the entity is viewed.

isCustomField
boolean

Indicates if the column belongs to the custom field.

isIdColumn
boolean

Indicates if the column is part of the unique identifier for this entity type

sourceAlias
string

Source alias for this column

essential
boolean

Indicates if a column is crucial to the definition of an entity type

Array of objects (Definition of a possible field join)
Default: []

A set of columns which this column may be joined to

originalEntityTypeId
string <uuid>

[Internal only, not for definitions] The simplest entity type that this column is derived from

crossTenantQueriesEnabled
boolean
Default: false

Indicates if this entity type supports cross-tenant queries

Array of objects (Default sort criteria for an entity type)
Array
columnName
required
string

Name of the column using which entity type has to be sorted

direction
required
string
Enum: "ASC" "DESC"

Direction of the sort (Ascending or Descending)

fromClause
string
Deprecated

FROM clause containing all src views that need to be joined to query this entity type

idView
string

View from which the content IDs for this entity type are extracted

groupByFields
Array of strings

Ordered list of fields used in the GROUP BY clause for this entity type

sourceView
string

View from which the dynamic columns for this entity type are extracted

sourceViewExtractor
string

Getting the base source of the custom field

Array of objects (Entity Type Source)
Default: []
Array
type
required
string

Type of source. Valid values are db, entity-type

alias
required
string

Alias of this source to be used in query/later joins

name
string

Name of this source. If set, this will override any source name translations

joinedViaEntityType
string

[Internal use only, should not be included in definitions] The owning entity's alias, if this source's joining is handled by a parent entity in a cross-entity join

order
integer
Default: 1073741823

Order of the inherited fields from this source, relative to the fields from other sources. Defaults to 1073741823 (INT_MAX/2)

target
string

Target view/table from which values are extracted

object (Entity Type DB Source Join)

[Deprecated for use in definitions; you should likely create simple wrapper entity types and join those] Object describing how this DB view/table should be joined to another

requiredPermissions
Array of strings
Default: []

List of permissions required to query this entity type

filterConditions
Array of strings
Default: []

Filter conditions to be included in the WHERE clause of this entity type

additionalEcsConditions
Array of strings
Default: []

Additional conditions to be included in the WHERE clause of this entity type in ECS environments

deleted
boolean
Default: false

Indicates if this entity type is deleted

usedBy
Array of strings
Default: []

List of modules that use this entity type

owner
string <uuid>

A UUID identifying entity type owner

shared
boolean
Default: false

Denotes if the entity type is shared (true) or private (false)

createdAt
string <date-time>

The creation timestamp of the entity type

updatedAt
string <date-time>

The update timestamp of the entity type

isCustom
boolean
Default: true

Discriminator field to distinguish custom entity types from system entity types

Value: true
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "labelAlias": "string",
  • "private": true,
  • "customFieldEntityTypeId": "string",
  • "columns": [ ],
  • "crossTenantQueriesEnabled": false,
  • "defaultSort": [
    ],
  • "fromClause": "string",
  • "idView": "string",
  • "groupByFields": [
    ],
  • "sourceView": "string",
  • "sourceViewExtractor": "string",
  • "sources": [ ],
  • "requiredPermissions": [ ],
  • "filterConditions": [ ],
  • "additionalEcsConditions": [ ],
  • "deleted": false,
  • "usedBy": [ ],
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "shared": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "isCustom": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "labelAlias": "string",
  • "private": true,
  • "customFieldEntityTypeId": "string",
  • "columns": [ ],
  • "crossTenantQueriesEnabled": false,
  • "defaultSort": [
    ],
  • "fromClause": "string",
  • "idView": "string",
  • "groupByFields": [
    ],
  • "sourceView": "string",
  • "sourceViewExtractor": "string",
  • "sources": [ ],
  • "requiredPermissions": [ ],
  • "filterConditions": [ ],
  • "additionalEcsConditions": [ ],
  • "deleted": false,
  • "usedBy": [ ],
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "shared": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "isCustom": true
}

getCustomEntityType

path Parameters
entityTypeId
required
string <uuid> (UUID)

UUID of the entity type

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "labelAlias": "string",
  • "private": true,
  • "customFieldEntityTypeId": "string",
  • "columns": [ ],
  • "crossTenantQueriesEnabled": false,
  • "defaultSort": [
    ],
  • "fromClause": "string",
  • "idView": "string",
  • "groupByFields": [
    ],
  • "sourceView": "string",
  • "sourceViewExtractor": "string",
  • "sources": [ ],
  • "requiredPermissions": [ ],
  • "filterConditions": [ ],
  • "additionalEcsConditions": [ ],
  • "deleted": false,
  • "usedBy": [ ],
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "shared": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "isCustom": true
}

updateCustomEntityType

path Parameters
entityTypeId
required
string <uuid> (UUID)

UUID of the entity type

Request Body schema: application/json
required

Custom entity type definition

id
required
string

A UUID identifying entity type

name
required
string

The unique name of entity type like User, Loan, Item, etc.

description
string

A description of the entity type

labelAlias
string

The identifier used for a localized label/name for this entity.

private
required
boolean

This flag denotes whether the entity type is private or not. Private entity types cannot be accessed by users for querying.

customFieldEntityTypeId
string

The IDs of the custom field entity type

Array of objects (Entity Type Column Schema)
Default: []
Array
name
required
string

The name of this field.

required
object (EntityDataType)
labelAlias
string

A pre-localized identifier used to label/name this column.

queryable
boolean

Indicates whether this column can be used in a query.

queryOnly
boolean

Indicates whether this column can be used for querying only. If true, the column can be used in a query but cannot be included in results.

object (Source of an entity type column)

Source of an entity type column, from where the values for the column can be derived

object (Value source API config)

Configuration for a column's value source API, where the available values can be accessed

valueGetter
string

Configuration defining how to fetch values of this column from the underlying datasource.

filterValueGetter
string

Configuration defining how to filter values of this column from the underlying datasource when indexed values aren't very user-friendly.

idColumnName
string

Name of the corresponding ID column, if this column contains the value of an ID.

valueFunction
string

Configuration defining how to transform a static value for comparison with values produced by the filterValueGetter. This is useful when the filterValueGetter does extra processing that is not visible to the user. The static value can be referenced with ':value'

hidden
boolean
Default: false

Indicates if the field is hidden in UI

Array of objects (Column value with label Schema)

Array of values for this column

ecsOnly
boolean

Indicates if the field is available only in ECS environments

visibleByDefault
boolean

Indicates if the column should be shown by default when the entity is viewed.

isCustomField
boolean

Indicates if the column belongs to the custom field.

isIdColumn
boolean

Indicates if the column is part of the unique identifier for this entity type

sourceAlias
string

Source alias for this column

essential
boolean

Indicates if a column is crucial to the definition of an entity type

Array of objects (Definition of a possible field join)
Default: []

A set of columns which this column may be joined to

originalEntityTypeId
string <uuid>

[Internal only, not for definitions] The simplest entity type that this column is derived from

crossTenantQueriesEnabled
boolean
Default: false

Indicates if this entity type supports cross-tenant queries

Array of objects (Default sort criteria for an entity type)
Array
columnName
required
string

Name of the column using which entity type has to be sorted

direction
required
string
Enum: "ASC" "DESC"

Direction of the sort (Ascending or Descending)

fromClause
string
Deprecated

FROM clause containing all src views that need to be joined to query this entity type

idView
string

View from which the content IDs for this entity type are extracted

groupByFields
Array of strings

Ordered list of fields used in the GROUP BY clause for this entity type

sourceView
string

View from which the dynamic columns for this entity type are extracted

sourceViewExtractor
string

Getting the base source of the custom field

Array of objects (Entity Type Source)
Default: []
Array
type
required
string

Type of source. Valid values are db, entity-type

alias
required
string

Alias of this source to be used in query/later joins

name
string

Name of this source. If set, this will override any source name translations

joinedViaEntityType
string

[Internal use only, should not be included in definitions] The owning entity's alias, if this source's joining is handled by a parent entity in a cross-entity join

order
integer
Default: 1073741823

Order of the inherited fields from this source, relative to the fields from other sources. Defaults to 1073741823 (INT_MAX/2)

target
string

Target view/table from which values are extracted

object (Entity Type DB Source Join)

[Deprecated for use in definitions; you should likely create simple wrapper entity types and join those] Object describing how this DB view/table should be joined to another

requiredPermissions
Array of strings
Default: []

List of permissions required to query this entity type

filterConditions
Array of strings
Default: []

Filter conditions to be included in the WHERE clause of this entity type

additionalEcsConditions
Array of strings
Default: []

Additional conditions to be included in the WHERE clause of this entity type in ECS environments

deleted
boolean
Default: false

Indicates if this entity type is deleted

usedBy
Array of strings
Default: []

List of modules that use this entity type

owner
string <uuid>

A UUID identifying entity type owner

shared
boolean
Default: false

Denotes if the entity type is shared (true) or private (false)

createdAt
string <date-time>

The creation timestamp of the entity type

updatedAt
string <date-time>

The update timestamp of the entity type

isCustom
boolean
Default: true

Discriminator field to distinguish custom entity types from system entity types

Value: true
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "labelAlias": "string",
  • "private": true,
  • "customFieldEntityTypeId": "string",
  • "columns": [ ],
  • "crossTenantQueriesEnabled": false,
  • "defaultSort": [
    ],
  • "fromClause": "string",
  • "idView": "string",
  • "groupByFields": [
    ],
  • "sourceView": "string",
  • "sourceViewExtractor": "string",
  • "sources": [ ],
  • "requiredPermissions": [ ],
  • "filterConditions": [ ],
  • "additionalEcsConditions": [ ],
  • "deleted": false,
  • "usedBy": [ ],
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "shared": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "isCustom": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "labelAlias": "string",
  • "private": true,
  • "customFieldEntityTypeId": "string",
  • "columns": [ ],
  • "crossTenantQueriesEnabled": false,
  • "defaultSort": [
    ],
  • "fromClause": "string",
  • "idView": "string",
  • "groupByFields": [
    ],
  • "sourceView": "string",
  • "sourceViewExtractor": "string",
  • "sources": [ ],
  • "requiredPermissions": [ ],
  • "filterConditions": [ ],
  • "additionalEcsConditions": [ ],
  • "deleted": false,
  • "usedBy": [ ],
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "shared": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "isCustom": true
}

deleteCustomEntityType

path Parameters
entityTypeId
required
string <uuid> (UUID)

UUID of the entity type

Responses

getAvailableJoins

Get available entity types and fields for joining with a custom entity type

Request Body schema: application/json
optional

Custom entity type definition

object (Custom Entity Type Schema)

A definition of a custom entity types that can be used in the Query Tool

id
required
string

A UUID identifying entity type

name
required
string

The unique name of entity type like User, Loan, Item, etc.

description
string

A description of the entity type

labelAlias
string

The identifier used for a localized label/name for this entity.

private
required
boolean

This flag denotes whether the entity type is private or not. Private entity types cannot be accessed by users for querying.

customFieldEntityTypeId
string

The IDs of the custom field entity type

Array of objects (Entity Type Column Schema)
Default: []
crossTenantQueriesEnabled
boolean
Default: false

Indicates if this entity type supports cross-tenant queries

Array of objects (Default sort criteria for an entity type)
fromClause
string
Deprecated

FROM clause containing all src views that need to be joined to query this entity type

idView
string

View from which the content IDs for this entity type are extracted

groupByFields
Array of strings

Ordered list of fields used in the GROUP BY clause for this entity type

sourceView
string

View from which the dynamic columns for this entity type are extracted

sourceViewExtractor
string

Getting the base source of the custom field

Array of objects (Entity Type Source)
Default: []
requiredPermissions
Array of strings
Default: []

List of permissions required to query this entity type

filterConditions
Array of strings
Default: []

Filter conditions to be included in the WHERE clause of this entity type

additionalEcsConditions
Array of strings
Default: []

Additional conditions to be included in the WHERE clause of this entity type in ECS environments

deleted
boolean
Default: false

Indicates if this entity type is deleted

usedBy
Array of strings
Default: []

List of modules that use this entity type

owner
string <uuid>

A UUID identifying entity type owner

shared
boolean
Default: false

Denotes if the entity type is shared (true) or private (false)

createdAt
string <date-time>

The creation timestamp of the entity type

updatedAt
string <date-time>

The update timestamp of the entity type

isCustom
boolean
Default: true

Discriminator field to distinguish custom entity types from system entity types

Value: true
property name*
additional property
any
sourceField
string

Name of the field from the custom entity type

targetId
string <uuid> (UUID)

The content row represented as a map.

targetField
string

Name of the field from the target entity type

Responses

Request samples

Content type
application/json
{
  • "customEntityType": {
    },
  • "sourceField": "string",
  • "targetId": "cbca1126-180e-4334-9df8-cf82289d378b",
  • "targetField": "string"
}

Response samples

Content type
application/json
{
  • "availableSourceFields": [
    ],
  • "availableTargetIds": [
    ],
  • "availableTargetFields": [
    ]
}

custom

createCustomEntityType

Create a custom entity type

Request Body schema: application/json
required

Custom entity type definition

id
required
string

A UUID identifying entity type

name
required
string

The unique name of entity type like User, Loan, Item, etc.

description
string

A description of the entity type

labelAlias
string

The identifier used for a localized label/name for this entity.

private
required
boolean

This flag denotes whether the entity type is private or not. Private entity types cannot be accessed by users for querying.

customFieldEntityTypeId
string

The IDs of the custom field entity type

Array of objects (Entity Type Column Schema)
Default: []
Array
name
required
string

The name of this field.

required
object (EntityDataType)
labelAlias
string

A pre-localized identifier used to label/name this column.

queryable
boolean

Indicates whether this column can be used in a query.

queryOnly
boolean

Indicates whether this column can be used for querying only. If true, the column can be used in a query but cannot be included in results.

object (Source of an entity type column)

Source of an entity type column, from where the values for the column can be derived

object (Value source API config)

Configuration for a column's value source API, where the available values can be accessed

valueGetter
string

Configuration defining how to fetch values of this column from the underlying datasource.

filterValueGetter
string

Configuration defining how to filter values of this column from the underlying datasource when indexed values aren't very user-friendly.

idColumnName
string

Name of the corresponding ID column, if this column contains the value of an ID.

valueFunction
string

Configuration defining how to transform a static value for comparison with values produced by the filterValueGetter. This is useful when the filterValueGetter does extra processing that is not visible to the user. The static value can be referenced with ':value'

hidden
boolean
Default: false

Indicates if the field is hidden in UI

Array of objects (Column value with label Schema)

Array of values for this column

ecsOnly
boolean

Indicates if the field is available only in ECS environments

visibleByDefault
boolean

Indicates if the column should be shown by default when the entity is viewed.

isCustomField
boolean

Indicates if the column belongs to the custom field.

isIdColumn
boolean

Indicates if the column is part of the unique identifier for this entity type

sourceAlias
string

Source alias for this column

essential
boolean

Indicates if a column is crucial to the definition of an entity type

Array of objects (Definition of a possible field join)
Default: []

A set of columns which this column may be joined to

originalEntityTypeId
string <uuid>

[Internal only, not for definitions] The simplest entity type that this column is derived from

crossTenantQueriesEnabled
boolean
Default: false

Indicates if this entity type supports cross-tenant queries

Array of objects (Default sort criteria for an entity type)
Array
columnName
required
string

Name of the column using which entity type has to be sorted

direction
required
string
Enum: "ASC" "DESC"

Direction of the sort (Ascending or Descending)

fromClause
string
Deprecated

FROM clause containing all src views that need to be joined to query this entity type

idView
string

View from which the content IDs for this entity type are extracted

groupByFields
Array of strings

Ordered list of fields used in the GROUP BY clause for this entity type

sourceView
string

View from which the dynamic columns for this entity type are extracted

sourceViewExtractor
string

Getting the base source of the custom field

Array of objects (Entity Type Source)
Default: []
Array
type
required
string

Type of source. Valid values are db, entity-type

alias
required
string

Alias of this source to be used in query/later joins

name
string

Name of this source. If set, this will override any source name translations

joinedViaEntityType
string

[Internal use only, should not be included in definitions] The owning entity's alias, if this source's joining is handled by a parent entity in a cross-entity join

order
integer
Default: 1073741823

Order of the inherited fields from this source, relative to the fields from other sources. Defaults to 1073741823 (INT_MAX/2)

target
string

Target view/table from which values are extracted

object (Entity Type DB Source Join)

[Deprecated for use in definitions; you should likely create simple wrapper entity types and join those] Object describing how this DB view/table should be joined to another

requiredPermissions
Array of strings
Default: []

List of permissions required to query this entity type

filterConditions
Array of strings
Default: []

Filter conditions to be included in the WHERE clause of this entity type

additionalEcsConditions
Array of strings
Default: []

Additional conditions to be included in the WHERE clause of this entity type in ECS environments

deleted
boolean
Default: false

Indicates if this entity type is deleted

usedBy
Array of strings
Default: []

List of modules that use this entity type

owner
string <uuid>

A UUID identifying entity type owner

shared
boolean
Default: false

Denotes if the entity type is shared (true) or private (false)

createdAt
string <date-time>

The creation timestamp of the entity type

updatedAt
string <date-time>

The update timestamp of the entity type

isCustom
boolean
Default: true

Discriminator field to distinguish custom entity types from system entity types

Value: true
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "labelAlias": "string",
  • "private": true,
  • "customFieldEntityTypeId": "string",
  • "columns": [ ],
  • "crossTenantQueriesEnabled": false,
  • "defaultSort": [
    ],
  • "fromClause": "string",
  • "idView": "string",
  • "groupByFields": [
    ],
  • "sourceView": "string",
  • "sourceViewExtractor": "string",
  • "sources": [ ],
  • "requiredPermissions": [ ],
  • "filterConditions": [ ],
  • "additionalEcsConditions": [ ],
  • "deleted": false,
  • "usedBy": [ ],
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "shared": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "isCustom": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "labelAlias": "string",
  • "private": true,
  • "customFieldEntityTypeId": "string",
  • "columns": [ ],
  • "crossTenantQueriesEnabled": false,
  • "defaultSort": [
    ],
  • "fromClause": "string",
  • "idView": "string",
  • "groupByFields": [
    ],
  • "sourceView": "string",
  • "sourceViewExtractor": "string",
  • "sources": [ ],
  • "requiredPermissions": [ ],
  • "filterConditions": [ ],
  • "additionalEcsConditions": [ ],
  • "deleted": false,
  • "usedBy": [ ],
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "shared": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "isCustom": true
}

getCustomEntityType

path Parameters
entityTypeId
required
string <uuid> (UUID)

UUID of the entity type

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "labelAlias": "string",
  • "private": true,
  • "customFieldEntityTypeId": "string",
  • "columns": [ ],
  • "crossTenantQueriesEnabled": false,
  • "defaultSort": [
    ],
  • "fromClause": "string",
  • "idView": "string",
  • "groupByFields": [
    ],
  • "sourceView": "string",
  • "sourceViewExtractor": "string",
  • "sources": [ ],
  • "requiredPermissions": [ ],
  • "filterConditions": [ ],
  • "additionalEcsConditions": [ ],
  • "deleted": false,
  • "usedBy": [ ],
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "shared": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "isCustom": true
}

updateCustomEntityType

path Parameters
entityTypeId
required
string <uuid> (UUID)

UUID of the entity type

Request Body schema: application/json
required

Custom entity type definition

id
required
string

A UUID identifying entity type

name
required
string

The unique name of entity type like User, Loan, Item, etc.

description
string

A description of the entity type

labelAlias
string

The identifier used for a localized label/name for this entity.

private
required
boolean

This flag denotes whether the entity type is private or not. Private entity types cannot be accessed by users for querying.

customFieldEntityTypeId
string

The IDs of the custom field entity type

Array of objects (Entity Type Column Schema)
Default: []
Array
name
required
string

The name of this field.

required
object (EntityDataType)
labelAlias
string

A pre-localized identifier used to label/name this column.

queryable
boolean

Indicates whether this column can be used in a query.

queryOnly
boolean

Indicates whether this column can be used for querying only. If true, the column can be used in a query but cannot be included in results.

object (Source of an entity type column)

Source of an entity type column, from where the values for the column can be derived

object (Value source API config)

Configuration for a column's value source API, where the available values can be accessed

valueGetter
string

Configuration defining how to fetch values of this column from the underlying datasource.

filterValueGetter
string

Configuration defining how to filter values of this column from the underlying datasource when indexed values aren't very user-friendly.

idColumnName
string

Name of the corresponding ID column, if this column contains the value of an ID.

valueFunction
string

Configuration defining how to transform a static value for comparison with values produced by the filterValueGetter. This is useful when the filterValueGetter does extra processing that is not visible to the user. The static value can be referenced with ':value'

hidden
boolean
Default: false

Indicates if the field is hidden in UI

Array of objects (Column value with label Schema)

Array of values for this column

ecsOnly
boolean

Indicates if the field is available only in ECS environments

visibleByDefault
boolean

Indicates if the column should be shown by default when the entity is viewed.

isCustomField
boolean

Indicates if the column belongs to the custom field.

isIdColumn
boolean

Indicates if the column is part of the unique identifier for this entity type

sourceAlias
string

Source alias for this column

essential
boolean

Indicates if a column is crucial to the definition of an entity type

Array of objects (Definition of a possible field join)
Default: []

A set of columns which this column may be joined to

originalEntityTypeId
string <uuid>

[Internal only, not for definitions] The simplest entity type that this column is derived from

crossTenantQueriesEnabled
boolean
Default: false

Indicates if this entity type supports cross-tenant queries

Array of objects (Default sort criteria for an entity type)
Array
columnName
required
string

Name of the column using which entity type has to be sorted

direction
required
string
Enum: "ASC" "DESC"

Direction of the sort (Ascending or Descending)

fromClause
string
Deprecated

FROM clause containing all src views that need to be joined to query this entity type

idView
string

View from which the content IDs for this entity type are extracted

groupByFields
Array of strings

Ordered list of fields used in the GROUP BY clause for this entity type

sourceView
string

View from which the dynamic columns for this entity type are extracted

sourceViewExtractor
string

Getting the base source of the custom field

Array of objects (Entity Type Source)
Default: []
Array
type
required
string

Type of source. Valid values are db, entity-type

alias
required
string

Alias of this source to be used in query/later joins

name
string

Name of this source. If set, this will override any source name translations

joinedViaEntityType
string

[Internal use only, should not be included in definitions] The owning entity's alias, if this source's joining is handled by a parent entity in a cross-entity join

order
integer
Default: 1073741823

Order of the inherited fields from this source, relative to the fields from other sources. Defaults to 1073741823 (INT_MAX/2)

target
string

Target view/table from which values are extracted

object (Entity Type DB Source Join)

[Deprecated for use in definitions; you should likely create simple wrapper entity types and join those] Object describing how this DB view/table should be joined to another

requiredPermissions
Array of strings
Default: []

List of permissions required to query this entity type

filterConditions
Array of strings
Default: []

Filter conditions to be included in the WHERE clause of this entity type

additionalEcsConditions
Array of strings
Default: []

Additional conditions to be included in the WHERE clause of this entity type in ECS environments

deleted
boolean
Default: false

Indicates if this entity type is deleted

usedBy
Array of strings
Default: []

List of modules that use this entity type

owner
string <uuid>

A UUID identifying entity type owner

shared
boolean
Default: false

Denotes if the entity type is shared (true) or private (false)

createdAt
string <date-time>

The creation timestamp of the entity type

updatedAt
string <date-time>

The update timestamp of the entity type

isCustom
boolean
Default: true

Discriminator field to distinguish custom entity types from system entity types

Value: true
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "labelAlias": "string",
  • "private": true,
  • "customFieldEntityTypeId": "string",
  • "columns": [ ],
  • "crossTenantQueriesEnabled": false,
  • "defaultSort": [
    ],
  • "fromClause": "string",
  • "idView": "string",
  • "groupByFields": [
    ],
  • "sourceView": "string",
  • "sourceViewExtractor": "string",
  • "sources": [ ],
  • "requiredPermissions": [ ],
  • "filterConditions": [ ],
  • "additionalEcsConditions": [ ],
  • "deleted": false,
  • "usedBy": [ ],
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "shared": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "isCustom": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "labelAlias": "string",
  • "private": true,
  • "customFieldEntityTypeId": "string",
  • "columns": [ ],
  • "crossTenantQueriesEnabled": false,
  • "defaultSort": [
    ],
  • "fromClause": "string",
  • "idView": "string",
  • "groupByFields": [
    ],
  • "sourceView": "string",
  • "sourceViewExtractor": "string",
  • "sources": [ ],
  • "requiredPermissions": [ ],
  • "filterConditions": [ ],
  • "additionalEcsConditions": [ ],
  • "deleted": false,
  • "usedBy": [ ],
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "shared": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "isCustom": true
}

deleteCustomEntityType

path Parameters
entityTypeId
required
string <uuid> (UUID)

UUID of the entity type

Responses

getAvailableJoins

Get available entity types and fields for joining with a custom entity type

Request Body schema: application/json
optional

Custom entity type definition

object (Custom Entity Type Schema)

A definition of a custom entity types that can be used in the Query Tool

id
required
string

A UUID identifying entity type

name
required
string

The unique name of entity type like User, Loan, Item, etc.

description
string

A description of the entity type

labelAlias
string

The identifier used for a localized label/name for this entity.

private
required
boolean

This flag denotes whether the entity type is private or not. Private entity types cannot be accessed by users for querying.

customFieldEntityTypeId
string

The IDs of the custom field entity type

Array of objects (Entity Type Column Schema)
Default: []
crossTenantQueriesEnabled
boolean
Default: false

Indicates if this entity type supports cross-tenant queries

Array of objects (Default sort criteria for an entity type)
fromClause
string
Deprecated

FROM clause containing all src views that need to be joined to query this entity type

idView
string

View from which the content IDs for this entity type are extracted

groupByFields
Array of strings

Ordered list of fields used in the GROUP BY clause for this entity type

sourceView
string

View from which the dynamic columns for this entity type are extracted

sourceViewExtractor
string

Getting the base source of the custom field

Array of objects (Entity Type Source)
Default: []
requiredPermissions
Array of strings
Default: []

List of permissions required to query this entity type

filterConditions
Array of strings
Default: []

Filter conditions to be included in the WHERE clause of this entity type

additionalEcsConditions
Array of strings
Default: []

Additional conditions to be included in the WHERE clause of this entity type in ECS environments

deleted
boolean
Default: false

Indicates if this entity type is deleted

usedBy
Array of strings
Default: []

List of modules that use this entity type

owner
string <uuid>

A UUID identifying entity type owner

shared
boolean
Default: false

Denotes if the entity type is shared (true) or private (false)

createdAt
string <date-time>

The creation timestamp of the entity type

updatedAt
string <date-time>

The update timestamp of the entity type

isCustom
boolean
Default: true

Discriminator field to distinguish custom entity types from system entity types

Value: true
property name*
additional property
any
sourceField
string

Name of the field from the custom entity type

targetId
string <uuid> (UUID)

The content row represented as a map.

targetField
string

Name of the field from the target entity type

Responses

Request samples

Content type
application/json
{
  • "customEntityType": {
    },
  • "sourceField": "string",
  • "targetId": "cbca1126-180e-4334-9df8-cf82289d378b",
  • "targetField": "string"
}

Response samples

Content type
application/json
{
  • "availableSourceFields": [
    ],
  • "availableTargetIds": [
    ],
  • "availableTargetFields": [
    ]
}

fqlQuery

runFqlQuery

Runs an FQL query

query Parameters
query
required
string

A complete query expressed as a FQL string. It should contain the from part that defines the entity type and the where/criteria part.

entityTypeId
required
string <uuid> (UUID)

UUID of the entity type

fields
Array of strings

fields to include in the query results

afterId
Array of strings
Deprecated

ID of the last element from the previous query

limit
integer [ 1 .. 2147483647 ]
Default: 100

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "totalRecords": 1
}

runFqlQueryAsync

Runs an FQL query asynchronously

Request Body schema: application/json
required

Query request

fqlQuery
required
string
entityTypeId
required
string <uuid> (UUID)

The content row represented as a map.

fields
Array of strings

Fields to be included in query results

sortResults
boolean

Whether to sort results based on entity type's sort criteria

maxSize
integer

Maximum number of results to retrieve for the query

Responses

Request samples

Content type
application/json
{
  • "fqlQuery": "string",
  • "entityTypeId": "29842682-4fc1-4a12-b775-fa06e71c91e2",
  • "fields": [
    ],
  • "sortResults": true,
  • "maxSize": 0
}

Response samples

Content type
application/json
{
  • "queryId": "37140576-be84-1a0e-7546-0912d8320019"
}

getQuery

Get details of a submitted query, optionally including the results

path Parameters
queryId
required
string <uuid> (UUID)

UUID of the query

query Parameters
includeResults
boolean

Indicates if query results should be included in the query details response

offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 1 .. 2147483647 ]
Default: 100

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "entityTypeId": "0cb79a4c-f7eb-4941-a104-745224ae0292",
  • "fqlQuery": "user_active == true",
  • "queryId": "37140576-be84-1a0e-7546-0912d8320019",
  • "startDate": "2023-04-04T21:56:08.673+00:00",
  • "status": "IN_PROGRESS"
}

deleteQuery

Delete a query and its results

path Parameters
queryId
required
string <uuid> (UUID)

UUID of the query

Responses

getSortedIds

Get ids of query results in sorted order

path Parameters
queryId
required
string <uuid> (UUID)

UUID of the query

query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 1 .. 2147483647 ]
Default: 100

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

getContents

get contents for list of ids

Request Body schema: application/json
required

Contents request

entityTypeId
required
string <uuid> (UUID)

The content row represented as a map.

fields
required
Array of strings

Fields to be included in results

ids
required
Array of strings[ items ]

Ids to retrieve results for

localize
boolean
Default: false

Whether to localize dates in content response

userId
string <uuid> (UUID)

The content row represented as a map.

Responses

Request samples

Content type
application/json
{
  • "entityTypeId": "29842682-4fc1-4a12-b775-fa06e71c91e2",
  • "fields": [
    ],
  • "ids": [
    ],
  • "localize": false,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
[
  • {
    }
]

getContentsPrivileged

get contents for list of ids using a specified user proxy

Request Body schema: application/json
required

Contents request

entityTypeId
required
string <uuid> (UUID)

The content row represented as a map.

fields
required
Array of strings

Fields to be included in results

ids
required
Array of strings[ items ]

Ids to retrieve results for

localize
boolean
Default: false

Whether to localize dates in content response

userId
string <uuid> (UUID)

The content row represented as a map.

Responses

Request samples

Content type
application/json
{
  • "entityTypeId": "29842682-4fc1-4a12-b775-fa06e71c91e2",
  • "fields": [
    ],
  • "ids": [
    ],
  • "localize": false,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
[
  • {
    }
]