Schema Types#

Query (RootQuery)#

Field	Type	Description
indexerStatus	IndexerStatus!
search	SearchResult!
input	SearchInput!
suggest	SuggestResult!
input	SuggestInput!
ping	String!
moreLikeThis	SearchResult!
input	MoreLikeThisInput!
suggestCitygovPersonField	SuggestResult!
field	CitygovPersonField!
input	SuggestCitygovPersonInput!
searchCitygovPerson	SearchResult!
input	SearchCitygovPersonInput!
searchEvents	SearchResult!
input	SearchInput!
genAiQuestion	GenAiQuestionResult!	Answers a question using the resources indexed in the GenAI application: a GenAiAnswer, or an error that says why the question was not answered.
query	String!	The question.
lang	String	Language of the question, the one of the channel if not given.
categoryIds	[String!]	Restricts the retrieved resources to these categories; a parent category also matches its subcategories, several ids are combined with OR.

Mutation (RootMutation)#

Field	Type	Description
index	IndexerStatus!
indexUpdate	IndexerStatus!
paths	[String!]!	List of resource paths that are to be updated.
indexRemove	Boolean!
idList	[String!]	list of id's of the entries to be deleted
indexAbort	Boolean!
genAiAnswerFeedback	Boolean!	Sets the feedback of the answer the feedbackToken was given for; null withdraws it. Works only while the token is valid, 15 minutes by default. False if the token is unknown or expired, or the content of the answer was deleted.
feedbackToken	String!	The feedbackToken the answer came with.
feedback	GenAiAnswerFeedback
webAccountAuthenticationWithPassword	AuthenticationResult!
username	String!
password	String!
setJwtCookie	Boolean!
webAccountUnsetJwtCookie	Boolean!
webAccountStartRegistration	StartRegistrationResult!
input	StartRegistrationInput!
webAccountFinishRegistration	FinishUserRegistrationResultType!
input	FinishRegistrationInput!
webAccountStartPasswordRecovery	StartPasswordRecoveryResult!
input	StartPasswordRecoveryInput!
webAccountFinishPasswordRecovery	Boolean!
input	FinishPasswordRecoveryInput!

Objects#

ArticleTeaser#

An article teaser is a short summary or preview designed to pique the reader's interest by highlighting the main points or most exciting aspects of an article.

Field	Type	Description
url ⚠️	String	Teaser URL ⚠️ DEPRECATED Use field 'link' instead
link	Link	Teaser Link
date	DateTime	Teaser date
headline	String	Teaser headline
text	String	Teaser text
kicker	String	Teaser kicker text
asset	Asset	Teaser asset can be e.g. pictures or videos
variant	String	The asset variant is used to decide which image format is to be returned.
symbolicAsset	Asset	symbolic asset associated with the teaser
variant	String	The asset variant is used to decide which image format is to be returned.
features	[TeaserFeature!]!	additional, context dependent teaser features indicating information about the underling resource

AuthenticationResult#

Field	Argument	Type	Description
status		AuthenticationStatus!
user		User!

CopyrightDetails#

Field	Argument	Type	Description
original		Link
author		Link
license		Link

EmailAlreadyExistsError#

Field	Argument	Type	Description
email		String!

EventTeaser#

Event teaser

Field	Type	Description
url ⚠️	String	Teaser URL ⚠️ DEPRECATED Use field 'link' instead
link	Link	Teaser Link
headline	String	Teaser headline
text	String	Teaser text
kicker	String	Teaser kicker text
asset	Asset	Teaser asset can be e.g. pictures or videos
variant	String!	The teaser variant is used to decide which image format is to be returned.
symbolicAsset	Asset	symbolic asset associated with the teaser
variant	String	The asset variant is used to decide which image format is to be returned.
schedulings	[Scheduling!]!	schedulings
iCalUrl	String	Downlaod url for the event scheduling as an .ics file

Field	Argument	Type	Description
key		String!
hits		Int!

FacetGroup#

Field	Argument	Type	Description
key		String!
facets		[Facet!]!

FinishRegistrationResult#

Field	Argument	Type	Description
id		ID!
email		String!

GenAiAnswer#

The answer of the GenAI application to a question.

Field	Type	Description
id	ID	Id of the answer; null if it was not stored.
feedbackToken	String	Token to give feedback on the answer with genAiAnswerFeedback, valid for 15 minutes by default; null if the answer cannot be rated.
sections	[GenAiAnswerSection!]!	The parts of the answer.
duration	Float!	Runtime of the request in seconds.

GenAiAnswerCutOffError#

