OpenAPI definition

Other

Endpoint:/

Convert a geo file to GeoParquet format

POST

/api/v1/actions/customGeoCollection/convert

Converts a geo file from the staging area to GeoParquet format. Supported source formats: GeoJSON (.geojson, .json), ESRI Shapefile (.zip). If the source file is already in GeoParquet format, the same location is returned without conversion.

Convert a geo file to GeoParquet format › Request Body

locationstring · required
Location of the file in the staging area to convert.

Convert a geo file to GeoParquet format › Responses

Conversion was successful.

locationstring · required
Location of the converted GeoParquet file in the staging area.

Upload a geo collection file to the staging area

POST

/api/v1/actions/customGeoCollection/staging/upload

Provides a location for uploading staging files for custom geo collections. Supported file types: GeoParquet (.parquet), GeoJSON (.geojson, .json), ESRI Shapefile (.zip). Maximum file size: 100 MB.

Upload a geo collection file to the staging area › Request Body

filestring · required

Upload a geo collection file to the staging area › Responses

Upload was successful.

locationstring · required
Location to use when referencing the uploaded file in subsequent requests.

Import custom geo collection

POST

/api/v1/actions/customGeoCollection/{collectionId}/import

Import a geo collection file from the staging area to be available for use. The file must be in GeoParquet format (use the convert endpoint first for other formats). Validates file size (max 100 MB), organization storage quota (max 1 GB total), and GeoParquet schema (requires id, geometry, and bbox columns).

Import custom geo collection › path Parameters

collectionIdstring · required

Import custom geo collection › Request Body

locationstring · required
Location of the file in the staging area.

Import custom geo collection › Responses

Successful import.

versioninteger · int32 · required
The version of the imported geo collection.

(BETA) Sync organization scope Metadata to other services

POST

/api/v1/actions/organization/metadataSync

(BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only.

(BETA) Sync organization scope Metadata to other services › Responses

No data returned

(BETA) Sync Metadata to other services

POST

/api/v1/actions/workspaces/{workspaceId}/metadataSync

(BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only.

(BETA) Sync Metadata to other services › path Parameters

workspaceIdstring · required

(BETA) Sync Metadata to other services › Responses

No data returned

Set Certification

POST

/api/v1/actions/workspaces/{workspaceId}/setCertification

Set or clear the certification (e.g. CERTIFIED) of a workspace entity. Requires MANAGE permission.

Set Certification › path Parameters

workspaceIdstring · required

Set Certification › Request Body

idstring · required
ID of the entity.
Example: total-sales
typestring · enum · required
Type of the entity.
Enum values:
metric
visualizationObject
analyticalDashboard

messagestring | null
Optional message associated with the certification.
statusstring | null · enum
Certification status of the entity.
Enum values:
CERTIFIED

Set Certification › Responses

No Content

No data returned

Get Skills

GET

/api/v1/ai/agent/skills

Get Skills › Responses

Successful Response

descriptionstring · required
examplesstring[] · required
namestring · required
tagsstring[] · required
titlestring · required

Get Conversations

GET

/api/v1/ai/workspaces/{workspace_id}/chat/conversations

Get Conversations › path Parameters

workspace_idstring · required

Get Conversations › Responses

Successful Response

conversationIdstring · required
Conversation identifier.
createdAtstring · required
Conversation creation timestamp (ISO-8601 UTC).
lastActivityAtstring · required
Last activity timestamp (ISO-8601 UTC).
organizationIdstring · required
Organization identifier.
userIdstring · required
Owner user identifier.
workspaceIdstring · required
Workspace identifier.

Post Conversations

POST

/api/v1/ai/workspaces/{workspace_id}/chat/conversations

Post Conversations › path Parameters

workspace_idstring · required

Post Conversations › Responses

Successful Response

conversationIdstring · required
Conversation identifier.
createdAtstring · required
Conversation creation timestamp (ISO-8601 UTC).
lastActivityAtstring · required
Last activity timestamp (ISO-8601 UTC).
organizationIdstring · required
Organization identifier.
userIdstring · required
Owner user identifier.
workspaceIdstring · required
Workspace identifier.

Get Conversation

GET

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}

Get Conversation › path Parameters

workspace_idstring · required
conversation_idstring · required

Get Conversation › Responses

Successful Response

conversationIdstring · required
Conversation identifier.
createdAtstring · required
Conversation creation timestamp (ISO-8601 UTC).
lastActivityAtstring · required
Last activity timestamp (ISO-8601 UTC).
organizationIdstring · required
Organization identifier.
userIdstring · required
Owner user identifier.
workspaceIdstring · required
Workspace identifier.

Delete Conversation

DELETE

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}

