GraphQL Docs

Root query

The query root for the GraphQL Public Content API.

Fields

binaryComponent(namespaceId: Int, publicationId: Int, binaryId: Int, url: String, cmUri: String, contextData: [InputClaimValue]): BinaryComponent

Returns the binary component given its CM_URI (takes precedence over the other arguments).ONLY if CM_URI is not specified, the binary is identified by its namespaceId, publicationId and binaryId. Alternatively a binary variant URL can be used instead of a binary ID.

Arguments
namespaceId: Int	the namespace ID
publicationId: Int	the publication ID
binaryId: Int	the binary ID
url: String	the binary variant relative URL
cmUri: String	the binary CM URI
contextData: [InputClaimValue]	the context data

binaryLink(namespaceId: Int!, publicationId: Int!, binaryId: Int!, variantId: String, renderRelativeLink: Boolean): Link

Resolve a link by parameters.

Arguments
namespaceId: Int!	the namespace ID
publicationId: Int!	the publication ID
binaryId: Int!	the binary id
variantId: String	the binary variant id for binary link
renderRelativeLink: Boolean	whether to render relative link (true by default)

categories(after: String, first: Int, namespaceId: Int!, publicationId: Int!, contextData: [InputClaimValue]): KeywordConnection

Returns the categories for the given namespace and publication IDs.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
namespaceId: Int!	the namespace ID
publicationId: Int!	the publication ID
contextData: [InputClaimValue]	the context data

component(namespaceId: Int!, publicationId: Int!, componentId: Int!, contextData: [InputClaimValue]): Component

Returns the component given the namespace, publication, component IDs.

Arguments
namespaceId: Int!	the namespace ID
publicationId: Int!	the publication ID
componentId: Int!	the component ID
contextData: [InputClaimValue]	the context data

componentLink(namespaceId: Int!, publicationId: Int!, sourcePageId: Int, targetComponentId: Int!, excludeComponentTemplateId: Int, renderRelativeLink: Boolean): Link

Resolve a link by parameters.

Arguments
namespaceId: Int!	the namespace ID
publicationId: Int!	the publication ID
sourcePageId: Int	the id of the page you want to receive a link from
targetComponentId: Int!	the id of the component you want to link to
excludeComponentTemplateId: Int	the id of the template to exclude from linking
renderRelativeLink: Boolean	whether to render relative link (true by default)

componentPresentation(namespaceId: Int!, publicationId: Int!, componentId: Int!, templateId: Int!, contextData: [InputClaimValue]): ComponentPresentation

Returns the component presentation given the namespace, publication, component and template IDs.

Arguments
namespaceId: Int!	the namespace ID
publicationId: Int!	the publication ID
componentId: Int!	the component ID
templateId: Int!	the template ID
contextData: [InputClaimValue]	the context data

componentPresentations(after: String, first: Int, namespaceId: Int!, publicationId: Int!, filter: InputComponentPresentationFilter!, contextData: [InputClaimValue], sort: InputSortParam): ComponentPresentationConnection

Get a list of component presentations filtered by set of criteria.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
namespaceId: Int!	the namespace ID
publicationId: Int!	the publication ID
filter: InputComponentPresentationFilter!	Component Presentation Filter
contextData: [InputClaimValue]	the context data
sort: InputSortParam	item sorting

dynamicComponentLink(namespaceId: Int!, publicationId: Int!, targetPageId: Int!, targetComponentId: Int!, targetTemplateId: Int!, renderRelativeLink: Boolean): Link

Resolve a link by parameters.

Arguments
namespaceId: Int!	the namespace ID
publicationId: Int!	the publication ID
targetPageId: Int!	the target page id
targetComponentId: Int!	the id of the component you want to link to
targetTemplateId: Int!	the target template id
renderRelativeLink: Boolean	whether to render relative link (true by default)

items(after: String, first: Int, filter: InputItemFilter!, contextData: [InputClaimValue], sort: InputSortParam): ItemConnection

Get a list of items filtered by set of criteria.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
filter: InputItemFilter!	Item Filter
contextData: [InputClaimValue]	the context data
sort: InputSortParam	item sorting

keyword(namespaceId: Int!, publicationId: Int!, categoryId: Int!, keywordId: Int!, contextData: [InputClaimValue]): Keyword

Returns the keyword for the given namespace, publication, category and keyword IDs.

Arguments
namespaceId: Int!	the namespace ID
publicationId: Int!	the publication ID
categoryId: Int!	the category ID
keywordId: Int!	the keyword ID
contextData: [InputClaimValue]	the context data

page(namespaceId: Int, publicationId: Int, pageId: Int, url: String, cmUri: String, contextData: [InputClaimValue]): Page

Returns the page given its CM_URI. Takes precedence over the other arguments.ONLY If CM_URI is not specified, the page is identified by its namespaceId, publicationId and pageId. Alternatively a page URL can be used instead of a page ID.

Arguments
namespaceId: Int	the namespace ID
publicationId: Int	the publication ID
pageId: Int	the page ID
url: String	the page URL path
cmUri: String	the page CM URI
contextData: [InputClaimValue]	the context data

pageLink(namespaceId: Int!, publicationId: Int!, pageId: Int!, renderRelativeLink: Boolean): Link

Resolve a link by parameters.

Arguments
namespaceId: Int!	the namespace ID
publicationId: Int!	the publication ID
pageId: Int!	the page id for page link
renderRelativeLink: Boolean	whether to render relative link (true by default)

pages(after: String, first: Int, namespaceId: Int!, url: String!, contextData: [InputClaimValue]): PageConnection

Returns the list of pages matching the provided namespace ID and page URL.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
namespaceId: Int!	the namespace ID
url: String!	the page URL
contextData: [InputClaimValue]	the context data

publication(namespaceId: Int!, publicationId: Int!, contextData: [InputClaimValue]): Publication

Returns the publication given the specified namespace and publication IDs.

Arguments
namespaceId: Int!	the namespace ID
publicationId: Int!	the publication ID
contextData: [InputClaimValue]	the context data

publicationMapping(namespaceId: Int!, siteUrl: String!): PublicationMapping

Returns the publication mapping given the specified namespace and site URL.

Arguments
namespaceId: Int!	the namespace ID
siteUrl: String!	site URL

publications(after: String, first: Int, namespaceId: Int!, filter: InputPublicationFilter, contextData: [InputClaimValue]): PublicationConnection