The model reached the maximum number of tokens of the channel (answer.maxTokens, finish reason LENGTH or MODEL_LENGTH). The incomplete answer is discarded.

Field	Type	Description
id	ID	Id of the stored error; null if it was not stored.
feedbackToken	String	Token to give feedback on the error with genAiAnswerFeedback, valid for 15 minutes by default; null if it cannot be rated.
duration	Float!	Runtime of the request in seconds.

GenAiAnswerLink#

Field	Argument	Type	Description
url		String!
label		String!	The text to link with, empty if the source offers none.

GenAiAnswerSource#

A resource the content of a section comes from.

Field	Argument	Type	Description
url		String!
title		String!

GenAiLinksSection#

A list of links of an answer, each with a label.

Field	Type	Description
headline	String!
links	[GenAiAnswerLink!]!
sources	[GenAiAnswerSource!]!	The resources the content comes from, empty if it comes from none in particular.

GenAiNoDocumentsError#

The search found no chunk in the channel, restricted to the categoryIds. The similarity search found none with a similarity of at least answer.similarityThreshold, and the full text search found none with words of the question and a similarity of at least answer.fullTextSimilarityThreshold, if the channel uses it (answer.fullTextTopK > 0). The model was not asked.

Field	Type	Description
id	ID	Id of the stored error; null if it was not stored.
feedbackToken	String	Token to give feedback on the error with genAiAnswerFeedback, valid for 15 minutes by default; null if it cannot be rated.
duration	Float!	Runtime of the request in seconds.

GenAiNoMatchingDocumentsError#

The model was given chunks as context, but according to the model none of them answers the question. It returns hints and suggested questions, both possibly empty.

Field	Type	Description
id	ID	Id of the stored error; null if it was not stored.
feedbackToken	String	Token to give feedback on the error with genAiAnswerFeedback, valid for 15 minutes by default; null if it cannot be rated.
duration	Float!	Runtime of the request in seconds.
hints	[GenAiTextSection!]!	How to ask more precisely, possibly none.
suggestedQuestions	[String!]!	Questions the user probably meant, at most three, to be offered for asking with one click.

GenAiTextSection#

Prose, lists or tables of an answer, delivered as HTML.

Field	Type	Description
headline	String!
html	String!
sources	[GenAiAnswerSource!]!	The resources the content comes from, empty if it comes from none in particular.

GenAiUnansweredError#

An error of the GenAI application this version of the bundle does not know yet. The question was not answered.

Field	Type	Description
id	ID	Id of the stored error; null if it was not stored.
feedbackToken	String	Token to give feedback on the error with genAiAnswerFeedback, valid for 15 minutes by default; null if it cannot be rated.
duration	Float!	Runtime of the request in seconds.

Geo#

Field	Argument	Type	Description
primary		GeoPoint
secondary		GeoJson
distance		Float

GeoPoint#

Field	Argument	Type	Description
lng		Float!
lat		Float!

Hierarchy#

Field	Argument	Type	Description
root		Resource!
primaryParent		Resource
primaryPath		[Resource!]
children		[Resource!]

Image#

Field	Type	Description
copyright	String
copyrightDetails	CopyrightDetails
caption	String
description	String
alternativeText	String
original	ImageSource!
characteristic	ImageCharacteristic
sources	[ImageSource!]!
static ⚠️	ImageSource!	⚠️ DEPRECATED 'static' might be a reserved keyword. Use field 'staticImage' instead
staticImage	ImageSource!

ImageSource#

Field	Argument	Type	Description
variant		String!
url		String!
width		Int!
height		Int!
mediaQuery		String

IndexerStatus#

Field	Argument	Type	Description
startTime		DateTime
endTime		DateTime
lastUpdate		DateTime
total		Int
processed		Int
skipped		Int
updated		Int
errors		Int
statusLine		String

Link#

Field	Argument	Type	Description
url		String!
label		String
accessibilityLabel		String
description		String
opensNewWindow		Boolean!
isExternal		Boolean!

MediaTeaser#

Field	Type	Description
url ⚠️	String	Teaser URL ⚠️ DEPRECATED Use field 'link' instead
link	Link	Teaser Link
headline	String
text	String
kicker	String
contentType	String!
contentLength	Int!
asset	Asset	Teaser asset can be e.g. pictures or videos
variant	String!	The asset variant is used to decide which image format is to be returned.
symbolicAsset	Asset	symbolic asset associated with the teaser
variant	String	The asset variant is used to decide which image format is to be returned.
features	[TeaserFeature!]!	additional, context dependent teaser features indicating information about the underling resource