Delete Conversation › path Parameters

workspace_idstring · required
conversation_idstring · required

Delete Conversation › Responses

Successful Response

No data returned

Get Conversation Items

GET

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/items

Get Conversation Items › path Parameters

workspace_idstring · required
conversation_idstring · required

Get Conversation Items › Responses

Successful Response

itemsobject[] · required
Ordered list of conversation items.

Post Messages

POST

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/messages

Post Messages › path Parameters

workspace_idstring · required
conversation_idstring · required

Post Messages › Request Body

itemobject · required

options

Post Messages › Responses

SSE stream with response_started/item/response_ended events

No data returned

Get Conversation Responses

GET

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/responses

Get Conversation Responses › path Parameters

workspace_idstring · required
conversation_idstring · required

Get Conversation Responses › Responses

Successful Response

responsesobject[] · required
Conversation responses.

Patch Response

PATCH

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/responses/{response_id}

Patch Response › path Parameters

workspace_idstring · required
conversation_idstring · required
response_idstring · required

Patch Response › Request Body

feedbackrequired

Patch Response › Responses

Successful Response

No data returned

Patch Visualization

PATCH

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/visualizations/{visualization_id}

Patch Visualization › path Parameters

workspace_idstring · required
conversation_idstring · required
visualization_idstring · required

Patch Visualization › Request Body

idstring · minLength: 1 · required

Patch Visualization › Responses

Successful Response

No data returned

Get all Custom Geo Collections

GET

/api/v1/entities/customGeoCollections

Get all Custom Geo Collections › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
pageinteger
Zero-based page index (0..N)
Default: 0
sizeinteger
The size of the page to be returned
Default: 20
sortstring[]
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
metaIncludestring[] · unique · style: form
Include Meta objects.
Included meta objects
Enum values:
page
all
ALL

Get all Custom Geo Collections › Responses

Request successfully processed

dataobject[] · unique · required

linksobject
metaobject

Post Custom Geo Collections

POST

/api/v1/entities/customGeoCollections

Post Custom Geo Collections › Request Body

dataobject · required
JSON:API representation of customGeoCollection entity.

Post Custom Geo Collections › Responses

Request successfully processed

dataobject · required
JSON:API representation of customGeoCollection entity.

linksobject

Get Custom Geo Collection

GET

/api/v1/entities/customGeoCollections/{id}

Get Custom Geo Collection › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Get Custom Geo Collection › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Get Custom Geo Collection › Responses

Request successfully processed

dataobject · required
JSON:API representation of customGeoCollection entity.

linksobject

Put Custom Geo Collection

PUT

/api/v1/entities/customGeoCollections/{id}

Put Custom Geo Collection › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Put Custom Geo Collection › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Put Custom Geo Collection › Request Body

dataobject · required
JSON:API representation of customGeoCollection entity.

Put Custom Geo Collection › Responses

Request successfully processed

dataobject · required
JSON:API representation of customGeoCollection entity.

linksobject

Delete Custom Geo Collection

DELETE

/api/v1/entities/customGeoCollections/{id}

Delete Custom Geo Collection › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Delete Custom Geo Collection › Responses

Successfully deleted

No data returned

Patch Custom Geo Collection

PATCH

/api/v1/entities/customGeoCollections/{id}

Patch Custom Geo Collection › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Patch Custom Geo Collection › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Patch Custom Geo Collection › Request Body

dataobject · required
JSON:API representation of patching customGeoCollection entity.

Patch Custom Geo Collection › Responses