Returns the list of publications given the namespace ID and an optional filter.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
namespaceId: Int!	the namespace ID
filter: InputPublicationFilter	the publications filter
contextData: [InputClaimValue]	the context data

sitemap(namespaceId: Int!, publicationId: Int!, navigationMarker: String, categoryId: Int, contextData: [InputClaimValue]): TaxonomySitemapItem

Get navigation site map.

Arguments
namespaceId: Int!	the namespace ID
publicationId: Int!	the publication ID
navigationMarker: String	the navigation marker used on category names
categoryId: Int	the category ID used for navigation
contextData: [InputClaimValue]	the context data

sitemapSubtree(namespaceId: Int!, publicationId: Int, taxonomyNodeId: String, ancestor: Ancestor, excludePages: Boolean, contextData: [InputClaimValue]): [TaxonomySitemapItem]

Get navigation site map subtree.

Arguments
namespaceId: Int!	the namespace ID
publicationId: Int	the publication ID
taxonomyNodeId: String	the taxonomy node ID
ancestor: Ancestor	whether to include ancestor information
excludePages: Boolean	whether to exclude page types
contextData: [InputClaimValue]	the context data

structureGroup(namespaceId: Int!, publicationId: Int!, structureGroupId: Int!, contextData: [InputClaimValue]): StructureGroup

Returns the structure group for the given namespace, publication and structure group IDs.

Arguments
namespaceId: Int!	the namespace ID
publicationId: Int!	the publication ID
structureGroupId: Int!	the structure group ID
contextData: [InputClaimValue]	the context data

structureGroups(after: String, first: Int, namespaceId: Int!, publicationId: Int!, contextData: [InputClaimValue]): StructureGroupConnection

Returns the structure groups for the given namespace and publication IDs.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
namespaceId: Int!	the namespace ID
publicationId: Int!	the publication ID
contextData: [InputClaimValue]	the context data

typedComponent(namespaceId: Int!, publicationId: Int!, componentId: Int!, contextData: [InputClaimValue]): ContentComponent

Returns the typed component given the namespace, publication, component IDs.

Arguments
namespaceId: Int!	the namespace ID
publicationId: Int!	the publication ID
componentId: Int!	the component ID
contextData: [InputClaimValue]	the context data

typedPage(namespaceId: Int, publicationId: Int, pageId: Int, url: String, cmUri: String, contextData: [InputClaimValue]): PageItem

Returns the typed page given its CM_URI. Takes precedence over the other arguments.ONLY If CM_URI is not specified, the page is identified by its namespaceId, publicationId and pageId. Alternatively a page URL can be used instead of a page ID.

Arguments
namespaceId: Int	the namespace ID
publicationId: Int	the publication ID
pageId: Int	the page ID
url: String	the page URL path
cmUri: String	the page CM URI
contextData: [InputClaimValue]	the context data

searchByCriteria(after: String, first: Int, criteria: InputSearchCriteria!, resultFilter: InputResultFilter, sortBy: InputSortBy): SearchConnection

Search using a criteria.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
criteria: InputSearchCriteria!	Search criteria for searching the index
resultFilter: InputResultFilter	Filtering and highlighting the search results
sortBy: InputSortBy	Sorting the search results

searchByField(after: String, first: Int, field: String!, strict: Boolean = false, value: String!, resultFilter: InputResultFilter, sortBy: InputSortBy): SearchConnection

Search using field name and value.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
field: String!	Field name for searching the index
strict: Boolean	Parameter to enable strict search
value: String!	Field value for searching the index
resultFilter: InputResultFilter	Filtering and highlighting the search results
sortBy: InputSortBy	Sorting the search results

searchById(identifier: String!): [Result]

Search using an identifier.

Arguments
identifier: String!	Identifier for searching the index

searchByRawQuery(after: String, first: Int, rawQuery: String!, resultFilter: InputResultFilter): SearchConnection

Search using a raw query.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
rawQuery: String!	Raw query for searching the index
resultFilter: InputResultFilter	Filtering the result

search(criteria: InputCriteria, rawCriteria: String, resultFilter: InputResultFilter, sortBy: InputSortBy, facets: InputFacets): FacetedSearchResults

Faceted search using a criteria.

Arguments
criteria: InputCriteria	Search criteria for searching the index.
rawCriteria: String	Search DSL output of SearchQuery builder.
resultFilter: InputResultFilter	Filtering and highlighting the search results.
sortBy: InputSortBy	Sorting the search results.
facets: InputFacets	Configure facets to include in the result set.

suggest(after: String, first: Int, connectorId: String, label: String!, language: String, fuzzy: Boolean, used: Boolean): ConceptSuggestionConnection

Suggest

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
connectorId: String	Connector Id.
label: String!	Partial label.
language: String	Language.
fuzzy: Boolean	Enable fuzziness.
used: Boolean	Filter results to match facets used within your content, avoiding dead ends.

taxonomy(connectorId: String, title: String, conceptIds: [String], language: String): [ConceptScheme]

Taxonomy search.

Arguments
connectorId: String	Connector Id.
title: String	Concept scheme title.
conceptIds: [String]	Concept Ids to search for within the concept scheme(s).
language: String	Concept scheme language.

BinaryComponent

Represents a component which has binary content.

Implements

ContentComponent
Item

Fields

creationDate: String

Returns the date the item was created.

customMetas(after: String, first: Int, filter: String): CustomMetaConnection

Returns the custom meta data for the item.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
filter: String	the custom meta filter (optional)

customMetasStructure(filter: String): UntypedContent

Returns the custom meta data structure for the item. Can be used to group related fields together.

Arguments
filter: String	the custom meta filter (optional)

id: ID

Identifies the unique ID of the node.

initialPublishDate: String

Returns the date the item was initially published.

itemId: Int!

Identifies the item ID.

itemType: Int

Returns the item type of the item.

lastPublishDate: String

Returns the date the item was most recently published.

namespaceId: Int!

Identifies the namespace ID of the item.

owningPublicationId: Int

Returns the publication ID of the publication to which this item belongs.

publicationId: Int!

Identifies the publication ID of the item.

schemaId: Int

Returns the schema ID for the component.

taxonomies(types: [TaxonomyType]): [TaxonomyItem]

Returns the list of taxonomies for the item.

Arguments
types: [TaxonomyType]	the list of taxonomy types to include in the result set

title: String

Returns the title of the item.

type: String!

Identifies the type of the binary component.

updatedDate: String

Returns the date the item was updated.

variants(after: String, first: Int, variant: String, url: String): BinaryVariantConnection