NewsTeaser#

An news teaser is a short summary or preview designed to pique the reader's interest by highlighting the main points or most exciting aspects of an article.

Field	Type	Description
url ⚠️	String	Teaser URL ⚠️ DEPRECATED Use field 'link' instead
link	Link	Teaser Link
date	DateTime	News Teaser date
headline	String	News Teaser headline
text	String	News Teaser text
kicker	String	Teaser kicker text
asset	Asset	Teaser asset can be e.g. pictures or videos
variant	String!	The teaser variant is used to decide which image format is to be returned.
symbolicAsset	Asset	symbolic asset associated with the teaser
variant	String	The asset variant is used to decide which image format is to be returned.
features	[TeaserFeature!]!	additional, context dependent teaser features indicating information about the underling resource

OnlineService#

Field	Argument	Type	Description
link		Link!

OnlineServiceFeature#

Field	Argument	Type	Description
label		String
onlineServices		[OnlineService!]!

Resource#

Field	Argument	Type	Description
id		ID!
name		String!
location		String!
objectType		String!
contentSectionTypes		[String!]
teaser		Teaser!
navigation		Hierarchy!
kicker		String
date		DateTime
geo		Geo
asset		Asset
variant		String
symbolicAsset		Asset
variant		String
explain		ResultExplain

ResultExplain#

Field	Argument	Type	Description
score		Float
type		String
field		String
description		String
details		[ResultExplain!]

Scheduling#

Field	Argument	Type	Description
start		DateTime!
end		DateTime
rRule		String
isFullDay		Boolean!
hasStartTime		Boolean!
hasEndTime		Boolean!

SearchResult#

Field	Argument	Type	Description
total		Int!
queryTime		Int!
offset		Int!
limit		Int!
results		[Resource!]!
facetGroups		[FacetGroup!]!
spellcheck		Spellcheck

Spellcheck#

Field	Argument	Type	Description
suggestions		[SpellcheckSuggestion!]!
collation		String!

SpellcheckSuggestion#

Field	Argument	Type	Description
original		SpellcheckWord!
suggestion		SpellcheckWord!

SpellcheckWord#

Field	Argument	Type	Description
word		String!
frequency		Int!

StartPasswordRecoveryResult#

Field	Argument	Type	Description
challengeId		String!
createAt		DateTime!
expiresAt		DateTime!

StartRegistrationResult#

Field	Argument	Type	Description
challengeId		String!
createAt		DateTime!
expiresAt		DateTime!

SuggestResult#

Field	Argument	Type	Description
suggestions		[Suggestion!]!
queryTime		Int!

Suggestion#

Field	Argument	Type	Description
term		String!
hits		Int!

Svg#

Field	Argument	Type	Description
copyright		String
copyrightDetails		CopyrightDetails
caption		String
description		String
url		String

User#

Field	Argument	Type	Description
id		ID!
username		String!
firstName		String
lastName		String!
email		String
roles		[String!]!

Inputs#

AbsoluteDateRangeInputFacet#

Field		Type	Description
from		DateTime!
to		DateTime!
gap		DateInterval

AbsoluteDateRangeInputFilter#

Field		Type	Description
from		DateTime
to		DateTime

CitygovPerson#

Field		Type	Description
firstname		String
lastname		String
product		String
function		String
organisation		String
address		String
phonenumber		String

CitygovPersonCompetence#

Field		Type	Description
prefix		String
tin		String
file		String
licensePlateLetter		String
licensePlateRegion		String
licensePlateNumber		String

FinishPasswordRecoveryInput#

Field		Type	Description
configName		String!
lang		String!
challengeId		String!
code		Int!
newPassword		String!

FinishRegistrationInput#

Field		Type	Description
configName		String!
lang		String!
challengeId		String!
code		Int!
firstName		String
lastName		String!
password		String!

InputBoosting#

Field		Type	Description
queryFields		[String!]
phraseFields		[String!]
boostQueries		[String!]
boostFunctions		[String!]
tie		Float

InputFacet#

Field		Type	Description
key		String!
excludeFilter		[String!]
objectTypes		[String!]
contentSectionTypes		[String!]
categories		[String!]
sites		[String!]
sources		[String!]
contentTypes		[String!]
groups		[String!]
absoluteDateRange		AbsoluteDateRangeInputFacet
relativeDateRange		RelativeDateRangeInputFacet
spatialDistanceRange		SpatialDistanceRangeInputFacet
query		String
queryTemplate		QueryTemplateInput

InputFilter#

