API docs by Redocly

mod-fqm-manager API (v1)

mod-fqm-manager API

entityTypes

getEntityTypeSummary

Get names for a list of entity type ids.

query Parameters
ids
Array of strings <UUID> [ items <UUID > ]

List of entity type ids

includeInaccessible
boolean

Include inaccessible entity types in the result

includeAll
boolean

Include all the entity types regardless of being private

Responses

Response samples

Content type
application/json
{
  • "entityTypes": [
    ],
  • "_version": "string"
}

purgeQuery

deleteOldQueries

Deletes all queries that are older than the configured duration.

Responses

Response samples

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

materializedViews

refreshData

Refresh all materialized views and similar data for a tenant.

Responses

Response samples

Content type
application/json
{
  • "successfulRefresh": [
    ],
  • "failedRefresh": [
    ]
}

fqmVersion

getFqmVersion

Get version of the fqm.

Responses

Response samples

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

fqm migrate request

Request Body schema: application/json
required

Request for FQM version submitted successfully

object <FqmMigrateRequest>

Mapped to schema in folio-query-tool-metadata

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }