Skip to content

Schema Types#

Query (RootQuery)#

Field Argument Type Description
indexerStatus IndexerStatus!
suggest SuggestResult!
input SuggestInput!
ping String!
search SearchResult!
input SearchInput!
moreLikeThis SearchResult!
input MoreLikeThisInput!

Mutation (RootMutation)#

Field Argument 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!

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 Argument 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.
actions [Link!]! additional, context dependent links

CopyrightDetails#

Field Argument Type Description
original Link
author Link
license Link

EventTeaser#

Event teaser

Field Argument 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

Facet#

Field Argument Type Description
key String!
hits Int!

FacetGroup#

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

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 Argument Type Description
copyright String
copyrightDetails CopyrightDetails
caption String
description String
alternativeText String
original ImageSource!
characteristic ImageCharacteristic
sources [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
Field Argument Type Description
url String!
label String
accessibilityLabel String
description String
opensNewWindow Boolean!
isExternal Boolean!

MediaTeaser#

Field Argument 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.
actions [Link!]! additional, context dependent links

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 Argument 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.
actions [Link!]! additional, context dependent links

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!

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

Inputs#

AbsoluteDateRangeInputFacet#

Field Type Description
from DateTime!
to DateTime!
gap DateInterval

AbsoluteDateRangeInputFilter#

Field Type Description
from DateTime
to DateTime

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

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

InputGeoPoint#

Field Type Description
lng Float!
lat Float!

InputSortCriteria#

Field Type Description
name SortDirection
date SortDirection
natural SortDirection
score SortDirection
spatialDist SortDirection
spatialPoint InputGeoPoint

MoreLikeThisInput#

Field Type Description
id String!
lang String
filter [InputFilter!]
limit Int

RelativeDateRangeInputFacet#

Field Type Description
base DateTime
before DateInterval
after DateInterval
gap DateInterval
roundStart DateRangeRound
roundEnd DateRangeRound

RelativeDateRangeInputFilter#

Field Type Description
base DateTime
before DateInterval
after DateInterval
roundStart DateRangeRound
roundEnd DateRangeRound

SearchInput#

Field Type Description
text String
offset Int
limit Int
lang String
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

SuggestInput#

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

TeaserPropertyInputFilter#

Field Type Description
image Boolean
imageCopyright Boolean
headline Boolean
text Boolean

Enums#

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

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#

DateTime#

DateTimeZone#

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.

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

Teaser#

Field Argument Type Description
url ⚠️ String Teaser URL

⚠️ DEPRECATED

Use field 'link' instead
link Link Teaser Link

Possible Types: ArticleTeaser, MediaTeaser, NewsTeaser, EventTeaser