Field		Type	Description
key		String
ids		[String!]
objectTypes		[String!]
contentSectionTypes		[String!]
teaserProperty		TeaserPropertyInputFilter
categories		[String!]
sites		[String!]
sources		[String!]
contentTypes		[String!]
groups		[String!]
absoluteDateRange		AbsoluteDateRangeInputFilter
relativeDateRange		RelativeDateRangeInputFilter
geoLocated		Boolean
spatialOrbital		SpatialOrbitalInputFilter
spatialArbitraryRectangle		SpatialArbitraryRectangleInputFilter
and		[InputFilter!]
or		[InputFilter!]
not		InputFilter
query		String
queryTemplate		QueryTemplateInput

InputGeoPoint#

Field		Type	Description
lng		Float!
lat		Float!

InputSortCriteria#

Field		Type	Description
name		SortDirection
date		SortDirection
natural		SortDirection
score		SortDirection
spatialDist		InputSortCriteriaSpatialDist
custom		InputSortCriteriaCustom

InputSortCriteriaCustom#

Field		Type	Description
field		String!
direction		SortDirection!

InputSortCriteriaSpatialDist#

Field		Type	Description
spatialPoint		InputGeoPoint!
direction		SortDirection!

MoreLikeThisInput#

Field		Type	Description
id		String!
context		SearchContextInput
lang		String
filter		[InputFilter!]
limit		Int
archive		Boolean

QueryTemplateInput#

Field		Type	Description
query		String!
variables		Json!

RelativeDateRangeInputFacet#

Field	Type	Description
base	DateTime	Defaults to the current datetime if null
baseOffset	SignedDateInterval
before	DateInterval	Sets the lower date boundary. Implicitly directed toward the past.
after	DateInterval	Sets the upper date boundary. Implicitly directed toward the future.
from	SignedDateInterval	Sets the lower date boundary
to	SignedDateInterval	Sets the upper date boundary
gap	DateInterval
roundStart	DateRangeRound
roundEnd	DateRangeRound

RelativeDateRangeInputFilter#

Field	Type	Description
base	DateTime	Defaults to the current datetime if null
baseOffset	SignedDateInterval
before	DateInterval	Sets the lower date boundary. Implicitly directed toward the past.
after	DateInterval	Sets the upper date boundary. Implicitly directed toward the future.
from	SignedDateInterval	Sets the lower date boundary
to	SignedDateInterval	Sets the upper date boundary
roundStart	DateRangeRound
roundEnd	DateRangeRound

SearchCitygovPersonInput#

Field		Type	Description
person		CitygovPerson
personCompetence		CitygovPersonCompetence
offset		Int
limit		Int
lang		String
sort		[InputSortCriteria!]

SearchContextInput#

Field		Type	Description
urlBasePath		String
resourceLocation		String
options		SearchContextOptionsInput

SearchContextOptionsInput#

Field		Type	Description
sameNavigation		Boolean

SearchInput#

Field		Type	Description
text		String
offset		Int
limit		Int
lang		String
context		SearchContextInput
defaultQueryOperator		QueryOperator
sort		[InputSortCriteria!]
filter		[InputFilter!]
facets		[InputFacet!]
spellcheck		Boolean
archive		Boolean
timeZone		DateTimeZone
boosting		InputBoosting
distanceReferencePoint		InputGeoPoint
explain		Boolean

SpatialArbitraryRectangleInputFilter#

Field		Type	Description
lowerLeftCorner		InputGeoPoint!
upperRightCorner		InputGeoPoint!

SpatialDistanceRangeInputFacet#

Field		Type	Description
point		InputGeoPoint!
from		Float!
to		Float!

SpatialOrbitalInputFilter#

Field		Type	Description
distance		Float!
centerPoint		InputGeoPoint!
mode		SpatialOrbitalMode

StartPasswordRecoveryInput#

Field		Type	Description
configName		String!
username		String!
lang		String!

StartRegistrationInput#

Field		Type	Description
configName		String!
emailAddress		String!
lang		String!

SuggestCitygovPersonInput#

Field		Type	Description
person		CitygovPerson
personCompetence		CitygovPersonCompetence
limit		Int
lang		String

SuggestInput#

Field		Type	Description
text		String!
limit		Int
lang		String
filter		[InputFilter!]
archive		Boolean
minHitCount		Int

TeaserPropertyInputFilter#

Field		Type	Description
image		Boolean
imageCopyright		Boolean
headline		Boolean
text		Boolean

Enums#

AuthenticationStatus#