Returns the variants of the binary component.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
variant: String	the specific variant to return (optional)
url: String	the specific variant URL

multiMedia: Boolean

Returns true if the component is a multimedia (binary) component.

InputClaimValue

Represents an Ambient Data Framework claim value.

Arguments
type: ClaimValueType!	The claim value type.
uri: String!	The claim URI.
value: String!	The claim Value.

Link

Represents a Link.

Fields

itemId: Int!

Identifies the item ID.

namespaceId: Int!

Identifies the namespace ID of the item.

publicationId: Int!

Identifies the publication ID of the item.

type: LinkType

Link type.

url: String

Link url.

KeywordConnection

A connection to a list of items.

Fields

edges: [KeywordEdge]

a list of edges

Component

Represents a regular component.

Implements

ContentComponent
Item

Fields

content(renderContent: Boolean): Content

Returns the content of the component.

Arguments
renderContent: Boolean	whether to render dynamic content tags

creationDate: String

Returns the date the item was created.

customMetas(after: String, first: Int, filter: String): CustomMetaConnection

Returns the custom meta data for the item.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
filter: String	the custom meta filter (optional)

customMetasStructure(filter: String): UntypedContent

Returns the custom meta data structure for the item. Can be used to group related fields together.

Arguments
filter: String	the custom meta filter (optional)

id: ID

Identifies the unique ID of the node.

initialPublishDate: String

Returns the date the item was initially published.

itemId: Int!

Identifies the item ID.

itemType: Int

Returns the item type of the item.

lastPublishDate: String

Returns the date the item was most recently published.

namespaceId: Int!

Identifies the namespace ID of the item.

owningPublicationId: Int

Returns the publication ID of the publication to which this item belongs.

publicationId: Int!

Identifies the publication ID of the item.

schemaId: Int

Returns the schema ID for the component.

taxonomies(types: [TaxonomyType]): [TaxonomyItem]

Returns the list of taxonomies for the item.

Arguments
types: [TaxonomyType]	the list of taxonomy types to include in the result set

title: String

Returns the title of the item.

updatedDate: String

Returns the date the item was updated.

multiMedia: Boolean

Returns true if the component is a multimedia (binary) component.

ComponentPresentation

Represents a component presentation which has a component associated with a template.

Implements

ContentFragment
Item

Fields

component: ContentComponent

Returns the component of the component presentation.

componentTemplate: Template

Returns the component template of the component presentation.

content: Content

Returns the content of this fragment.

creationDate: String

Returns the date the item was created.

customMetas(after: String, first: Int, filter: String): CustomMetaConnection

Returns the custom meta data for the item.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
filter: String	the custom meta filter (optional)

customMetasStructure(filter: String): UntypedContent

Returns the custom meta data structure for the item. Can be used to group related fields together.

Arguments
filter: String	the custom meta filter (optional)

id: ID

Identifies the unique ID of the node.

initialPublishDate: String

Returns the date the item was initially published.

itemId: Int!

Identifies the item ID.

itemType: Int

Returns the item type of the item.

lastPublishDate: String

Returns the date the item was most recently published.

namespaceId: Int!

Identifies the namespace ID of the item.

owningPublicationId: Int

Returns the publication ID of the publication to which this item belongs.

publicationId: Int!

Identifies the publication ID of the item.

rawContent(renderContent: Boolean): RawContent

Returns the raw content of the component presentation.

Arguments
renderContent: Boolean	whether to render dynamic content tags

title: String

Returns the title of the item.

updatedDate: String

Returns the date the item was updated.

ComponentPresentationConnection

A connection to a list of items.

Fields

edges: [ComponentPresentationEdge]

a list of edges

InputComponentPresentationFilter

Filter for the componentPresentation root query. When the filter is applied, only the component presentations matching the filter will be in the query result

Arguments
and: [InputComponentPresentationFilter]	List of filters. Items in the query result will match ALL of the elements of the list
or: [InputComponentPresentationFilter]	List of filters. Items in the query result will match ANY of the elements of the list

InputSortParam

Represents a typical sort type. When used, the default sorting mechanism (by namespace and by id) is overridden

Arguments
key: String	The custom meta key used for sorting. Mandatory only for SortOrderType.CUSTOM_META sort type.
keyType: MetadataType	The custom meta key type used for sorting
order: SortOrderType!	The sort order type.
sortBy: SortFieldType!	The item field used for sorting

ItemConnection

A connection to a list of items.

Fields

edges: [ItemEdge]

a list of edges

InputItemFilter

Item filter for the items root query. When the filter is applied, only the items matching the filter will be in the query result

Arguments
and: [InputItemFilter]	List of filters. Items in the query result will match ALL of the elements of the list
itemTypes: [FilterItemType]	list of item types to be selected
namespaceIds: [Int]	list of namespace IDs
or: [InputItemFilter]	List of filters. Items in the query result will match ANY of the elements of the list
publicationIds: [Int]	list of publication IDs

Keyword

Represents a keyword taxonomy item.

Implements

TaxonomyItem
Item

Fields

children(after: String, first: Int): TaxonomyItemConnection

Returns the child taxonomies for the taxonomy.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.

creationDate: String

Returns the date the item was created.

customMetas(after: String, first: Int, filter: String): CustomMetaConnection

Returns the custom meta data for the item.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
filter: String	the custom meta filter (optional)

customMetasStructure(filter: String): UntypedContent

Returns the custom meta data structure for the item. Can be used to group related fields together.

Arguments
filter: String	the custom meta filter (optional)

depth: Int

Returns the depth (level) of the taxonomy.

description: String

Returns the description of the keyword.

id: ID

Identifies the unique ID of the node.

initialPublishDate: String

Returns the date the item was initially published.

itemId: Int!

Identifies the item ID.

itemType: Int

Returns the item type of the item.

key: String

Returns the key of the taxonomy.

lastPublishDate: String

Returns the date the item was most recently published.

Returns the name of the keyword.

namespaceId: Int!

Identifies the namespace ID of the item.

owningPublicationId: Int

Returns the publication ID of the publication to which this item belongs.

parent: TaxonomyItem

Returns the parent taxonomy of the taxonomy.

publicationId: Int!

Identifies the publication ID of the item.

taxonomyId: Int!

Identifies the ID of the taxonomy.

taxonomyType: TaxonomyType!

Identifies the type of the taxonomy.

title: String

Returns the title of the item.

totalRelatedItems: Int

Returns total number of related items.

updatedDate: String

Returns the date the item was updated.

hasChildren: Boolean

Returns true if the taxonomy has child taxonomies.

abstract: Boolean

Returns true if the taxonomy is abstract.

navigable: Boolean

Returns true if the taxonomy is navigable.

usedForIdentification: Boolean

Returns true if the keyword is used for identification.

Page

Represents a page.

Implements

PageItem
Container
Taggable
Item
PageRegion

Fields

components: [ContentComponent]

Returns the list of nested regions.

containerItems(types: [ContainerType]): [Item]

Returns the items in this container.

Arguments
types: [ContainerType]	the container types to include in the result set (optional)

content(renderContent: Boolean): Content

Returns the content in the page.

Arguments
renderContent: Boolean	whether to render dynamic content tags

creationDate: String

Returns the date the item was created.

customMetas(after: String, first: Int, filter: String): CustomMetaConnection

Returns the custom meta data for the item.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
filter: String	the custom meta filter (optional)

customMetasStructure(filter: String): UntypedContent

Returns the custom meta data structure for the item. Can be used to group related fields together.

Arguments
filter: String	the custom meta filter (optional)

fileName: String

Returns the file name path to the page.

id: ID

Identifies the unique ID of the node.

initialPublishDate: String

Returns the date the item was initially published.

itemId: Int!

Identifies the item ID.

itemType: Int

Returns the item type of the item.

lastPublishDate: String

Returns the date the item was most recently published.

Returns the name of the region.

namespaceId: Int!

Identifies the namespace ID of the item.

owningPublicationId: Int

Returns the publication ID of the publication to which this item belongs.

pageTemplate: Template

Returns the template for the page.

publicationId: Int!

Identifies the publication ID of the item.

rawContent(renderContent: Boolean): RawContent

Returns the raw content in the page.

Arguments
renderContent: Boolean	whether to render dynamic content tags

regions(filter: String): [PageRegion]

Returns the regions for the page.

Arguments
filter: String	the page region filter (optional)

taxonomies(types: [TaxonomyType]): [TaxonomyItem]

Returns the list of taxonomies for the item.

Arguments
types: [TaxonomyType]	the list of taxonomy types to include in the result set

title: String

Returns the title of the item.

updatedDate: String

Returns the date the item was updated.

url: String!

Identifies the URL of the page.

PageConnection

A connection to a list of items.

Fields

edges: [PageEdge]

a list of edges

Publication

Represents a publication.

Implements

Item

Fields

creationDate: String

Returns the date the item was created.

customMetas(after: String, first: Int, filter: String): CustomMetaConnection

Returns the custom meta data for the item.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
filter: String	the custom meta filter (optional)

customMetasStructure(filter: String): UntypedContent

Returns the custom meta data structure for the item. Can be used to group related fields together.

Arguments
filter: String	the custom meta filter (optional)

id: ID

Identifies the unique ID of the node.

initialPublishDate: String

Returns the date the item was initially published.

itemId: Int!

Identifies the item ID.

itemType: Int

Returns the item type of the item.

lastPublishDate: String

Returns the date the item was most recently published.

multimediaPath: String

Returns the multimedia path for the publication.

multimediaUrl: String

Returns the multimedia URL for the publication.

namespaceId: Int!

Identifies the namespace ID of the item.

owningPublicationId: Int

Returns the publication ID of the publication to which this item belongs.

publicationId: Int!

Identifies the publication ID of the item.

publicationKey: String

Returns the publication key.

publicationPath: String

Returns the publication path.

publicationUrl: String

Returns the publication URL.

title: String

Returns the title of the item.

updatedDate: String

Returns the date the item was updated.

PublicationMapping

Represents a publication mapping.

Fields

domain: String

Returns the domain.

namespaceId: Int!

Identifies the namespace ID of the item.

path: String

Returns the path.

pathScanDepth: Int

Returns the scan depth.

port: String

Returns the port.

protocol: String

Returns the protocol.

publicationId: Int!

Identifies the publication ID of the item.

PublicationConnection

A connection to a list of items.

Fields

edges: [PublicationEdge]

a list of edges

InputPublicationFilter

Represents a filter for a publication query.

Arguments
queryType: ContentFilterQueryType	Represents the query type for the filter.
value: String	Represents the value to filter by in the form of 'key=value' pair.
valueType: CustomMetaValueType	Represents the custom meta value type for the filter. UNKNOWN not supported. Defaults to 'String', if empty.

TaxonomySitemapItem

Implements

SitemapItem

Fields

classifiedItemsCount: Int

Classified Items Count

description: String

Description

id: ID

Identifies the unique ID of the node.

items: [SitemapItem]

Items

key: String

Key

originalTitle: String

Original title

publishedDate: String

The most recent date this item was published.

title: String

Title

type: String

Type

url: String

Url

abstract: Boolean

Is Abstract

hasChildNodes: Boolean

Has Child Nodes

visible: Boolean

Visible

Ancestor

Represents ancestor's behaviour of the sitemap subtree response.

Possible Enum Values

NONE	By default, do not return ancestors of the given taxonomy node.
INCLUDE	Returns path from the root ancestor to the given taxonomy node.
INCLUDE_ANCESTORS_WITH_SIBLINGS	Returns path from the root ancestor to the given taxonomy node and all siblings.

StructureGroup

Represents a structure group.

Implements

TaxonomyItem
Item

Fields

children(after: String, first: Int): TaxonomyItemConnection

Returns the child taxonomies for the taxonomy.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.

creationDate: String

Returns the date the item was created.

customMetas(after: String, first: Int, filter: String): CustomMetaConnection

Returns the custom meta data for the item.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
filter: String	the custom meta filter (optional)

customMetasStructure(filter: String): UntypedContent

Returns the custom meta data structure for the item. Can be used to group related fields together.

Arguments
filter: String	the custom meta filter (optional)

depth: Int

Returns the depth (level) of the taxonomy.

directory: String

Returns the directory of the structure group.

id: ID

Identifies the unique ID of the node.

initialPublishDate: String

Returns the date the item was initially published.

itemId: Int!

Identifies the item ID.

itemType: Int

Returns the item type of the item.

key: String

Returns the key of the taxonomy.

lastPublishDate: String

Returns the date the item was most recently published.

namespaceId: Int!

Identifies the namespace ID of the item.

owningPublicationId: Int

Returns the publication ID of the publication to which this item belongs.

parent: TaxonomyItem

Returns the parent taxonomy of the taxonomy.

publicationId: Int!

Identifies the publication ID of the item.

taxonomyId: Int!

Identifies the ID of the taxonomy.

taxonomyType: TaxonomyType!

Identifies the type of the taxonomy.

title: String

Returns the title of the structure group.

updatedDate: String

Returns the date the item was updated.

hasChildren: Boolean

Returns true if the taxonomy has child taxonomies.

abstract: Boolean

Returns true if the taxonomy is abstract.

navigable: Boolean

Returns true if the taxonomy is navigable.

StructureGroupConnection

A connection to a list of items.

Fields

edges: [StructureGroupEdge]

a list of edges

ContentComponent

Represents a component which has content.

Implemented by

BinaryComponent
Component

Fields

creationDate: String

Returns the date the item was created.

customMetas(after: String, first: Int, filter: String): CustomMetaConnection

Returns the custom meta data for the item.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
filter: String	the custom meta filter (optional)

customMetasStructure(filter: String): UntypedContent

Returns the custom meta data structure for the item. Can be used to group related fields together.

Arguments
filter: String	the custom meta filter (optional)

id: ID

Identifies the unique ID of the node.

initialPublishDate: String

Returns the date the item was initially published.

itemId: Int!

Identifies the item ID.

itemType: Int

Returns the item type of the item.

lastPublishDate: String

Returns the date the item was most recently published.

namespaceId: Int!

Identifies the namespace ID of the item.

owningPublicationId: Int

Returns the publication ID of the publication to which this item belongs.

publicationId: Int!

Identifies the publication ID of the item.

schemaId: Int

Returns the schema ID for the component.

taxonomies(types: [TaxonomyType]): [TaxonomyItem]

Returns the list of taxonomies for the item.

Arguments
types: [TaxonomyType]	the list of taxonomy types to include in the result set

title: String

Returns the title of the item.

updatedDate: String

Returns the date the item was updated.

multiMedia: Boolean

Returns true if the component is a multimedia (binary) component.

PageItem

Represents a page item. The root of all page models.

Implemented by

Page

Fields

components: [ContentComponent]

Returns the list of nested regions.

containerItems(types: [ContainerType]): [Item]

Returns the items in this container.

Arguments
types: [ContainerType]	the container types to include in the result set (optional)

content(renderContent: Boolean): Content

Returns the content in the page.

Arguments
renderContent: Boolean	whether to render dynamic content tags

creationDate: String

Returns the date the item was created.

customMetas(after: String, first: Int, filter: String): CustomMetaConnection

Returns the custom meta data for the item.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
filter: String	the custom meta filter (optional)

customMetasStructure(filter: String): UntypedContent

Returns the custom meta data structure for the item. Can be used to group related fields together.

Arguments
filter: String	the custom meta filter (optional)

fileName: String

Returns the file name path to the page.

id: ID

Identifies the unique ID of the node.

initialPublishDate: String

Returns the date the item was initially published.

itemId: Int!

Identifies the item ID.

itemType: Int

Returns the item type of the item.

lastPublishDate: String

Returns the date the item was most recently published.

Returns the name of the region.

namespaceId: Int!

Identifies the namespace ID of the item.

owningPublicationId: Int

Returns the publication ID of the publication to which this item belongs.

pageTemplate: Template

Returns the template for the page.

publicationId: Int!

Identifies the publication ID of the item.

rawContent(renderContent: Boolean): RawContent

Returns the raw content in the page.

Arguments
renderContent: Boolean	whether to render dynamic content tags

regions(filter: String): [PageRegion]

Returns the regions for the page.

Arguments
filter: String	the page region filter (optional)

taxonomies(types: [TaxonomyType]): [TaxonomyItem]

Returns the list of taxonomies for the item.

Arguments
types: [TaxonomyType]	the list of taxonomy types to include in the result set

title: String

Returns the title of the item.

updatedDate: String

Returns the date the item was updated.

url: String!

Identifies the URL of the page.

SearchConnection

A connection to a list of items.

Fields

edges: [SearchEdge]

a list of edges

InputSearchCriteria

Arguments
and: [InputSearchCriteria]	Operation AND. This operation must be used together with a field and value or with a groupBy block. Operations can not be stacked to each other, but they can contain groupBy
field: String	Field name for searching the index
groupBy: [InputSearchCriteria]	Container group. This encapsulation must be used together with an operation and container must contain an operation. This could be useful to form criteria which contain 2 or more operations.
strict: Boolean	Parameter to enable strict search
or: [InputSearchCriteria]	Operation OR. This operation must be used together with a field and value or with a groupBy block. Operations can not be stacked to each other, but they can contain groupBy
value: String	Field value for searching the index

InputResultFilter

Filtering and highlighting the search results

Arguments
excludeFields: [String]	Fields that will be excluded from results.
highlightInAllIsEnabled: Boolean	Parameter to enable highlight in all.
highlightingIsEnabled: Boolean	Parameter to enable highlight.

InputSortBy

Sorting the search results

Arguments
fields: [String]!	Fields to sort.
sortAsText: Boolean	Sort values as text.
sortingDirection: SortingDirectionType!	Sorting direction.

Result

This is the search result response that contains results from search and broker database.

Fields

brokerResult: [Item]

This is the results from broker database.

hits: Int

This is the total number of result hits from query service.

searchResult: SearchResult

This is the results from query service.

FacetedSearchResults

Faceted search results.

Fields

facets(language: String): [Facet]

Facets.

Arguments
language: String	Selection for results, if missing concept scheme default language will used.

results(after: String, first: Int): SearchResultsConnection

Search results.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.

InputCriteria

InputFacets

Input Facets

Arguments
concepts: [InputConceptFacet]	Concept facets

ConceptSuggestionConnection

A connection to a list of items.

Fields

edges: [ConceptSuggestionEdge]

a list of edges

ConceptScheme

Concept Scheme.

Fields

defaultLanguage: String

Returns the default language for this concept scheme.

language: String

Returns the concept scheme language.

topConcepts(after: String, first: Int): TaxonomyTopConceptsSearchResultsConnection

Returns the top-level concepts (no parents) for this concept scheme.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.

concepts: [Concept]

Returns the results of a concept search within this particular concept scheme.

connectorId: String

Returns the connector Id for this concept scheme.

title: String

Returns the concept scheme title.

uri: String

Returns the concept scheme uri.

CustomMetaConnection

A connection to a list of items.

Fields

edges: [CustomMetaEdge]

a list of edges

UntypedContent

Untyped content where all data is available in a Map structure.

Implements

Content

Fields

data: Map

Return content data

id: ID

Identifies the unique ID of the node.

type: String

Identifies the type of the content.

TaxonomyItem

Represents a taxonomy item.

Implemented by

Keyword
StructureGroup

Fields

children(after: String, first: Int): TaxonomyItemConnection

Returns the child taxonomies for the taxonomy.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.

creationDate: String

Returns the date the item was created.

customMetas(after: String, first: Int, filter: String): CustomMetaConnection

Returns the custom meta data for the item.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
filter: String	the custom meta filter (optional)

customMetasStructure(filter: String): UntypedContent

Returns the custom meta data structure for the item. Can be used to group related fields together.

Arguments
filter: String	the custom meta filter (optional)

depth: Int

Returns the depth (level) of the taxonomy.

id: ID

Identifies the unique ID of the node.

initialPublishDate: String

Returns the date the item was initially published.

itemId: Int!

Identifies the item ID.

itemType: Int

Returns the item type of the item.

key: String

Returns the key of the taxonomy.

lastPublishDate: String

Returns the date the item was most recently published.

namespaceId: Int!

Identifies the namespace ID of the item.

owningPublicationId: Int

Returns the publication ID of the publication to which this item belongs.

parent: TaxonomyItem

Returns the parent taxonomy of the taxonomy.

publicationId: Int!

Identifies the publication ID of the item.

taxonomyId: Int!

Identifies the ID of the taxonomy.

taxonomyType: TaxonomyType!

Identifies the type of the taxonomy.

title: String

Returns the title of the item.

updatedDate: String

Returns the date the item was updated.

hasChildren: Boolean

Returns true if the taxonomy has child taxonomies.

abstract: Boolean

Returns true if the taxonomy is abstract.

navigable: Boolean

Returns true if the taxonomy is navigable.

TaxonomyType

Possible Enum Values

KEYWORD	KEYWORD
CATEGORY	CATEGORY
STRUCTUREGROUP	STRUCTUREGROUP

BinaryVariantConnection

A connection to a list of items.

Fields

edges: [BinaryVariantEdge]

a list of edges

Item

Represents an item. The root of all content models.

Implemented by

Publication
Keyword
BinaryComponent
Page
Template
StructureGroup
Component
ComponentPresentation

Fields

creationDate: String

Returns the date the item was created.

customMetas(after: String, first: Int, filter: String): CustomMetaConnection

Returns the custom meta data for the item.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
filter: String	the custom meta filter (optional)

customMetasStructure(filter: String): UntypedContent

Returns the custom meta data structure for the item. Can be used to group related fields together.

Arguments
filter: String	the custom meta filter (optional)

id: ID

Identifies the unique ID of the node.

initialPublishDate: String

Returns the date the item was initially published.

itemId: Int!

Identifies the item ID.

itemType: Int

Returns the item type of the item.

lastPublishDate: String

Returns the date the item was most recently published.

namespaceId: Int!

Identifies the namespace ID of the item.

owningPublicationId: Int

Returns the publication ID of the publication to which this item belongs.

publicationId: Int!

Identifies the publication ID of the item.

title: String

Returns the title of the item.

updatedDate: String

Returns the date the item was updated.

ClaimValueType

Represents the type of claim value.

Possible Enum Values

STRING	A string value.
DATE	A date value.
FLOAT	A float value.
NUMBER	A number value.
BOOLEAN	A boolean value.

LinkType

Represents the type of link.

Possible Enum Values

PAGE	A page link.
COMPONENT	A component link.
BINARY	A binary link.
DYNAMIC_COMPONENT	A dynamic component link.

KeywordEdge

An edge in a connection

Fields

node: Keyword

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

Content

Implemented by

UntypedContent

Fields

id: ID

Identifies the unique ID of the node.

type: String

Identifies the type of the content.

Template

Represents a template.

Implements

Item

Fields

creationDate: String

Returns the date the item was created.

customMetas(after: String, first: Int, filter: String): CustomMetaConnection

Returns the custom meta data for the item.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
filter: String	the custom meta filter (optional)

customMetasStructure(filter: String): UntypedContent

Returns the custom meta data structure for the item. Can be used to group related fields together.

Arguments
filter: String	the custom meta filter (optional)

id: ID

Identifies the unique ID of the node.

initialPublishDate: String

Returns the date the item was initially published.

itemId: Int!

Identifies the item ID.

itemType: Int

Returns the item type of the item.

lastPublishDate: String

Returns the date the item was most recently published.

namespaceId: Int!

Identifies the namespace ID of the item.

outputFormat: String

Returns the output format of the template.

owningPublicationId: Int

Returns the publication ID of the publication to which this item belongs.

priority: Int

Returns the priority of the template.

publicationId: Int!

Identifies the publication ID of the item.

title: String

Returns the title of the item.

updatedDate: String

Returns the date the item was updated.

RawContent

Represents an item with content.

Fields

charSet: String

Returns the character set encoding of the string content.

content: String

Returns the string content.

data: Map

Return content data

id: ID

Identifies the unique ID of the node.

ContentFragment

Represents a fragment of content.

Implemented by

ComponentPresentation

Fields

content: Content

Returns the content of this fragment.

creationDate: String

Returns the date the item was created.

customMetas(after: String, first: Int, filter: String): CustomMetaConnection

Returns the custom meta data for the item.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.
filter: String	the custom meta filter (optional)

customMetasStructure(filter: String): UntypedContent

Returns the custom meta data structure for the item. Can be used to group related fields together.

Arguments
filter: String	the custom meta filter (optional)

id: ID

Identifies the unique ID of the node.

initialPublishDate: String

Returns the date the item was initially published.

itemId: Int!

Identifies the item ID.

itemType: Int

Returns the item type of the item.

lastPublishDate: String

Returns the date the item was most recently published.

namespaceId: Int!

Identifies the namespace ID of the item.

owningPublicationId: Int

Returns the publication ID of the publication to which this item belongs.

publicationId: Int!

Identifies the publication ID of the item.

title: String

Returns the title of the item.

updatedDate: String

Returns the date the item was updated.

ComponentPresentationEdge

An edge in a connection

Fields

node: ComponentPresentation

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

InputCustomMetaCriteria

Arguments
scope: CriteriaScope	If not given, defaults to Item

InputDateRangeCriteriaImpl

Arguments
end: String	End date & time
start: String	Start date & time
type: DateRangeType	Date range type

InputKeywordCriteria

Arguments
categoryId: Int	Id of the category. Takes precedence over categoryName, if both are present
keywordId: Int	Id of the keyword. Takes precedence over key, if both are present

InputSchemaCriteria

Arguments
id: Int	Id of the schema. Takes precedence over title, if both are present
title: String	Title of the schema. Applicable only for schemas related to dynamic component presentations.

InputTemplateCriteria

Arguments
id: Int	Id of the template.

MetadataType

Possible Enum Values

STRING	STRING
DATE	DATE
FLOAT	FLOAT

SortOrderType

Represents a type of natural sort: descending or ascending

Possible Enum Values

Ascending	A string value
Descending	A string value

SortFieldType

These are the fields that allow sorting

Possible Enum Values

CREATION_DATE	CREATION_DATE
INITIAL_PUBLISH_DATE	INITIAL_PUBLISH_DATE
ITEM_ID	ITEM_ID
ITEM_TYPE	ITEM_TYPE
LAST_PUBLISH_DATE	LAST_PUBLISH_DATE
NAMESPACE_ID	NAMESPACE_ID
OWNING_PUBLICATION_ID	OWNING_PUBLICATION_ID
PUBLICATION_ID	PUBLICATION_ID
TITLE	TITLE
UPDATED_DATE	UPDATED_DATE
CUSTOM_META	CUSTOM_META

ItemEdge

An edge in a connection

Fields

node: Item

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

FilterItemType

Possible Enum Values

PUBLICATION	PUBLICATION
COMPONENT	COMPONENT
COMPONENT_TEMPLATE	COMPONENT_TEMPLATE
PAGE	PAGE
PAGE_TEMPLATE	PAGE_TEMPLATE
CATEGORY	CATEGORY
KEYWORD	KEYWORD

TaxonomyItemConnection

A connection to a list of items.

Fields

edges: [TaxonomyItemEdge]

a list of edges

ContainerType

Represents the type of container.

Possible Enum Values

COMPONENT_PRESENTATION

A component presentation container.

PageRegion

Represents a page region.

Implemented by

UntypedPageRegion
Page

Fields

components: [ContentComponent]

Returns the list of nested regions.

Returns the name of the region.

regions(filter: String): [PageRegion]

Returns the regions for the page.

Arguments
filter: String	the page region filter (optional)

Container

Represents a container for items.

Implemented by

Page

Fields

containerItems(types: [ContainerType]): [Item]

Returns the items in this container.

Arguments
types: [ContainerType]	the container types to include in the result set (optional)

Taggable

Represents a related set of entities.

Implemented by

Page

Fields

taxonomies(types: [TaxonomyType]): [TaxonomyItem]

Returns the list of taxonomies for the item.

Arguments
types: [TaxonomyType]	the list of taxonomy types to include in the result set

PageEdge

An edge in a connection

Fields

node: Page

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

PublicationEdge

An edge in a connection

Fields

node: Publication

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

ContentFilterQueryType

Possible Enum Values

CUSTOM_META

CustomMetaValueType

Possible Enum Values

STRING	STRING
DATE	DATE
FLOAT	FLOAT
NUMBER	NUMBER
UNKNOWN	UNKNOWN

SitemapItem

Sitemap Item

Implemented by

TaxonomySitemapItem
PageSitemapItem

Fields

id: ID

Identifies the unique ID of the node.

originalTitle: String

Original title

publishedDate: String

The most recent date this item was published.

title: String

Title

type: String

Type

url: String

URL

visible: Boolean

Visible

StructureGroupEdge

An edge in a connection

Fields

node: StructureGroup

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

SearchEdge

An edge in a connection

Fields

node: Result

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

SortingDirectionType

Sorting direction of results

Possible Enum Values

ASCENDING	ASCENDING
DESCENDING	DESCENDING

SearchResult

Fields

author: String

The author of the search result.

binaryAuthor: String

The author of the binary file.

binaryContentLength: Long

The binary content length of the search result.

binaryContentType: String

The binary content type of the search result.

binaryCreatedDate: String

The creation date of the binary file.

binaryFileName: String

The binary file name of the search result.

binaryLanguage: String

The language of the search result. (binary file)

binaryTitle: String

The title of binary file.

createdDate: String

The creation date of the search result.

fields: Map

A map of fields defined on the search result.

highlighted: Map

A map of highlighted search results.

id: String

The search result identifier.

itemType: String

The item type of the search result.

locale: String

The locale of the search result.

location: String

The location of the search result.

mainContentField: String

The content of the search result (indexed by locale).

majorVersion: String

The major version of the search result.

minorVersion: String

The minor version of the search result.

modifiedDate: String

The updated date of the search result.

namespace: String

The namespace of the search result.

publicationId: Int

The publication ID of the search result.

publicationTitle: String

The publication title of the search result.

rawContent: String

The raw content of the search result.

rawLanguageTitle: String

The title of the search result (indexed by locale).

schemaId: String

The schema id of the search result.

url: String

The url of the search result.

Facet

Represents a facet node.

Implemented by

ConceptFacet

Fields

SearchResultsConnection

A connection to a list of items.

Fields

hits: Int

The total number of the hits

edges: [SearchResultsEdge]

a list of edges

pageInfo: PageInfo!

details about this specific page

InputConcept

Arguments
conceptIds: [String]	Concept IDs
conceptLabels: [String]	Concept labels
connectorId: String	Namespace connector ID
language: String	Language
schemeTitle: String	Concept scheme title

InputField

InputId

InputFieldLanguage

InputFieldMetadata

InputConceptFacet

Concept Facet

Arguments
schemeTitle: String	Concept scheme Title
connectorId: String	Connector namespace Id.
first: Int	Maximum number of results per concept scheme.
language: String	Language

ConceptSuggestionEdge

An edge in a connection

Fields

node: ConceptSuggestion

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

TaxonomyTopConceptsSearchResultsConnection

A connection to a list of items.

Fields

edges: [TaxonomyTopConceptsSearchResultsEdge]

a list of edges

Concept

Fields

alternativeLabels: [String]

Returns the alternative labels for concept.

id: String

Returns the concept Id. These are case sensitive, so do not mix case when defining IDs.

label: String

Returns the concept label.

narrowerConcepts(after: String, first: Int): TaxonomyNarrowerConceptsConnection

Returns the narrower concepts.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.

parentConceptIdsGraph: [String]

Returns the parent concept Id graph.

parentConceptsGraph: [String]

Returns the parent concept Uri graph.

