REST API JSONs

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.

REST endpoints

GET /datasets_^✎

Details

Java Type: com.bakdata.conquery.resources.api.DatasetsResource

Method: getDatasets

Returns: list of IdLabel

GET config/frontend_^✎

Details

Java Type: com.bakdata.conquery.resources.api.ConfigResource

Method: getFrontendConfig

Returns: FrontendConfig

GET datasets/{dataset}/concepts_^✎

Details

Java Type: com.bakdata.conquery.resources.api.DatasetResource

Method: getRoot

Returns: FERoot

GET datasets/{dataset}/concepts/{concept}_^✎

Details

Java Type: com.bakdata.conquery.resources.api.ConceptResource

Method: getNode

Returns: Response

POST datasets/{dataset}/concepts/{concept}/resolve_^✎

Details

Java Type: com.bakdata.conquery.resources.api.ConceptResource

Method: resolve

Expects: ConceptCodeList Returns: ResolvedConceptsResult

POST datasets/{dataset}/concepts/{concept}/tables/{table}/filters/{filter}/autocomplete_^✎

Details

Java Type: com.bakdata.conquery.resources.api.FilterResource

Method: autocompleteTextFilter

Expects: AutocompleteRequest Returns: AutoCompleteResult

POST datasets/{dataset}/concepts/{concept}/tables/{table}/filters/{filter}/resolve_^✎

Details

Java Type: com.bakdata.conquery.resources.api.FilterResource

Method: resolveFilterValues

Expects: FilterValues Returns: ResolvedConceptsResult

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

GET datasets/{dataset}/queries_^✎

Details

Java Type: com.bakdata.conquery.resources.api.QueryResource

Method: getAllQueries

Expects: Optional<Boolean> Returns: list of ExecutionStatus

POST datasets/{dataset}/queries_^✎

Details

Java Type: com.bakdata.conquery.resources.api.QueryResource

Method: postQuery

Expects: Optional<Boolean> Expects: @NotNull(message="{javax.validation.constraints.NotNull.message}", groups={}, payload={}) @Valid QueryDescription Returns: Response

POST datasets/{dataset}/queries/entity_^✎

Details

Java Type: com.bakdata.conquery.resources.api.QueryResource

Method: getEntityData

Expects: EntityPreview Returns: FullExecutionStatus

POST datasets/{dataset}/queries/upload_^✎

Details

Java Type: com.bakdata.conquery.resources.api.QueryResource

Method: upload

Expects: @Valid ExternalUpload Returns: ExternalUploadResult

GET datasets/{dataset}/queries/{query}_^✎

Details

Java Type: com.bakdata.conquery.resources.api.QueryResource

Method: getStatus

Expects: Optional<Boolean> Returns: FullExecutionStatus

PATCH datasets/{dataset}/queries/{query}_^✎

Details

Java Type: com.bakdata.conquery.resources.api.QueryResource

Method: patchQuery

Expects: Optional<Boolean> Expects: MetaDataPatch Returns: FullExecutionStatus

DELETE datasets/{dataset}/queries/{query}_^✎

Details

Java Type: com.bakdata.conquery.resources.api.QueryResource

Method: deleteQuery

Returns: void

POST datasets/{dataset}/queries/{query}/cancel_^✎

Details

Java Type: com.bakdata.conquery.resources.api.QueryResource

Method: cancel

Returns: void

POST datasets/{dataset}/queries/{query}/reexecute_^✎

Details

Java Type: com.bakdata.conquery.resources.api.QueryResource

Method: reexecute

Expects: Optional<Boolean> Returns: FullExecutionStatus

GET datasets/{dataset}/result/{query}.csv_^✎

Details

Java Type: com.bakdata.conquery.resources.api.ResultCsvResource

Method: getAsCsv

Expects: String Expects: String Expects: Optional<Boolean> Returns: Response

---

Base QueryDescription

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

Supported Fields:

	Field	Type	Default	Example	Description
✎	dateRange	@NotNull @Valid Range<LocalDate>	?
✎	features	ARRAY_CONCEPT_QUERY	?
✎	query	@NotNull @Valid Query	?
✎	resolutionsAndAlignmentMap	list of ResolutionAndAlignment	?

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	?
✎	resolvedDateAggregationMode	one of NONE, MERGE, INTERSECT, LOGICAL	?
✎	root	@Valid @NotNull CQElement	?

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

No fields can be set for this type.

ENTITY_PREVIEW_^✎

Details

Java Type: com.bakdata.conquery.models.query.preview.EntityPreviewForm

Supported Fields:

	Field	Type	Default	Example	Description