Value	Description
SUCCESS
PARTIAL
FAILURE

CitygovPersonField#

Value	Description
FIRSTNAME
LASTNAME
PRODUCT
FUNCTION
ORGANISATION
ADDRESS
PHONENUMBER

DateRangeRound#

Value	Description
START_OF_DAY
START_OF_PREVIOUS_DAY
END_OF_DAY
END_OF_PREVIOUS_DAY
START_OF_MONTH
START_OF_PREVIOUS_MONTH
END_OF_MONTH
END_OF_PREVIOUS_MONTH
START_OF_YEAR
START_OF_PREVIOUS_YEAR
END_OF_YEAR
END_OF_PREVIOUS_YEAR

GenAiAnswerFeedback#

Value	Description
GOOD
BAD

ImageCharacteristic#

Value	Description
NORMAL
INFOGRAPHIC
DECORATIVE_IMAGE
DECORATIVE_IMAGE_NOT_CUT

QueryOperator#

Value	Description
AND
OR

SortDirection#

Value	Description
ASC
DESC

SpatialOrbitalMode#

Value	Description
GREAT_CIRCLE_DISTANCE
BOUNDING_BOX

Scalars#

Boolean#

The Boolean scalar type represents true or false.

DateInterval#

The scalar type DateInterval represents a date interval duration string. It is specified in ISO-8601 format (e.g. P3Y6M4DT12H30M5S).

DateTime#

The scalar type DateTime represents a date and time string. It is specified with the UTC time zone in ISO-8601 format (e.g. 2024-05-22T10:13:00Z).

DateTimeZone#

The scalar type DateTimeZone represents a timezone string. It is specified in the IANA timezone database format (e.g. America/New_York).

Float#

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

GeoJson#

ID#

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int#

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Json#

SignedDateInterval#

The scalar type SignedDateInterval represents a date interval duration string that additionally allows for a leading minus sign (as specified in ISO 8601-2:2019).

String#

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Interfaces#

Asset#

Field	Argument	Type	Description
copyright		String
copyrightDetails		CopyrightDetails
caption		String
description		String

Possible Types: Image, Svg

GenAiAnswerSection#

One part of an answer: a GenAiTextSection or a GenAiLinksSection.

Field	Argument	Type	Description
headline		String!
sources		[GenAiAnswerSource!]!	The resources the content comes from, empty if it comes from none in particular.

Possible Types: GenAiTextSection, GenAiLinksSection

GenAiAnsweredQuestion#

What every result of a question carries. Every result is stored and can be rated, an error as well as an answer; only an answer is cached.

Field	Type	Description
id	ID	Id of the result; null if it was not stored.
feedbackToken	String	Token to give feedback on the result with genAiAnswerFeedback, valid for 15 minutes by default; null if it cannot be rated.
duration	Float!	Runtime of the request in seconds.

Possible Types: GenAiAnswer, GenAiNoDocumentsError, GenAiNoMatchingDocumentsError, GenAiAnswerCutOffError, GenAiUnansweredError

Teaser#

Field

Argument

Type

Description

url ⚠️

String

Teaser URL

⚠️ DEPRECATED

Use field 'link' instead

link

Link

Teaser Link

Possible Types: ArticleTeaser, MediaTeaser, NewsTeaser, EventTeaser

TeaserFeature#

Field	Argument	Type	Description
label		String

Possible Types: OnlineServiceFeature

Unions#

FinishUserRegistrationResultType#

FinishRegistrationResult and EmailAlreadyExistsError

Type	Description
FinishRegistrationResult
EmailAlreadyExistsError

GenAiQuestionResult#

The result of a question: an answer, or an error that says why the question was not answered. Further errors of the GenAI application are a GenAiUnansweredError.

Type	Description
GenAiAnswer	The answer of the GenAI application to a question.
GenAiNoDocumentsError	The search found no chunk in the channel, restricted to the categoryIds. The similarity search found none with a similarity of at least answer.similarityThreshold, and the full text search found none with words of the question and a similarity of at least answer.fullTextSimilarityThreshold, if the channel uses it (answer.fullTextTopK > 0). The model was not asked.
GenAiNoMatchingDocumentsError	The model was given chunks as context, but according to the model none of them answers the question. It returns hints and suggested questions, both possibly empty.
GenAiAnswerCutOffError	The model reached the maximum number of tokens of the channel (answer.maxTokens, finish reason LENGTH or MODEL_LENGTH). The incomplete answer is discarded.
GenAiUnansweredError	An error of the GenAI application this version of the bundle does not know yet. The question was not answered.