Request successfully processed

dataobject · required
JSON:API representation of customGeoCollection entity.

linksobject

Get all LLM Provider entities

GET

/api/v1/entities/llmProviders

Get all LLM Provider entities › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
pageinteger
Zero-based page index (0..N)
Default: 0
sizeinteger
The size of the page to be returned
Default: 20
sortstring[]
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
metaIncludestring[] · unique · style: form
Include Meta objects.
Included meta objects
Enum values:
page
all
ALL

Get all LLM Provider entities › Responses

Request successfully processed

dataobject[] · unique · required

linksobject
metaobject

Post LLM Provider entities

POST

/api/v1/entities/llmProviders

LLM Provider - connection configuration for LLM services

Post LLM Provider entities › Request Body

dataobject · required
LLM Provider configuration for connecting to LLM services.

Post LLM Provider entities › Responses

Request successfully processed

dataobject · required
LLM Provider configuration for connecting to LLM services.

linksobject

Get LLM Provider entity

GET

/api/v1/entities/llmProviders/{id}

Get LLM Provider entity › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Get LLM Provider entity › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Get LLM Provider entity › Responses

Request successfully processed

dataobject · required
LLM Provider configuration for connecting to LLM services.

linksobject

PUT LLM Provider entity

PUT

/api/v1/entities/llmProviders/{id}

PUT LLM Provider entity › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

PUT LLM Provider entity › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

PUT LLM Provider entity › Request Body

dataobject · required
LLM Provider configuration for connecting to LLM services.

PUT LLM Provider entity › Responses

Request successfully processed

dataobject · required
LLM Provider configuration for connecting to LLM services.

linksobject

Delete LLM Provider entity

DELETE

/api/v1/entities/llmProviders/{id}

Delete LLM Provider entity › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Delete LLM Provider entity › Responses

Successfully deleted

No data returned

Patch LLM Provider entity

PATCH

/api/v1/entities/llmProviders/{id}

Patch LLM Provider entity › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Patch LLM Provider entity › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Patch LLM Provider entity › Request Body

dataobject · required
LLM Provider configuration for connecting to LLM services.

Patch LLM Provider entity › Responses

Request successfully processed

dataobject · required
LLM Provider configuration for connecting to LLM services.

linksobject

Get all Knowledge Recommendations

GET

/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations

Get all Knowledge Recommendations › path Parameters

workspaceIdstring · required

Get all Knowledge Recommendations › query Parameters

originstring · enum
Defines scope of origin of objects. All by default.
Enum values:
ALL
PARENTS
NATIVE
Default: ALL
filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
metrics
analyticalDashboards
metric
analyticalDashboard
ALL
pageinteger
Zero-based page index (0..N)
Default: 0
sizeinteger
The size of the page to be returned
Default: 20
sortstring[]
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
metaIncludestring[] · unique · style: form
Include Meta objects.
Included meta objects
Enum values:
origin
page
all
ALL

Get all Knowledge Recommendations › Headers

X-GDC-VALIDATE-RELATIONSboolean
Default: false

Get all Knowledge Recommendations › Responses

Request successfully processed

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

Post Knowledge Recommendations

POST

/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations

Post Knowledge Recommendations › path Parameters

workspaceIdstring · required

Post Knowledge Recommendations › query Parameters

includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
metrics
analyticalDashboards
metric
analyticalDashboard
ALL
metaIncludestring[] · unique · style: form
Include Meta objects.
Included meta objects
Enum values:
origin
all
ALL

Post Knowledge Recommendations › Request Body

dataobject · required
JSON:API representation of knowledgeRecommendation entity.

Post Knowledge Recommendations › Responses

Request successfully processed

dataobject · required
JSON:API representation of knowledgeRecommendation entity.

includedarray · unique
Included resources
linksobject

The search endpoint (beta)

POST

/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search

The search endpoint (beta) › path Parameters

workspaceIdstring · required

The search endpoint (beta) › query Parameters

originstring · enum
Defines scope of origin of objects. All by default.
Enum values:
ALL
PARENTS
NATIVE
Default: ALL