✎	values	JsonNode	?		Raw form config (basically the raw format of this form), that is used by the backend at the moment to create a {@link com.bakdata.conquery.models.forms.configs.FormConfig} upon start of this form (see {@link ManagedForm#start()}).

EXPORT_FORM_^✎

Details

Java Type: com.bakdata.conquery.apiv1.forms.export_form.ExportForm

Supported Fields:

	Field	Type	Default	Example	Description
✎	values	JsonNode	null		Raw form config (basically the raw format of this form), that is used by the backend at the moment to create a {@link com.bakdata.conquery.models.forms.configs.FormConfig} upon start of this form (see {@link ManagedForm#start()}).
✎	alsoCreateCoarserSubdivisions	boolean	true
✎	queryGroupId	ID of ManagedExecution	␀
✎	resolution	list of one of COMPLETE, YEARS, QUARTERS, DAYS	["COMPLETE"]
✎	timeMode	@NotNull @Valid Mode	null

FULL_EXPORT_FORM_^✎

Details

Java Type: com.bakdata.conquery.apiv1.forms.export_form.FullExportForm

Supported Fields:

	Field	Type	Default	Example	Description
✎	values	JsonNode	null		Raw form config (basically the raw format of this form), that is used by the backend at the moment to create a {@link com.bakdata.conquery.models.forms.configs.FormConfig} upon start of this form (see {@link ManagedForm#start()}).
✎	dateRange	@Valid Range<LocalDate>
✎	queryGroupId	ID of ManagedExecution	␀
✎	tables	list of CONCEPT	[]

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	@javax.validation.constraints.Min(0) int	?
✎	timeCountBefore	@javax.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	␀
✎	root	@NotNull CQElement	null
✎	secondaryId	ID of @NsIdRef @NotNull SecondaryIdDescription	null
✎	withSecondaryId	list of ID of @NsIdRefCollection Set<Column>	␀
✎	withoutSecondaryId	list of ID of @NsIdRefCollection Set<Table>	␀

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	?

---

Base CQElement

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	␀

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	␀
✎	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	␀

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	␀

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	␀

---

Base FilterValue

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

---

Base ResultType

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_^✎

A DateRange is provided by in a query result as two ints in a list, both standing for an epoch day (see {@link LocalDate#toEpochDay()}). The first int describes the included lower bound of the range. The second int descibes the included upper bound.

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.

---

Base SemanticType

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.

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 com.bakdata.conquery.models.config.FrontendConfig.UploadConfig}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.

---

Other Types

Type AutocompleteRequest_^✎

Details

Java Type: com.bakdata.conquery.resources.api.FilterResource$AutocompleteRequest

Supported Fields:

	Field	Type	Default	Example	Description
✎	page	@NonNull OptionalInt	?
✎	pageSize	@NonNull OptionalInt	?
✎	text	@NonNull Optional<String>	?

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	","
✎	prefix	String	"€"
✎	thousandSeparator	String	"."

Type ExecutionStatus_^✎

Details

Java Type: com.bakdata.conquery.apiv1.ExecutionStatus

Supported Fields:

	Field	Type	Default	Example	Description
✎	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 URL	?		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 FERoot_^✎

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.FERoot

No fields can be set for this type.

Type FEValue_^✎

This class represents a values of a SELECT filter.

Details

Java Type: com.bakdata.conquery.apiv1.frontend.FEValue

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 FilterValues_^✎

Details

Java Type: com.bakdata.conquery.resources.api.FilterResource$FilterValues

Supported Fields:

	Field	Type	Default	Example	Description
✎	values	list of String	?

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 formular, 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
✎	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: No slash: {@code baseUrl = http://example.org/manual/welcome} {@code formUrl = ./form} → {@code http://example.org/manual/form} Slash: {@code baseUrl = http://example.org/manual/} {@code formUrl = ./form} → {@code http://example.org/manual/form}
✎	queryUpload	UploadConfig
✎	version	String	"0.0.0-SNAPSHOT"

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.FullExecutionStatus

Supported Fields:

	Field	Type	Default	Example	Description
✎	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 URL	[]		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.OverviewExecutionStatus

Supported Fields:

	Field	Type	Default	Example	Description
✎	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 URL	[]		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

Supported Fields:

	Field	Type	Default	Example	Description
✎	resolvedConcepts	Set<ConceptElementId<?>>	?
✎	resolvedFilter	ResolvedFilterResult	?
✎	unknownCodes	Collection<String>	?

Type ResolvedFilterResult_^✎

Details

Java Type: com.bakdata.conquery.resources.api.ConceptsProcessor$ResolvedFilterResult

Supported Fields:

	Field	Type	Default	Example	Description
✎	filterId	ID of Filter	?
✎	tableId	ID of Connector	?
✎	value	Collection<FEValue>	?

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	?