-
Notifications
You must be signed in to change notification settings - Fork 12
REST API JSONs
This is an automatically created documentation. It is not 100% accurate since the generator does not handle every edge case.
Instead of a list ConQuery also always accepts a single element.
GET /datasets ✎
Details
Java Type: com.bakdata.conquery.resources.api.DatasetsResource
Method: getDatasets
Returns: list of IdLabel
GET concepts/{concept} ✎
Details
Java Type: com.bakdata.conquery.resources.api.ConceptResource
Method: getNode
Returns: Response
POST concepts/{concept}/resolve ✎
Details
Java Type: com.bakdata.conquery.resources.api.ConceptResource
Method: resolve
Expects: ConceptCodeList Returns: ResolvedConceptsResult
GET config/frontend ✎
Details
Java Type: com.bakdata.conquery.resources.api.ConfigResource
Method: getFrontendConfig
Returns: FrontendConfiguration
GET datasets/{dataset}/concepts ✎
Details
Java Type: com.bakdata.conquery.resources.api.DatasetResource
Method: getRoot
Returns: FrontendRoot
GET datasets/{dataset}/entity-preview ✎
Provides list of default {@link ConnectorId}s to use for {@link QueryResource.EntityPreview#getSources()}.
Details
Java Type: com.bakdata.conquery.resources.api.DatasetResource
Method: getEntityPreviewDefaultConnectors
Returns: FrontendPreviewConfig
POST filters/{filter}/autocomplete ✎
Details
Java Type: com.bakdata.conquery.resources.api.FilterResource
Method: autocompleteTextFilter
Expects: AutocompleteRequest
Returns: AutoCompleteResult
POST filters/{filter}/resolve ✎
Details
Java Type: com.bakdata.conquery.resources.api.FilterResource
Method: resolveFilterValues
Expects: FilterValues
Returns: ResolvedFilterValues
GET queries/{query} ✎
Details
Java Type: com.bakdata.conquery.resources.api.QueryResource
Method: getStatus
Expects: boolean
Returns: FullExecutionStatus
PATCH queries/{query} ✎
Details
Java Type: com.bakdata.conquery.resources.api.QueryResource
Method: patchQuery
Expects: boolean
Expects: MetaDataPatch
Returns: FullExecutionStatus
DELETE queries/{query} ✎
Details
Java Type: com.bakdata.conquery.resources.api.QueryResource
Method: deleteQuery
Returns: void
POST queries/{query}/cancel ✎
Details
Java Type: com.bakdata.conquery.resources.api.QueryResource
Method: cancel
Returns: void
POST queries/{query}/reexecute ✎
Details
Java Type: com.bakdata.conquery.resources.api.QueryResource
Method: reexecute
Expects: boolean
Returns: FullExecutionStatus
GET queries/{query}/statistics ✎
Details
Java Type: com.bakdata.conquery.resources.api.QueryResource
Method: getDescription
Returns: Response
GET result/csv/{query}.csv ✎
Details
Java Type: com.bakdata.conquery.resources.api.ResultCsvResource
Method: getAsCsv
Expects: String
Expects: String
Expects: boolean
Expects: OptionalLong
Returns: Response
Different types of QueryDescription can be used by setting type to one of the following values:
ABSOLUTE_FORM_QUERY ✎
Details
Java Type: com.bakdata.conquery.models.forms.managed.AbsoluteFormQuery
No fields can be set for this type.
ARRAY_CONCEPT_QUERY ✎
Query type that combines a set of {@link ConceptQuery}s which are separately evaluated and whose results are merged. If a SpecialDateUnion is required, the result will hold the union of all dates from the separate queries.
Details
Java Type: com.bakdata.conquery.apiv1.query.ArrayConceptQuery
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | childQueries | list of CONCEPT_QUERY | ? | ||
| ✎ | dateAggregationMode | one of NONE, MERGE, INTERSECT, LOGICAL | ? | ||
| ✎ | resolvedDateAggregationMode | one of NONE, MERGE, INTERSECT, LOGICAL | ? |
CONCEPT_QUERY ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.ConceptQuery
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | dateAggregationMode | one of NONE, MERGE, INTERSECT, LOGICAL | "MERGE" |
||
| ✎ | resolvedDateAggregationMode | one of NONE, MERGE, INTERSECT, LOGICAL | null |
||
| ✎ | root | @Valid @NotNull CQElement | null |
ENTITY_DATE_QUERY ✎
This query uses the date range defined by {@link EntityDateQuery#query} for each entity and applies it as a date restriction for the following query defined by {@link EntityDateQuery#features}. The additional {@link EntityDateQuery#dateRange} is applied globally on all entities.
Details
Java Type: com.bakdata.conquery.models.forms.managed.EntityDateQuery
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | dateAggregationMode | one of NONE, MERGE, INTERSECT, LOGICAL | ? | ||
| ✎ | dateRange | CDateRange |
? | ||
| ✎ | features | ARRAY_CONCEPT_QUERY | ? | ||
| ✎ | query | @NotNull @Valid Query |
? | ||
| ✎ | resolutionsAndAlignments | list of ResolutionAndAlignment
|
? |
ENTITY_PREVIEW ✎
Details
Java Type: com.bakdata.conquery.models.query.preview.EntityPreviewForm
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | infoCardQuery | ABSOLUTE_FORM_QUERY | ? | ||
| ✎ | timeOverViews | map from String to ABSOLUTE_FORM_QUERY
|
? | ||
| ✎ | valuesQuery | TABLE_EXPORT | ? |
EXPORT_FORM ✎
Details
Java Type: com.bakdata.conquery.apiv1.forms.export_form.ExportForm
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | alsoCreateCoarserSubdivisions | boolean |
false |
||
| ✎ | features | list of CQElement | [] |
||
| ✎ | queryGroupId | ID of ManagedExecution
|
␀ | ||
| ✎ | resolution | list of one of COMPLETE, YEARS, QUARTERS, DAYS, YEARS_QUARTERS, COMPLETE_YEARS, COMPLETE_QUARTERS, COMPLETE_YEARS_QUARTERS | ["COMPLETE"] |
||
| ✎ | timeMode | @NotNull @Valid Mode |
null |
||
| ✎ | values | JsonNode |
null |
EXTERNAL_FORM ✎
Details
Java Type: com.bakdata.conquery.apiv1.forms.ExternalForm
No fields can be set for this type.
FULL_EXPORT_FORM ✎
Details
Java Type: com.bakdata.conquery.apiv1.forms.export_form.FullExportForm
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | dateRange | @Valid Range<LocalDate> |
|||
| ✎ | queryGroupId | ID of ManagedExecution
|
␀ | ||
| ✎ | tables | list of CONCEPT | [] |
||
| ✎ | values | JsonNode |
null |
RELATIVE_FORM_QUERY ✎
Details
Java Type: com.bakdata.conquery.models.forms.managed.RelativeFormQuery
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | features | ARRAY_CONCEPT_QUERY | ? | ||
| ✎ | indexPlacement | one of BEFORE, NEUTRAL, AFTER | ? | ||
| ✎ | indexSelector | one of EARLIEST, LATEST, RANDOM | ? | ||
| ✎ | query | @NotNull @Valid Query |
? | ||
| ✎ | resolutionsAndAlignmentMap | list of ResolutionAndAlignment
|
? | ||
| ✎ | timeCountAfter | @jakarta.validation.constraints.Min(0) int |
? | ||
| ✎ | timeCountBefore | @jakarta.validation.constraints.Min(0) int |
? | ||
| ✎ | timeUnit | one of DAYS, QUARTERS, YEARS | ? |
SECONDARY_ID_QUERY ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.SecondaryIdQuery
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | dateAggregationMode | one of NONE, MERGE, INTERSECT, LOGICAL | "MERGE" |
||
| ✎ | query | CONCEPT_QUERY | null |
||
| ✎ | root | @NotNull CQElement | null |
||
| ✎ | secondaryId | ID of @NsIdRef @NotNull SecondaryIdDescription
|
null |
||
| ✎ | withSecondaryId | list of ID of @NsIdRefCollection Set<Column>
|
null |
||
| ✎ | withoutSecondaryId | list of ID of @NsIdRefCollection Set<Table>
|
null |
TABLE_EXPORT ✎
TableExportQuery can be used to export raw data from selected {@link Connector}s, for selected {@link com.bakdata.conquery.models.query.entity.Entity}s.
Output format is lightly structured: 1: Contains the {@link com.bakdata.conquery.models.datasets.concepts.ValidityDate} if one is available for the event. 2: Contains the source {@link com.bakdata.conquery.models.datasets.Table}s label. 3 - X: Contain the SecondaryId columns de-duplicated. Following: Columns of all tables, (except for SecondaryId Columns), grouped by tables. The order is not guaranteed.
Columns used in Connectors to build Concepts, are marked with {@link SemanticType.ConceptColumnT} in {@link FullExecutionStatus#getColumnDescriptions()}.
Details
Java Type: com.bakdata.conquery.apiv1.query.TableExportQuery
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | dateRange | @NotNull Range<LocalDate> |
? | ||
| ✎ | positions | map from Column to int or null
|
? | We collect the positions for each Column of the output in here. Multiple columns can map to the same output position: - ValidityDate-Columns are merged into a single Date-Column - SecondaryIds are collected into a Column per SecondaryId - The remaining columns are arbitrarily ordered, but usually grouped by their source table. | |
| ✎ | query | @NonNull Query |
? | ||
| ✎ | rawConceptValues | boolean |
? | ||
| ✎ | tables | list of CONCEPT | ? |
Different types of CQElement can be used by setting type to one of the following values:
AND ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.specific.CQAnd
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
null |
Allows the user to define labels. | |
| ✎ | children | list of CQElement | null |
||
| ✎ | createExists | Optional<Boolean> |
null |
||
| ✎ | dateAction | one of BLOCK, MERGE, INTERSECT, NEGATE | null |
BEFORE ✎
Creates a query that will contain all entities where {@code preceding} contains events that happened before the events of {@code index}. And the time where this has happened.
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.specific.temporal.CQBeforeTemporalQuery
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
? | Allows the user to define labels. |
BEFORE_OR_SAME ✎
Creates a query that will contain all entities where {@code preceding} contains events that happened on the same day or before the events of {@code index}. And the time where this has happened.
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.specific.temporal.CQBeforeOrSameTemporalQuery
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
? | Allows the user to define labels. |
CONCEPT ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.specific.CQConcept
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
null |
Allows the user to define labels. | |
| ✎ | aggregateEventDates | boolean |
false |
||
| ✎ | elements | list of ID of ConceptElement<?>
|
␀ | ||
| ✎ | excludeFromSecondaryId | boolean |
false |
||
| ✎ | excludeFromTimeAggregation | boolean |
false |
||
| ✎ | selects | list of ID of Select
|
[] |
||
| ✎ | tables | list of CQTable | [] |
DATE_RESTRICTION ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.specific.CQDateRestriction
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
? | Allows the user to define labels. |
DAYS_BEFORE ✎
Creates a query that will contain all entities where {@code preceding} contains events that happened {@code days} before the events of {@code index}. And the time where this has happened.
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.specific.temporal.CQDaysBeforeTemporalQuery
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
? | Allows the user to define labels. |
DAYS_OR_NO_EVENT_BEFORE ✎
Creates a query that will contain all entities where {@code preceding} contains events that happened {@code days} before the events of {@code index}, or no events. And the time where this has happened.
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.specific.temporal.CQDaysBeforeOrNeverTemporalQuery
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
? | Allows the user to define labels. |
EXTERNAL ✎
Allows uploading lists of entities.
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.specific.external.CQExternal
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
null |
Allows the user to define labels. |
NEGATION ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.specific.CQNegation
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
null |
Allows the user to define labels. | |
| ✎ | child | @Valid @NotNull CQElement | null |
||
| ✎ | dateAction | one of BLOCK, MERGE, INTERSECT, NEGATE | null |
OR ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.specific.CQOr
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
null |
Allows the user to define labels. | |
| ✎ | children | list of CQElement | null |
||
| ✎ | createExists | Optional<Boolean> |
null |
||
| ✎ | dateAction | one of BLOCK, MERGE, INTERSECT, NEGATE | null |
RESULT_INFO_DECORATOR ✎
A wrapper for {@link CQElement}s to provide additional infos to parts of a query.
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.specific.ResultInfoDecorator
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
null |
Allows the user to define labels. | |
| ✎ | child | @NotNull CQElement | null |
||
| ✎ | values | ClassToInstanceMap maps from base class Object to instances of subtypes |
SAME ✎
Creates a query that will contain all entities where {@code preceding} contains events that happened {@code days} at the same time as the events of {@code index}. And the time where this has happened.
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.specific.temporal.CQSameTemporalQuery
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
? | Allows the user to define labels. |
SAVED_QUERY ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.specific.CQReusedQuery
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
null |
Allows the user to define labels. | |
| ✎ | excludeFromSecondaryId | boolean |
false |
||
| ✎ | queryId | ID of ManagedExecution
|
␀ | ||
| ✎ | resolvedQuery | Query |
null |
YES ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.CQYes
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
null |
Allows the user to define labels. |
Different types of FilterValue can be used by setting type to one of the following values:
BIG_MULTI_SELECT ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.filter.FilterValue$CQBigMultiSelectFilter
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | filter | ID of @NotNull @NsIdRef Filter<VALUE>
|
null |
||
| ✎ | value | @NotNull VALUE |
null |
GROUP ✎
A filter value that consists of multiple inputs that are grouped together into one form.
See TestGroupFilter in the tests for an example.
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.filter.FilterValue$GroupFilterValue
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | filter | ID of @NotNull @NsIdRef Filter<VALUE>
|
? | ||
| ✎ | value | @NotNull VALUE |
? |
INTEGER ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.filter.FilterValue$CQIntegerFilter
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | filter | ID of @NotNull @NsIdRef Filter<VALUE>
|
null |
||
| ✎ | value | @NotNull VALUE |
null |
INTEGER_RANGE ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.filter.FilterValue$CQIntegerRangeFilter
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | filter | ID of @NotNull @NsIdRef Filter<VALUE>
|
null |
||
| ✎ | value | @NotNull VALUE |
null |
MONEY_RANGE ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.filter.FilterValue$CQMoneyRangeFilter
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | filter | ID of @NotNull @NsIdRef Filter<VALUE>
|
null |
||
| ✎ | value | @NotNull VALUE |
null |
MULTI_SELECT ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.filter.FilterValue$CQMultiSelectFilter
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | filter | ID of @NotNull @NsIdRef Filter<VALUE>
|
null |
||
| ✎ | value | @NotNull VALUE |
null |
REAL ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.filter.FilterValue$CQRealFilter
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | filter | ID of @NotNull @NsIdRef Filter<VALUE>
|
null |
||
| ✎ | value | @NotNull VALUE |
null |
REAL_RANGE ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.filter.FilterValue$CQRealRangeFilter
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | filter | ID of @NotNull @NsIdRef Filter<VALUE>
|
null |
||
| ✎ | value | @NotNull VALUE |
null |
SELECT ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.filter.FilterValue$CQSelectFilter
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | filter | ID of @NotNull @NsIdRef Filter<VALUE>
|
null |
||
| ✎ | value | @NotNull VALUE |
null |
STRING ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.filter.FilterValue$CQStringFilter
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | filter | ID of @NotNull @NsIdRef Filter<VALUE>
|
null |
||
| ✎ | value | @NotNull VALUE |
null |
Different types of ResultType can be used by setting type to one of the following values:
BOOLEAN ✎
Details
Java Type: com.bakdata.conquery.models.types.ResultType$BooleanT
No fields can be set for this type.
DATE ✎
Details
Java Type: com.bakdata.conquery.models.types.ResultType$DateT
No fields can be set for this type.
DATE_RANGE ✎
Details
Java Type: com.bakdata.conquery.models.types.ResultType$DateRangeT
No fields can be set for this type.
INTEGER ✎
Details
Java Type: com.bakdata.conquery.models.types.ResultType$IntegerT
No fields can be set for this type.
LIST ✎
Details
Java Type: com.bakdata.conquery.models.types.ResultType$ListT
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | elementType | @NonNull ResultType | ? |
MONEY ✎
Details
Java Type: com.bakdata.conquery.models.types.ResultType$MoneyT
No fields can be set for this type.
NUMERIC ✎
Details
Java Type: com.bakdata.conquery.models.types.ResultType$NumericT
No fields can be set for this type.
STRING ✎
Details
Java Type: com.bakdata.conquery.models.types.ResultType$StringT
No fields can be set for this type.
Different types of SemanticType can be used by setting type to one of the following values:
CATEGORICAL ✎
Column contains a fixed set of String values.
Details
Java Type: com.bakdata.conquery.models.types.SemanticType$CategoricalT
No fields can be set for this type.
COLUMN ✎
Column contains values from {@link Column} Only used for {@link com.bakdata.conquery.apiv1.query.TableExportQuery}.
Details
Java Type: com.bakdata.conquery.models.types.SemanticType$ColumnT
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | column | ID of @NsIdRef Column
|
? |
CONCEPT_COLUMN ✎
Column contains values used by a Connector of a Concept. Only used for {@link com.bakdata.conquery.apiv1.query.TableExportQuery}.
Details
Java Type: com.bakdata.conquery.models.types.SemanticType$ConceptColumnT
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | concept | ID of @NsIdRef Concept<?>
|
? |
EVENT_DATE ✎
Column containing primary Event dates. There should only ever be one EVENT_DATE per Query.
Details
Java Type: com.bakdata.conquery.models.types.SemanticType$EventDateT
No fields can be set for this type.
GROUP ✎
Columns marked with {@link GroupT} should be used to merge events in the preview.
Details
Java Type: com.bakdata.conquery.models.types.SemanticType$GroupT
No fields can be set for this type.
HIDDEN ✎
Columns marked with {@link GroupT} should not be displayed by default in the preview.
Details
Java Type: com.bakdata.conquery.models.types.SemanticType$HiddenT
No fields can be set for this type.
ID ✎
Column contains an Entity's Id of a kind.
See {@link com.bakdata.conquery.models.config.ColumnConfig} / {@link IdColumnConfig}for the source of this.
Details
Java Type: com.bakdata.conquery.models.types.SemanticType$IdT
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | kind | String |
? |
RESOLUTION ✎
Column contains {@link com.bakdata.conquery.models.forms.util.Resolution} from an {@link com.bakdata.conquery.apiv1.forms.export_form.ExportForm}.
Details
Java Type: com.bakdata.conquery.models.types.SemanticType$ResolutionT
No fields can be set for this type.
SECONDARY_ID ✎
Column contains values of a {@link SecondaryIdDescription}.
Details
Java Type: com.bakdata.conquery.models.types.SemanticType$SecondaryIdT
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | secondaryId | ID of @NsIdRef SecondaryIdDescription
|
? |
SELECT ✎
Column contains the results of a {@link Select}.
Details
Java Type: com.bakdata.conquery.models.types.SemanticType$SelectResultT
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | select | ID of @NsIdRef Select
|
? |
SOURCES ✎
Column contains the source of the result line.
At the moment, only used in {@link com.bakdata.conquery.apiv1.query.TableExportQuery}.
Details
Java Type: com.bakdata.conquery.models.types.SemanticType$SourcesT
No fields can be set for this type.
Type AutocompleteRequest ✎
Details
Java Type: com.bakdata.conquery.resources.api.FilterResource$AutocompleteRequest
No fields can be set for this type.
Type CQTable ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.filter.CQTable
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | connector | ID of @NsIdRef Connector
|
␀ | ||
| ✎ | dateColumn | ValidityDateContainer | null |
||
| ✎ | filters | list of FilterValue<?> | [] |
||
| ✎ | selects | list of ID of Select
|
[] |
Type ConceptCodeList ✎
Details
Java Type: com.bakdata.conquery.resources.api.ConceptResource$ConceptCodeList
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | concepts | list of String
|
? |
Type CurrencyConfig ✎
Details
Java Type: com.bakdata.conquery.models.config.FrontendConfig$CurrencyConfig
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | decimalScale | int |
2 |
||
| ✎ | decimalSeparator | String |
"," |
||
| ✎ | thousandSeparator | String |
"." |
||
| ✎ | unit | String |
"€" |
Type ExecutionStatus ✎
Details
Java Type: com.bakdata.conquery.apiv1.execution.ExecutionStatus
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | containsDates | boolean |
? | ||
| ✎ | createdAt | ZonedDateTime |
? | ||
| ✎ | finishTime | LocalDateTime |
? | ||
| ✎ | id | ID of ManagedExecution
|
? | ||
| ✎ | label | String |
? | ||
| ✎ | lastUsed | ZonedDateTime |
? | ||
| ✎ | numberOfResults |
long or null
|
? | ||
| ✎ | own | boolean |
? | ||
| ✎ | owner | ID of User
|
? | ||
| ✎ | ownerName | String |
? | ||
| ✎ | queryType | String |
? | ||
| ✎ | requiredTime |
long or null
|
? | ||
| ✎ | resultUrls | list of ResultAsset
|
? | The urls under from which the result of the execution can be downloaded as soon as it finished successfully. | |
| ✎ | secondaryId | ID of SecondaryIdDescription
|
? | ||
| ✎ | shared | boolean |
? | ||
| ✎ | startTime | LocalDateTime |
? | ||
| ✎ | status | one of NEW, RUNNING, FAILED, DONE | ? | ||
| ✎ | system | boolean |
? | ||
| ✎ | tags | list of String
|
? |
Type FilterValues ✎
Details
Java Type: com.bakdata.conquery.resources.api.FilterResource$FilterValues
No fields can be set for this type.
Type FormConfig ✎
Details
Java Type: com.bakdata.conquery.models.forms.configs.FormConfig
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | creationTime | LocalDateTime |
generated default varies | ||
| ✎ | dataset | ID of @NsIdRef Dataset
|
null |
||
| ✎ | formId | @NonNull UUID |
generated default varies | ||
| ✎ | formType | String |
null |
||
| ✎ | label | String |
null |
||
| ✎ | owner | ID of @MetaIdRef User
|
null |
||
| ✎ | shared | boolean |
false |
||
| ✎ | tags | list of String
|
[] |
||
| ✎ | values | @NotNull JsonNode |
null |
This is a blackbox for us at the moment, where the front end saves the state of the form, when the user saved it. |
Type FormConfigFullRepresentation ✎
API representation for a single {@link FormConfig} which includes the form fields an their values.
Details
Java Type: com.bakdata.conquery.models.forms.configs.FormConfig$FormConfigFullRepresentation
No fields can be set for this type.
Type FormConfigOverviewRepresentation ✎
API representation for the overview of all {@link FormConfig}s which does not include the form fields an their values.
Details
Java Type: com.bakdata.conquery.models.forms.configs.FormConfig$FormConfigOverviewRepresentation
No fields can be set for this type.
Type FrontendConfig ✎
Details
Java Type: com.bakdata.conquery.models.config.FrontendConfig
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | alwaysAllowCreateValue | boolean |
false |
If true, users are always allowed to add custom values into SelectFilter input fields. | |
| ✎ | contactEmail | String |
null |
||
| ✎ | currency | CurrencyConfig | |||
| ✎ | manualUrl | URL |
null |
The url that points a manual. This is also used by the {@link FormScanner} as the base url for forms that specify a relative url. Internally {@link URI#resolve(URI)} is used to concatenate this base url and the manual url from the form. An final slash ('{@code /}') on the base url has the following effect:
|
|
| ✎ | observationPeriodYears | @jakarta.validation.constraints.Min(0) int |
6 |
Years to include in entity preview. | |
| ✎ | visualisationPercentiles | Range<Integer> |
|||
| ✎ | visualisationsHistogramLimit | @jakarta.validation.constraints.Min(0) int |
10 |
Limit to number of histogram entries. Note, that zero and out of bounds values are tracked in separate bins, so you can have three additional bins. |
Type FrontendRoot ✎
This class represents the root node of the concepts as it is presented to the front end.
Details
Java Type: com.bakdata.conquery.apiv1.frontend.FrontendRoot
No fields can be set for this type.
Type FrontendValue ✎
This class represents a values of a SELECT filter.
Details
Java Type: com.bakdata.conquery.apiv1.frontend.FrontendValue
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | label | String |
? | ||
| ✎ | optionValue | String |
? | ||
| ✎ | value | String |
? | Value is the only relevant data-point for hashing/equality and searching from the service perspective. |
Type FullExecutionStatus ✎
This status holds extensive information about the query description and meta data that is computational heavy and can produce a larger payload to requests. It should only be rendered, when a client asks for a specific execution, not if a list of executions is requested.
Details
Java Type: com.bakdata.conquery.apiv1.execution.FullExecutionStatus
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | containsDates | boolean |
false |
||
| ✎ | createdAt | ZonedDateTime |
null |
||
| ✎ | finishTime | LocalDateTime |
null |
||
| ✎ | id | ID of ManagedExecution
|
null |
||
| ✎ | label | String |
null |
||
| ✎ | lastUsed | ZonedDateTime |
null |
||
| ✎ | numberOfResults |
long or null
|
null |
||
| ✎ | own | boolean |
false |
||
| ✎ | owner | ID of User
|
null |
||
| ✎ | ownerName | String |
null |
||
| ✎ | queryType | String |
null |
||
| ✎ | requiredTime |
long or null
|
null |
||
| ✎ | resultUrls | list of ResultAsset
|
[] |
The urls under from which the result of the execution can be downloaded as soon as it finished successfully. | |
| ✎ | secondaryId | ID of SecondaryIdDescription
|
null |
||
| ✎ | shared | boolean |
false |
||
| ✎ | startTime | LocalDateTime |
null |
||
| ✎ | status | one of NEW, RUNNING, FAILED, DONE | null |
||
| ✎ | system | boolean |
false |
||
| ✎ | tags | list of String
|
null |
||
| ✎ | availableSecondaryIds | list of ID of @NsIdRefCollection Set<SecondaryIdDescription>
|
null |
Possible {@link SecondaryIdDescription}s available, of {@link com.bakdata.conquery.models.datasets.concepts.Concept}s used in this Query. | |
| ✎ | canExpand | boolean |
false |
Indicates if the concepts that are included in the query description can be accessed by the user. | |
| ✎ | columnDescriptions | list of ColumnDescriptor
|
null |
Holds a description for each column, present in the result. | |
| ✎ | error | ConqueryErrorInfo |
null |
Is set when the QueryFailed | |
| ✎ | groups | Collection<GroupId> |
null |
The groups this execution is shared with. | |
| ✎ | progress |
float or null
|
null |
The estimated progress of an running execution in the enclosing interval [0-1]. This value does not have to be set if the state is RUNNING and it must not be set if the state is not RUNNING. | |
| ✎ | query | QueryDescription | null |
Is set to the query description if the user can expand all included concepts. |
Type IdLabel ✎
Container class for the frontend to provide a tuple of id and a corresponding label.
Details
Java Type: com.bakdata.conquery.apiv1.IdLabel
No fields can be set for this type.
Type MetaDataPatch ✎
Details
Java Type: com.bakdata.conquery.apiv1.MetaDataPatch
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | groups | list of ID of Group
|
null |
||
| ✎ | label | String |
null |
||
| ✎ | tags | list of String
|
null |
Type OverviewExecutionStatus ✎
Light weight description of an execution. Rendering the overview should not cause heavy computations.
Details
Java Type: com.bakdata.conquery.apiv1.execution.OverviewExecutionStatus
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | containsDates | boolean |
false |
||
| ✎ | createdAt | ZonedDateTime |
null |
||
| ✎ | finishTime | LocalDateTime |
null |
||
| ✎ | id | ID of ManagedExecution
|
null |
||
| ✎ | label | String |
null |
||
| ✎ | lastUsed | ZonedDateTime |
null |
||
| ✎ | numberOfResults |
long or null
|
null |
||
| ✎ | own | boolean |
false |
||
| ✎ | owner | ID of User
|
null |
||
| ✎ | ownerName | String |
null |
||
| ✎ | queryType | String |
null |
||
| ✎ | requiredTime |
long or null
|
null |
||
| ✎ | resultUrls | list of ResultAsset
|
[] |
The urls under from which the result of the execution can be downloaded as soon as it finished successfully. | |
| ✎ | secondaryId | ID of SecondaryIdDescription
|
null |
||
| ✎ | shared | boolean |
false |
||
| ✎ | startTime | LocalDateTime |
null |
||
| ✎ | status | one of NEW, RUNNING, FAILED, DONE | null |
||
| ✎ | system | boolean |
false |
||
| ✎ | tags | list of String
|
null |
Type ResolvedConceptsResult ✎
Details
Java Type: com.bakdata.conquery.resources.api.ConceptsProcessor$ResolvedConceptsResult
No fields can be set for this type.
Type ResolvedFilterResult ✎
Details
Java Type: com.bakdata.conquery.resources.api.ConceptsProcessor$ResolvedFilterResult
No fields can be set for this type.
Type ValidityDateContainer ✎
Details
Java Type: com.bakdata.conquery.apiv1.query.concept.filter.ValidityDateContainer
Supported Fields:
| Field | Type | Default | Example | Description | |
|---|---|---|---|---|---|
| ✎ | value | ID of @NsIdRef ValidityDate
|
? |