The search endpoint (beta) › Headers

X-GDC-VALIDATE-RELATIONSboolean
Default: false

The search endpoint (beta) › Request Body

filterstring | null
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includearray | null
List of related entities to include in the response
metaIncludearray | null · unique
Set of metadata fields to include in the response
pageobject
Pagination information for entity search
sortarray | null
Sorting criteria (can specify multiple sort orders)

The search endpoint (beta) › Responses

Request successfully processed

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

Get a Knowledge Recommendation

GET

/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}

Get a Knowledge Recommendation › path Parameters

workspaceIdstring · required
objectIdstring · required

Get a Knowledge Recommendation › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
metrics
analyticalDashboards
metric
analyticalDashboard
ALL
metaIncludestring[] · unique · style: form
Include Meta objects.
Included meta objects
Enum values:
origin
all
ALL

Get a Knowledge Recommendation › Headers

X-GDC-VALIDATE-RELATIONSboolean
Default: false

Get a Knowledge Recommendation › Responses

Request successfully processed

dataobject · required
JSON:API representation of knowledgeRecommendation entity.

includedarray · unique
Included resources
linksobject

Put a Knowledge Recommendation

PUT

/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}

Put a Knowledge Recommendation › path Parameters

workspaceIdstring · required
objectIdstring · required

Put a Knowledge Recommendation › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
metrics
analyticalDashboards
metric
analyticalDashboard
ALL

Put a Knowledge Recommendation › Request Body

dataobject · required
JSON:API representation of knowledgeRecommendation entity.

Put a Knowledge Recommendation › Responses

Request successfully processed

dataobject · required
JSON:API representation of knowledgeRecommendation entity.

includedarray · unique
Included resources
linksobject

Delete a Knowledge Recommendation

DELETE

/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}

Delete a Knowledge Recommendation › path Parameters

workspaceIdstring · required
objectIdstring · required

Delete a Knowledge Recommendation › Responses

Successfully deleted

No data returned

Patch a Knowledge Recommendation

PATCH

/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}

Patch a Knowledge Recommendation › path Parameters

workspaceIdstring · required
objectIdstring · required

Patch a Knowledge Recommendation › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
metrics
analyticalDashboards
metric
analyticalDashboard
ALL

Patch a Knowledge Recommendation › Request Body

dataobject · required
JSON:API representation of patching knowledgeRecommendation entity.

Patch a Knowledge Recommendation › Responses

Request successfully processed

dataobject · required
JSON:API representation of knowledgeRecommendation entity.

includedarray · unique
Included resources
linksobject

Get all Memory Items

GET

/api/v1/entities/workspaces/{workspaceId}/memoryItems

Get all Memory Items › path Parameters

workspaceIdstring · required

Get all Memory Items › query Parameters

originstring · enum
Defines scope of origin of objects. All by default.
Enum values:
ALL
PARENTS
NATIVE
Default: ALL
filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
createdBy
modifiedBy
ALL
pageinteger
Zero-based page index (0..N)
Default: 0
sizeinteger
The size of the page to be returned
Default: 20
sortstring[]
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
metaIncludestring[] · unique · style: form
Include Meta objects.
Included meta objects
Enum values:
origin
page
all
ALL

Get all Memory Items › Headers

X-GDC-VALIDATE-RELATIONSboolean
Default: false

Get all Memory Items › Responses

Request successfully processed

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

Post Memory Items

POST

/api/v1/entities/workspaces/{workspaceId}/memoryItems

Post Memory Items › path Parameters

workspaceIdstring · required

Post Memory Items › query Parameters

includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
createdBy
modifiedBy
ALL
metaIncludestring[] · unique · style: form
Include Meta objects.
Included meta objects
Enum values:
origin
all
ALL

Post Memory Items › Request Body

dataobject · required
JSON:API representation of memoryItem entity.

Post Memory Items › Responses

Request successfully processed

dataobject · required
JSON:API representation of memoryItem entity.

includedobject[] · unique
Included resources
linksobject

The search endpoint (beta)

POST

/api/v1/entities/workspaces/{workspaceId}/memoryItems/search

The search endpoint (beta) › path Parameters

workspaceIdstring · required

The search endpoint (beta) › query Parameters

originstring · enum
Defines scope of origin of objects. All by default.
Enum values:
ALL
PARENTS
NATIVE
Default: ALL

The search endpoint (beta) › Headers

X-GDC-VALIDATE-RELATIONSboolean
Default: false

The search endpoint (beta) › Request Body

filterstring | null
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includearray | null
List of related entities to include in the response
metaIncludearray | null · unique
Set of metadata fields to include in the response
pageobject
Pagination information for entity search
sortarray | null
Sorting criteria (can specify multiple sort orders)

The search endpoint (beta) › Responses

Request successfully processed

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

Get a Memory Item

GET

/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}

Get a Memory Item › path Parameters

workspaceIdstring · required
objectIdstring · required

Get a Memory Item › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
createdBy
modifiedBy
ALL
metaIncludestring[] · unique · style: form
Include Meta objects.
Included meta objects
Enum values:
origin
all
ALL

Get a Memory Item › Headers

X-GDC-VALIDATE-RELATIONSboolean
Default: false

Get a Memory Item › Responses

Request successfully processed

dataobject · required
JSON:API representation of memoryItem entity.

includedobject[] · unique
Included resources
linksobject

Put a Memory Item

PUT

/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}

Put a Memory Item › path Parameters

workspaceIdstring · required
objectIdstring · required

Put a Memory Item › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
createdBy
modifiedBy
ALL

Put a Memory Item › Request Body

dataobject · required
JSON:API representation of memoryItem entity.

Put a Memory Item › Responses

Request successfully processed

dataobject · required
JSON:API representation of memoryItem entity.

includedobject[] · unique
Included resources
linksobject

Delete a Memory Item

DELETE

/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}

Delete a Memory Item › path Parameters

workspaceIdstring · required
objectIdstring · required

Delete a Memory Item › Responses

Successfully deleted

No data returned

Patch a Memory Item

PATCH

/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}

Patch a Memory Item › path Parameters

workspaceIdstring · required
objectIdstring · required

Patch a Memory Item › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
createdBy
modifiedBy
ALL

Patch a Memory Item › Request Body

dataobject · required
JSON:API representation of patching memoryItem entity.

Patch a Memory Item › Responses

Request successfully processed

dataobject · required
JSON:API representation of memoryItem entity.

includedobject[] · unique
Included resources
linksobject

Get all Parameters

GET

/api/v1/entities/workspaces/{workspaceId}/parameters

Get all Parameters › path Parameters

workspaceIdstring · required

Get all Parameters › query Parameters

originstring · enum
Defines scope of origin of objects. All by default.
Enum values:
ALL
PARENTS
NATIVE
Default: ALL
filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
createdBy
modifiedBy
ALL
pageinteger
Zero-based page index (0..N)
Default: 0
sizeinteger
The size of the page to be returned
Default: 20
sortstring[]
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
metaIncludestring[] · unique · style: form
Include Meta objects.
Included meta objects
Enum values:
origin
page
all
ALL

Get all Parameters › Headers

X-GDC-VALIDATE-RELATIONSboolean
Default: false

Get all Parameters › Responses

Request successfully processed

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

Post Parameters

POST

/api/v1/entities/workspaces/{workspaceId}/parameters

Post Parameters › path Parameters

workspaceIdstring · required

Post Parameters › query Parameters

includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
createdBy
modifiedBy
ALL
metaIncludestring[] · unique · style: form
Include Meta objects.
Included meta objects
Enum values:
origin
all
ALL

Post Parameters › Request Body

dataobject · required
JSON:API representation of parameter entity.

Post Parameters › Responses

Request successfully processed

dataobject · required
JSON:API representation of parameter entity.

includedobject[] · unique
Included resources
linksobject

The search endpoint (beta)

POST

/api/v1/entities/workspaces/{workspaceId}/parameters/search

The search endpoint (beta) › path Parameters

workspaceIdstring · required

The search endpoint (beta) › query Parameters