relatedConceptIds: [String]

Returns the related concept Ids graph.

relatedConceptLabels: [String]

Returns the related concept labels.

relatedConcepts(after: String, first: Int): TaxonomyRelatedConceptsConnection

Returns the related concepts.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.

uri: String

Returns the concept Uri.

CustomMetaEdge

An edge in a connection

Fields

node: CustomMeta

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

BinaryVariantEdge

An edge in a connection

Fields

node: BinaryVariant

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

CriteriaScope

Possible Enum Values

Publication	Publication
Item	Item
ItemInPublication	ItemInPublication

DateRangeType

Possible Enum Values

CREATION_DATE	CREATION_DATE
UPDATED_DATE	UPDATED_DATE
INITIAL_PUBLISH_DATE	INITIAL_PUBLISH_DATE
LAST_PUBLISH_DATE	LAST_PUBLISH_DATE

TaxonomyItemEdge

An edge in a connection

Fields

node: TaxonomyItem

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

UntypedPageRegion

Untyped page region.

Implements

PageRegion

Fields

components: [ContentComponent]

Returns the list of nested regions.

Returns the name of the region.

regions(filter: String): [PageRegion]

Returns the regions for the page.

Arguments
filter: String	the page region filter (optional)

PageSitemapItem

Implements

SitemapItem

Fields

id: ID

Identifies the unique ID of the node.

originalTitle: String

Original title

publishedDate: String

The most recent date this item was published.

title: String

Title

type: String

Type

url: String

URL

visible: Boolean

Visible

ConceptFacet

Represents a concept facet.

Implements

Facet

Fields

concepts: [ConceptAggregation]

Concepts.

connectorId: String

Connector ID.

title: String

Concept scheme title.

uri: String

Concept scheme URI.

SearchResultsEdge

An edge in a connection

Fields

node: SearchResults

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

PageInfo

Information about pagination in a connection.

Fields

startCursor: String

When paginating backwards, the cursor to continue.

endCursor: String

When paginating forwards, the cursor to continue.

ConceptSuggestion

Fields

alternativeLabels: [String]

Returns the alternative labels for concept.

connectorId: String

Returns the connector Id.

Returns number of documents marked with concept.

highlight: [String]

Returns the concept highlighted label.

id: String

Returns the concept Id. These are case sensitive, so do not mix case when defining IDs.

label: String

Returns the concept label.

narrowerConcepts(after: String, first: Int): TaxonomyNarrowerConceptsConnection

Returns the narrower concepts.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.

parentConceptIdsGraph: [String]

Returns the parent concept Id graph.

parentConceptsGraph: [String]

Returns the parent concept Uri graph.

relatedConceptIds: [String]

Returns the related concept Ids graph.

relatedConceptLabels: [String]

Returns the related concept labels.

relatedConcepts(after: String, first: Int): TaxonomyRelatedConceptsConnection

Returns the related concepts.

Arguments
after: String	fetching only nodes after this node (exclusive)
first: Int	fetching only the first certain number of nodes.

uri: String

Returns the concept Uri.

TaxonomyTopConceptsSearchResultsEdge

An edge in a connection

Fields

node: Concept

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

TaxonomyNarrowerConceptsConnection

A connection to a list of items.

Fields

edges: [TaxonomyNarrowerConceptsEdge]

a list of edges

TaxonomyRelatedConceptsConnection

A connection to a list of items.

Fields

edges: [TaxonomyRelatedConceptsEdge]

a list of edges

CustomMeta

Represents custom metadata.

Fields

id: ID

Identifies the unique ID of the node.

itemId: Int!

Identifies the item ID of the custom meta.

key: String!

Identifies the key of the custom meta.

namespaceId: Int!

Identifies the namespace ID of the custom meta.

publicationId: Int!

Identifies the publication ID of the custom meta.

value: String!

Identifies the value of the custom meta.

valueType: CustomMetaValueType!

Identifies the value type of the custom meta.

BinaryVariant

Represents a variant of a binary component.

Fields

binaryId: Int!

Identifies the binary ID of the variant.

description: String

Returns the description of the variant.

downloadUrl: String!

Identifies the binary content URL of the variant.

id: ID

Identifies the unique ID of the node.

path: String!

Identifies the path of the variant.

type: String!

Identifies the type of the variant.

url: String!

Identifies the relative binary content URL of the variant.

variantId: String!

Identifies the variant ID of the variant.

ConceptAggregation

Fields

Returns the concept hits.

id: String

Returns the concept Id. These are case sensitive, so do not mix case when defining IDs.

label: String

Returns the concept label.

uri: String

Returns the concept URI.

SearchResults

This is the search result response that contains results from search and broker database.

Fields

broker: [Item]

This is the results from broker database.

search: Search

This is the results from query service.

TaxonomyNarrowerConceptsEdge

An edge in a connection

Fields

node: Concept

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

TaxonomyRelatedConceptsEdge

An edge in a connection

Fields

node: Concept

The item at the end of the edge

cursor: String!

cursor marks a unique position or index into the connection

Search

Fields

author: String

The author of the search result.

binaryAuthor: String

The author of the binary file.

binaryContentLength: Long

The binary content length of the search result.

binaryContentType: String

The binary content type of the search result.

binaryCreatedDate: String

The creation date of the binary file.

binaryFileName: String

The binary file name of the search result.

binaryLanguage: String

The language of the search result. (binary file)

binaryTitle: String

The title of binary file.

conceptSchemes: [ConceptScheme]

Concept schemes attached to a search result.

createdDate: String

The creation date of the search result.

fields: Map

A map of fields defined on the search result.

highlighted: Map

A map of highlighted search results.

id: String

The search result identifier.

itemType: String

The item type of the search result.

locale: String

The locale of the search result.

location: String

The location of the search result.

mainContentField: String

The content of the search result (indexed by locale).

majorVersion: String

The major version of the search result.

minorVersion: String

The minor version of the search result.

modifiedDate: String

The updated date of the search result.

namespace: String

The namespace of the search result.

publicationId: Int

The publication ID of the search result.

publicationTitle: String

The publication title of the search result.

rawContent: String

The raw content of the search result.

rawLanguageTitle: String

The title of the search result (indexed by locale).

schemaId: String

The schema id of the search result.

score: Float

Matching score of the result.

url: String

The url of the search result.

Int

Built-in Int

String

Built-in String

Boolean

Built-in Boolean

ID

Built-in ID

Map

Coercing Map

Long

Long type

Float

Built-in Float