originstring · enum
Defines scope of origin of objects. All by default.
Enum values:
ALL
PARENTS
NATIVE
Default: ALL

The search endpoint (beta) › Headers

X-GDC-VALIDATE-RELATIONSboolean
Default: false

The search endpoint (beta) › Request Body

filterstring | null
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includearray | null
List of related entities to include in the response
metaIncludearray | null · unique
Set of metadata fields to include in the response
pageobject
Pagination information for entity search
sortarray | null
Sorting criteria (can specify multiple sort orders)

The search endpoint (beta) › Responses

Request successfully processed

dataobject[] · unique · required

includedobject[] · unique
Included resources
linksobject
metaobject

Get a Parameter

GET

/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}

Get a Parameter › path Parameters

workspaceIdstring · required
objectIdstring · required

Get a Parameter › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
createdBy
modifiedBy
ALL
metaIncludestring[] · unique · style: form
Include Meta objects.
Included meta objects
Enum values:
origin
all
ALL

Get a Parameter › Headers

X-GDC-VALIDATE-RELATIONSboolean
Default: false

Get a Parameter › Responses

Request successfully processed

dataobject · required
JSON:API representation of parameter entity.

includedobject[] · unique
Included resources
linksobject

Put a Parameter

PUT

/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}

Put a Parameter › path Parameters

workspaceIdstring · required
objectIdstring · required

Put a Parameter › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
createdBy
modifiedBy
ALL

Put a Parameter › Request Body

dataobject · required
JSON:API representation of parameter entity.

Put a Parameter › Responses

Request successfully processed

dataobject · required
JSON:API representation of parameter entity.

includedobject[] · unique
Included resources
linksobject

Delete a Parameter

DELETE

/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}

Delete a Parameter › path Parameters

workspaceIdstring · required
objectIdstring · required

Delete a Parameter › Responses

Successfully deleted

No data returned

Patch a Parameter

PATCH

/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}

Patch a Parameter › path Parameters

workspaceIdstring · required
objectIdstring · required

Patch a Parameter › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
createdBy
modifiedBy
ALL

Patch a Parameter › Request Body

dataobject · required
JSON:API representation of patching parameter entity.

Patch a Parameter › Responses

Request successfully processed

dataobject · required
JSON:API representation of parameter entity.

includedobject[] · unique
Included resources
linksobject

Get user data filters

GET

/api/v1/layout/workspaces/{workspaceId}/userDataFilters

Retrieve current user data filters assigned to the workspace.

Get user data filters › path Parameters

workspaceIdstring · required

Get user data filters › Responses

Retrieved current user data filters.

userDataFiltersobject[] · required

Set user data filters

PUT

/api/v1/layout/workspaces/{workspaceId}/userDataFilters

Set user data filters assigned to the workspace.

Set user data filters › path Parameters

workspaceIdstring · required

Set user data filters › Request Body

userDataFiltersobject[] · required

Set user data filters › Responses

User data filters successfully set.

No data returned

Get collection features

GET

/api/v1/location/collections/{collectionId}/items

Retrieve features from a GeoCollections collection as GeoJSON

Get collection features › path Parameters

collectionIdstring · required
Collection identifier

Get collection features › query Parameters

limitinteger · min: 1 · max: 100
Maximum number of features to return
bboxstring
Bounding box filter (minx,miny,maxx,maxy)
valuesstring[]
List of values to filter features by

Get collection features › Responses

Features retrieved successfully

featuresobject[] · required
typestring · required

bboxnumber[]

Get custom collection features

GET

/api/v1/location/custom/collections/{collectionId}/items

Retrieve features from a custom (organization-scoped) GeoCollections collection as GeoJSON

Get custom collection features › path Parameters

collectionIdstring · required
Collection identifier

Get custom collection features › query Parameters

limitinteger · min: 1 · max: 100
Maximum number of features to return
bboxstring
Bounding box filter (minx,miny,maxx,maxy)
valuesstring[]
List of values to filter features by

Get custom collection features › Responses

Features retrieved successfully

featuresobject[] · required
typestring · required

bboxnumber[]

AI Lake - Services & Operations