Public Content API Documentation
Dynamic Experience Delivery Content Service API.
Terms of Service
API Endpoints
http://content-api:8081/cd/apiHeaders
# Your API token from the dashboard. Must be included in all API calls.
Authorization: Bearer <YOUR_TOKEN_HERE>Version
12.2.0
Queries
binaryComponent
Description
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.
Response
Returns a BinaryComponent
Example
Query
query binaryComponent(
$namespaceId: Int,
$publicationId: Int,
$binaryId: Int,
$url: String,
$cmUri: String,
$contextData: [InputClaimValue]
) {
binaryComponent(
namespaceId: $namespaceId,
publicationId: $publicationId,
binaryId: $binaryId,
url: $url,
cmUri: $cmUri,
contextData: $contextData
) {
creationDate
customMetas {
...CustomMetaConnectionFragment
}
customMetasStructure {
...UntypedContentFragment
}
id
initialPublishDate
itemId
itemType
lastPublishDate
namespaceId
owningPublicationId
publicationId
schema {
...SchemaFragment
}
schemaId
taxonomies {
...TaxonomyItemFragment
}
title
type
updatedDate
variants {
...BinaryVariantConnectionFragment
}
multiMedia
}
}
Variables
{
"namespaceId": 987,
"publicationId": 123,
"binaryId": 123,
"url": "abc123",
"cmUri": "xyz789",
"contextData": [InputClaimValue]
}
Response
{
"data": {
"binaryComponent": {
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "abc123",
"itemId": 123,
"itemType": 123,
"lastPublishDate": "xyz789",
"namespaceId": 123,
"owningPublicationId": 123,
"publicationId": 987,
"schema": Schema,
"schemaId": 987,
"taxonomies": [TaxonomyItem],
"title": "abc123",
"type": "abc123",
"updatedDate": "xyz789",
"variants": BinaryVariantConnection,
"multiMedia": false
}
}
}
binaryLink
Description
Resolve a link by parameters.
Response
Returns a Link
Example
Query
query binaryLink(
$namespaceId: Int!,
$publicationId: Int!,
$binaryId: Int!,
$variantId: String,
$renderRelativeLink: Boolean
) {
binaryLink(
namespaceId: $namespaceId,
publicationId: $publicationId,
binaryId: $binaryId,
variantId: $variantId,
renderRelativeLink: $renderRelativeLink
) {
itemId
namespaceId
publicationId
type
url
page {
...PageItemFragment
}
}
}
Variables
{
"namespaceId": 987,
"publicationId": 987,
"binaryId": 123,
"variantId": "xyz789",
"renderRelativeLink": true
}
Response
{
"data": {
"binaryLink": {
"itemId": 987,
"namespaceId": 123,
"publicationId": 123,
"type": "PAGE",
"url": "abc123",
"page": PageItem
}
}
}
categories
Description
Returns the categories for the given namespace and publication IDs.
Response
Returns a KeywordConnection
Arguments
| Name | Description |
|---|---|
after - String
|
Fetches nodes after this item exclusively. Use with the first parameter. |
first - Int
|
The number of nodes to return with each page of results. Defaults to 20. Pass -1 to retrieve all nodes. |
namespaceId - Int!
|
the namespace ID |
publicationId - Int!
|
the publication ID |
contextData - [InputClaimValue]
|
the context data |
Example
Query
query categories(
$after: String,
$first: Int,
$namespaceId: Int!,
$publicationId: Int!,
$contextData: [InputClaimValue]
) {
categories(
after: $after,
first: $first,
namespaceId: $namespaceId,
publicationId: $publicationId,
contextData: $contextData
) {
edges {
...KeywordEdgeFragment
}
}
}
Variables
{
"after": "abc123",
"first": 123,
"namespaceId": 987,
"publicationId": 987,
"contextData": [InputClaimValue]
}
Response
{"data": {"categories": {"edges": [KeywordEdge]}}}
category
Description
Returns a category given an ID or name for a given namespace and publication ID.
Response
Returns a Keyword
Arguments
| Name | Description |
|---|---|
namespaceId - Int!
|
the namespace ID |
publicationId - Int!
|
the publication ID |
categoryId - Int
|
the category ID |
categoryName - String
|
the category name |
contextData - [InputClaimValue]
|
the context data |
Example
Query
query category(
$namespaceId: Int!,
$publicationId: Int!,
$categoryId: Int,
$categoryName: String,
$contextData: [InputClaimValue]
) {
category(
namespaceId: $namespaceId,
publicationId: $publicationId,
categoryId: $categoryId,
categoryName: $categoryName,
contextData: $contextData
) {
children {
...TaxonomyItemConnectionFragment
}
creationDate
customMetas {
...CustomMetaConnectionFragment
}
customMetasStructure {
...UntypedContentFragment
}
depth
description
id
initialPublishDate
itemId
itemType
key
lastPublishDate
name
namespaceId
owningPublicationId
parent {
...TaxonomyItemFragment
}
publicationId
schema {
...SchemaFragment
}
taxonomyId
taxonomyType
title
totalRelatedItems
updatedDate
hasChildren
abstract
navigable
usedForIdentification
}
}
Variables
{
"namespaceId": 123,
"publicationId": 987,
"categoryId": 987,
"categoryName": "abc123",
"contextData": [InputClaimValue]
}
Response
{
"data": {
"category": {
"children": TaxonomyItemConnection,
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"depth": 987,
"description": "abc123",
"id": "4",
"initialPublishDate": "xyz789",
"itemId": 123,
"itemType": 123,
"key": "abc123",
"lastPublishDate": "abc123",
"name": "xyz789",
"namespaceId": 123,
"owningPublicationId": 987,
"parent": TaxonomyItem,
"publicationId": 123,
"schema": Schema,
"taxonomyId": 987,
"taxonomyType": "KEYWORD",
"title": "xyz789",
"totalRelatedItems": 123,
"updatedDate": "abc123",
"hasChildren": false,
"abstract": false,
"navigable": true,
"usedForIdentification": false
}
}
}
component
Description
Returns the component given the namespace, publication, component IDs.
Response
Returns a Component
Arguments
| Name | Description |
|---|---|
namespaceId - Int!
|
the namespace ID |
publicationId - Int!
|
the publication ID |
componentId - Int!
|
the component ID |
contextData - [InputClaimValue]
|
the context data |
Example
Query
query component(
$namespaceId: Int!,
$publicationId: Int!,
$componentId: Int!,
$contextData: [InputClaimValue]
) {
component(
namespaceId: $namespaceId,
publicationId: $publicationId,
componentId: $componentId,
contextData: $contextData
) {
content {
...ContentFragment
}
creationDate
customMetas {
...CustomMetaConnectionFragment
}
customMetasStructure {
...UntypedContentFragment
}
id
initialPublishDate
itemId
itemType
lastPublishDate
namespaceId
owningPublicationId
publicationId
schema {
...SchemaFragment
}
schemaId
taxonomies {
...TaxonomyItemFragment
}
title
updatedDate
multiMedia
resolvedLink {
...LinkFragment
}
}
}
Variables
{
"namespaceId": 987,
"publicationId": 123,
"componentId": 987,
"contextData": [InputClaimValue]
}
Response
{
"data": {
"component": {
"content": Content,
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": "4",
"initialPublishDate": "xyz789",
"itemId": 123,
"itemType": 123,
"lastPublishDate": "abc123",
"namespaceId": 123,
"owningPublicationId": 123,
"publicationId": 123,
"schema": Schema,
"schemaId": 123,
"taxonomies": [TaxonomyItem],
"title": "xyz789",
"updatedDate": "abc123",
"multiMedia": true,
"resolvedLink": Link
}
}
}
componentLink
Description
Resolve a link by parameters.
Response
Returns a Link
Arguments
| Name | Description |
|---|---|
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) |
Example
Query
query componentLink(
$namespaceId: Int!,
$publicationId: Int!,
$sourcePageId: Int,
$targetComponentId: Int!,
$excludeComponentTemplateId: Int,
$renderRelativeLink: Boolean
) {
componentLink(
namespaceId: $namespaceId,
publicationId: $publicationId,
sourcePageId: $sourcePageId,
targetComponentId: $targetComponentId,
excludeComponentTemplateId: $excludeComponentTemplateId,
renderRelativeLink: $renderRelativeLink
) {
itemId
namespaceId
publicationId
type
url
page {
...PageItemFragment
}
}
}
Variables
{
"namespaceId": 123,
"publicationId": 123,
"sourcePageId": 123,
"targetComponentId": 123,
"excludeComponentTemplateId": 123,
"renderRelativeLink": true
}
Response
{
"data": {
"componentLink": {
"itemId": 123,
"namespaceId": 123,
"publicationId": 987,
"type": "PAGE",
"url": "abc123",
"page": PageItem
}
}
}
componentPresentation
Description
Returns the component presentation given the namespace, publication, component and template IDs.
Response
Returns a ComponentPresentation
Arguments
| Name | Description |
|---|---|
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 |
Example
Query
query componentPresentation(
$namespaceId: Int!,
$publicationId: Int!,
$componentId: Int!,
$templateId: Int!,
$contextData: [InputClaimValue]
) {
componentPresentation(
namespaceId: $namespaceId,
publicationId: $publicationId,
componentId: $componentId,
templateId: $templateId,
contextData: $contextData
) {
component {
...ContentComponentFragment
}
componentTemplate {
...TemplateFragment
}
content {
...ContentFragment
}
creationDate
customMetas {
...CustomMetaConnectionFragment
}
customMetasStructure {
...UntypedContentFragment
}
id
initialPublishDate
itemId
itemType
lastPublishDate
namespaceId
owningPublicationId
publicationId
rawContent {
...RawContentFragment
}
schema {
...SchemaFragment
}
title
updatedDate
}
}
Variables
{
"namespaceId": 987,
"publicationId": 987,
"componentId": 123,
"templateId": 123,
"contextData": [InputClaimValue]
}
Response
{
"data": {
"componentPresentation": {
"component": ContentComponent,
"componentTemplate": Template,
"content": Content,
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "abc123",
"itemId": 123,
"itemType": 987,
"lastPublishDate": "abc123",
"namespaceId": 987,
"owningPublicationId": 987,
"publicationId": 123,
"rawContent": RawContent,
"schema": Schema,
"title": "abc123",
"updatedDate": "xyz789"
}
}
}
componentPresentations
Description
Get a list of component presentations filtered by set of criteria.
Response
Returns a ComponentPresentationConnection
Arguments
| Name | Description |
|---|---|
after - String
|
Fetches nodes after this item exclusively. Use with the first parameter. |
first - Int
|
The number of nodes to return with each page of results. Defaults to 20. Pass -1 to retrieve all 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 |
Example
Query
query componentPresentations(
$after: String,
$first: Int,
$namespaceId: Int!,
$publicationId: Int!,
$filter: InputComponentPresentationFilter!,
$contextData: [InputClaimValue],
$sort: InputSortParam
) {
componentPresentations(
after: $after,
first: $first,
namespaceId: $namespaceId,
publicationId: $publicationId,
filter: $filter,
contextData: $contextData,
sort: $sort
) {
edges {
...ComponentPresentationEdgeFragment
}
}
}
Variables
{
"after": "abc123",
"first": 987,
"namespaceId": 987,
"publicationId": 987,
"filter": InputComponentPresentationFilter,
"contextData": [InputClaimValue],
"sort": InputSortParam
}
Response
{
"data": {
"componentPresentations": {
"edges": [ComponentPresentationEdge]
}
}
}
dynamicComponentLink
Description
Resolve a link by parameters.
Response
Returns a Link
Arguments
| Name | Description |
|---|---|
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) |
Example
Query
query dynamicComponentLink(
$namespaceId: Int!,
$publicationId: Int!,
$targetPageId: Int!,
$targetComponentId: Int!,
$targetTemplateId: Int!,
$renderRelativeLink: Boolean
) {
dynamicComponentLink(
namespaceId: $namespaceId,
publicationId: $publicationId,
targetPageId: $targetPageId,
targetComponentId: $targetComponentId,
targetTemplateId: $targetTemplateId,
renderRelativeLink: $renderRelativeLink
) {
itemId
namespaceId
publicationId
type
url
page {
...PageItemFragment
}
}
}
Variables
{
"namespaceId": 123,
"publicationId": 987,
"targetPageId": 987,
"targetComponentId": 987,
"targetTemplateId": 123,
"renderRelativeLink": false
}
Response
{
"data": {
"dynamicComponentLink": {
"itemId": 987,
"namespaceId": 123,
"publicationId": 987,
"type": "PAGE",
"url": "xyz789",
"page": PageItem
}
}
}
ishPublication
Description
Get ish publication given the specified publication Id.
Response
Returns an IshPublication
Arguments
| Name | Description |
|---|---|
publicationId - Int!
|
the publication ID |
Example
Query
query ishPublication($publicationId: Int!) {
ishPublication(publicationId: $publicationId) {
conditions {
...IshConditionsFragment
}
creationDate
customMetas {
...CustomMetaConnectionFragment
}
customMetasStructure {
...UntypedContentFragment
}
id
initialPublishDate
itemId
itemType
lastPublishDate
metadata {
...IshPublicationMetadataFragment
}
multimediaPath
multimediaUrl
namespaceId
owningPublicationId
publicationId
publicationKey
publicationPath
publicationUrl
schema {
...SchemaFragment
}
title
updatedDate
}
}
Variables
{"publicationId": 123}
Response
{
"data": {
"ishPublication": {
"conditions": IshConditions,
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": "4",
"initialPublishDate": "abc123",
"itemId": 123,
"itemType": 123,
"lastPublishDate": "xyz789",
"metadata": IshPublicationMetadata,
"multimediaPath": "xyz789",
"multimediaUrl": "abc123",
"namespaceId": 123,
"owningPublicationId": 987,
"publicationId": 123,
"publicationKey": "xyz789",
"publicationPath": "abc123",
"publicationUrl": "abc123",
"schema": Schema,
"title": "abc123",
"updatedDate": "xyz789"
}
}
}
ishPublications
Description
Get list of ish publications.
Response
Returns an IshPublicationConnection
Arguments
| Name | Description |
|---|---|
after - String
|
Fetches nodes after this item exclusively. Use with the first parameter. |
first - Int
|
The number of nodes to return with each page of results. Defaults to 20. Pass -1 to retrieve all nodes. |
filter - InputPublicationFilter
|
the publications filter |
Example
Query
query ishPublications(
$after: String,
$first: Int,
$filter: InputPublicationFilter
) {
ishPublications(
after: $after,
first: $first,
filter: $filter
) {
edges {
...IshPublicationEdgeFragment
}
}
}
Variables
{
"after": "abc123",
"first": 123,
"filter": InputPublicationFilter
}
Response
{
"data": {
"ishPublications": {"edges": [IshPublicationEdge]}
}
}
ishToc
Description
Get TOC for a given publication.
Response
Returns an IshToc
Arguments
| Name | Description |
|---|---|
publicationId - Int!
|
the publication ID |
explicitCustomMetaList - [String]
|
list of custom metadata keys to include. If you do not specify any values all custom meta will be returned |
conditions - [InputIshCondition]
|
the conditions |
excludeConditions - [InputIshCondition]
|
the conditions to exclude |
Example
Query
query ishToc(
$publicationId: Int!,
$explicitCustomMetaList: [String],
$conditions: [InputIshCondition],
$excludeConditions: [InputIshCondition]
) {
ishToc(
publicationId: $publicationId,
explicitCustomMetaList: $explicitCustomMetaList,
conditions: $conditions,
excludeConditions: $excludeConditions
) {
entries {
...IshTocItemFragment
}
id
title
hasChildren
}
}
Variables
{
"publicationId": 987,
"explicitCustomMetaList": ["abc123"],
"conditions": [InputIshCondition],
"excludeConditions": [InputIshCondition]
}
Response
{
"data": {
"ishToc": {
"entries": [IshTocItem],
"id": "4",
"title": "xyz789",
"hasChildren": false
}
}
}
ishTocSnippet
Description
Get TOC snippet for a given publication.
Response
Returns [IshTocItem]
Arguments
| Name | Description |
|---|---|
publicationId - Int!
|
the publication ID |
top - Int!
|
the number of items to return |
explicitCustomMetaList - [String]
|
list of custom metadata keys to include. If you do not specify any values all custom meta will be returned |
conditions - [InputIshCondition]
|
the conditions |
excludeConditions - [InputIshCondition]
|
the conditions to exclude |
Example
Query
query ishTocSnippet(
$publicationId: Int!,
$top: Int!,
$explicitCustomMetaList: [String],
$conditions: [InputIshCondition],
$excludeConditions: [InputIshCondition]
) {
ishTocSnippet(
publicationId: $publicationId,
top: $top,
explicitCustomMetaList: $explicitCustomMetaList,
conditions: $conditions,
excludeConditions: $excludeConditions
) {
customMeta
entries {
...IshTocItemFragment
}
id
title
tocId
url
hasChildren
}
}
Variables
{
"publicationId": 123,
"top": 123,
"explicitCustomMetaList": ["xyz789"],
"conditions": [InputIshCondition],
"excludeConditions": [InputIshCondition]
}
Response
{
"data": {
"ishTocSnippet": [
{
"customMeta": Map,
"entries": [IshTocItem],
"id": 4,
"title": "abc123",
"tocId": "xyz789",
"url": "abc123",
"hasChildren": true
}
]
}
}
ishTocStructure
Description
Get TOC structure for a given publication.
Response
Returns an UntypedContent
Arguments
| Name | Description |
|---|---|
publicationId - Int!
|
the publication ID |
tocId - String
|
the parent TOC ID |
depth - Int
|
the depth to return |
includeCustomMeta - Boolean
|
include custom metadata |
explicitCustomMetaList - [String]
|
list of custom metadata keys to include. If you do not specify any values all custom meta will be returned |
conditions - [InputIshCondition]
|
the conditions |
excludeConditions - [InputIshCondition]
|
the conditions to exclude |
prebuilt - Boolean
|
Retrieve prebuilt Toc |
Example
Query
query ishTocStructure(
$publicationId: Int!,
$tocId: String,
$depth: Int,
$includeCustomMeta: Boolean,
$explicitCustomMetaList: [String],
$conditions: [InputIshCondition],
$excludeConditions: [InputIshCondition],
$prebuilt: Boolean
) {
ishTocStructure(
publicationId: $publicationId,
tocId: $tocId,
depth: $depth,
includeCustomMeta: $includeCustomMeta,
explicitCustomMetaList: $explicitCustomMetaList,
conditions: $conditions,
excludeConditions: $excludeConditions,
prebuilt: $prebuilt
) {
data
id
type
}
}
Variables
{
"publicationId": 987,
"tocId": "xyz789",
"depth": 987,
"includeCustomMeta": true,
"explicitCustomMetaList": ["xyz789"],
"conditions": [InputIshCondition],
"excludeConditions": [InputIshCondition],
"prebuilt": false
}
Response
{
"data": {
"ishTocStructure": {
"data": Map,
"id": 4,
"type": "xyz789"
}
}
}
ishTopic
Description
Get topic by Id or Url.
Response
Returns an IshTopic
Arguments
| Name | Description |
|---|---|
publicationId - Int
|
the publication ID |
itemId - Int
|
the topic ID |
url - String
|
the topic URL path |
topicRenderingOptions - IshTopicRenderOptions
|
rendering mode for topic |
topicLinkRenderOptions - IshTopicLinkRenderOptions
|
rendering mode for topic links |
topicLinkUrlPrefix - String
|
link url prefix |
topicBinaryLinkUrlPrefix - String
|
binary link url prefix |
conditions - [InputIshCondition]
|
the conditions |
excludeConditions - [InputIshCondition]
|
the conditions to exclude |
skipTopicProcessing - Boolean
|
skip all topic processing |
Example
Query
query ishTopic(
$publicationId: Int,
$itemId: Int,
$url: String,
$topicRenderingOptions: IshTopicRenderOptions,
$topicLinkRenderOptions: IshTopicLinkRenderOptions,
$topicLinkUrlPrefix: String,
$topicBinaryLinkUrlPrefix: String,
$conditions: [InputIshCondition],
$excludeConditions: [InputIshCondition],
$skipTopicProcessing: Boolean
) {
ishTopic(
publicationId: $publicationId,
itemId: $itemId,
url: $url,
topicRenderingOptions: $topicRenderingOptions,
topicLinkRenderOptions: $topicLinkRenderOptions,
topicLinkUrlPrefix: $topicLinkUrlPrefix,
topicBinaryLinkUrlPrefix: $topicBinaryLinkUrlPrefix,
conditions: $conditions,
excludeConditions: $excludeConditions,
skipTopicProcessing: $skipTopicProcessing
) {
abstract {
...IshTopicSectionFragment
}
bodyXhtml
creationDate
customMetas {
...CustomMetaConnectionFragment
}
customMetasStructure {
...UntypedContentFragment
}
id
initialPublishDate
itemId
itemType
lastPublishDate
links {
...IshTopicLinkFragment
}
metadata {
...IshTopicMetadataFragment
}
namespaceId
nestedTopics {
...IshTopicFragment
}
owningPublicationId
publicationId
relatedLinks {
...IshTopicRelatedLinksFragment
}
schema {
...SchemaFragment
}
shortDescription
title
topicsWithSameLogicalRef {
...IshTopicsByLogicalRefFragment
}
updatedDate
url
usedConditions
xhtml
publication {
...IshPublicationFragment
}
publications {
...IshPublicationFragment
}
}
}
Variables
{
"publicationId": 123,
"itemId": 987,
"url": "xyz789",
"topicRenderingOptions": "RENDER_IMAGES",
"topicLinkRenderOptions": "ABSOLUTE",
"topicLinkUrlPrefix": "abc123",
"topicBinaryLinkUrlPrefix": "xyz789",
"conditions": [InputIshCondition],
"excludeConditions": [InputIshCondition],
"skipTopicProcessing": false
}
Response
{
"data": {
"ishTopic": {
"abstract": IshTopicSection,
"bodyXhtml": "xyz789",
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "xyz789",
"itemId": 123,
"itemType": 123,
"lastPublishDate": "abc123",
"links": [IshTopicLink],
"metadata": IshTopicMetadata,
"namespaceId": 987,
"nestedTopics": [IshTopic],
"owningPublicationId": 123,
"publicationId": 987,
"relatedLinks": IshTopicRelatedLinks,
"schema": Schema,
"shortDescription": "xyz789",
"title": "xyz789",
"topicsWithSameLogicalRef": [IshTopicsByLogicalRef],
"updatedDate": "abc123",
"url": "xyz789",
"usedConditions": Map,
"xhtml": "abc123",
"publication": IshPublication,
"publications": [IshPublication]
}
}
}
ishTopics
Description
Get a list of topics matching filter.
Response
Returns an IshTopicConnection
Arguments
| Name | Description |
|---|---|
after - String
|
Fetches nodes after this item exclusively. Use with the first parameter. |
first - Int
|
The number of nodes to return with each page of results. Defaults to 20. Pass -1 to retrieve all nodes. |
filter - InputIshItemFilter!
|
Topic Filter |
topicRenderingOptions - IshTopicRenderOptions
|
rendering mode for topic |
topicLinkRenderOptions - IshTopicLinkRenderOptions
|
rendering mode for topic links |
topicLinkUrlPrefix - String
|
link url prefix |
topicBinaryLinkUrlPrefix - String
|
binary link url prefix |
conditions - [InputIshCondition]
|
the conditions |
excludeConditions - [InputIshCondition]
|
the conditions to exclude |
sort - InputSortParam
|
item sorting |
Example
Query
query ishTopics(
$after: String,
$first: Int,
$filter: InputIshItemFilter!,
$topicRenderingOptions: IshTopicRenderOptions,
$topicLinkRenderOptions: IshTopicLinkRenderOptions,
$topicLinkUrlPrefix: String,
$topicBinaryLinkUrlPrefix: String,
$conditions: [InputIshCondition],
$excludeConditions: [InputIshCondition],
$sort: InputSortParam
) {
ishTopics(
after: $after,
first: $first,
filter: $filter,
topicRenderingOptions: $topicRenderingOptions,
topicLinkRenderOptions: $topicLinkRenderOptions,
topicLinkUrlPrefix: $topicLinkUrlPrefix,
topicBinaryLinkUrlPrefix: $topicBinaryLinkUrlPrefix,
conditions: $conditions,
excludeConditions: $excludeConditions,
sort: $sort
) {
edges {
...IshTopicEdgeFragment
}
}
}
Variables
{
"after": "xyz789",
"first": 123,
"filter": InputIshItemFilter,
"topicRenderingOptions": "RENDER_IMAGES",
"topicLinkRenderOptions": "ABSOLUTE",
"topicLinkUrlPrefix": "xyz789",
"topicBinaryLinkUrlPrefix": "abc123",
"conditions": [InputIshCondition],
"excludeConditions": [InputIshCondition],
"sort": InputSortParam
}
Response
{"data": {"ishTopics": {"edges": [IshTopicEdge]}}}
ishTopicsByLogicalRefId
Description
Get a list of topics matching filter.
Response
Returns [IshTopicsByLogicalRef]
Arguments
| Name | Description |
|---|---|
logicalRefId - String!
|
Topic Logical Ref |
Example
Query
query ishTopicsByLogicalRefId($logicalRefId: String!) {
ishTopicsByLogicalRefId(logicalRefId: $logicalRefId) {
itemId
publicationId
topic {
...IshTopicFragment
}
topicTitle
url
}
}
Variables
{"logicalRefId": "xyz789"}
Response
{
"data": {
"ishTopicsByLogicalRefId": [
{
"itemId": 123,
"publicationId": 123,
"topic": IshTopic,
"topicTitle": "xyz789",
"url": "xyz789"
}
]
}
}
items
Description
Get a list of items filtered by set of criteria.
Response
Returns an ItemConnection
Arguments
| Name | Description |
|---|---|
after - String
|
Fetches nodes after this item exclusively. Use with the first parameter. |
first - Int
|
The number of nodes to return with each page of results. Defaults to 20. Pass -1 to retrieve all nodes. |
filter - InputItemFilter!
|
Item Filter |
contextData - [InputClaimValue]
|
the context data |
sort - InputSortParam
|
item sorting |
Example
Query
query items(
$after: String,
$first: Int,
$filter: InputItemFilter!,
$contextData: [InputClaimValue],
$sort: InputSortParam
) {
items(
after: $after,
first: $first,
filter: $filter,
contextData: $contextData,
sort: $sort
) {
edges {
...ItemEdgeFragment
}
}
}
Variables
{
"after": "xyz789",
"first": 987,
"filter": InputItemFilter,
"contextData": [InputClaimValue],
"sort": InputSortParam
}
Response
{"data": {"items": {"edges": [ItemEdge]}}}
keyword
Description
Returns the keyword for the given namespace, publication, category and keyword IDs.
Response
Returns a Keyword
Arguments
| Name | Description |
|---|---|
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 |
Example
Query
query keyword(
$namespaceId: Int!,
$publicationId: Int!,
$categoryId: Int!,
$keywordId: Int!,
$contextData: [InputClaimValue]
) {
keyword(
namespaceId: $namespaceId,
publicationId: $publicationId,
categoryId: $categoryId,
keywordId: $keywordId,
contextData: $contextData
) {
children {
...TaxonomyItemConnectionFragment
}
creationDate
customMetas {
...CustomMetaConnectionFragment
}
customMetasStructure {
...UntypedContentFragment
}
depth
description
id
initialPublishDate
itemId
itemType
key
lastPublishDate
name
namespaceId
owningPublicationId
parent {
...TaxonomyItemFragment
}
publicationId
schema {
...SchemaFragment
}
taxonomyId
taxonomyType
title
totalRelatedItems
updatedDate
hasChildren
abstract
navigable
usedForIdentification
}
}
Variables
{
"namespaceId": 987,
"publicationId": 123,
"categoryId": 123,
"keywordId": 123,
"contextData": [InputClaimValue]
}
Response
{
"data": {
"keyword": {
"children": TaxonomyItemConnection,
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"depth": 987,
"description": "xyz789",
"id": "4",
"initialPublishDate": "xyz789",
"itemId": 123,
"itemType": 123,
"key": "xyz789",
"lastPublishDate": "abc123",
"name": "xyz789",
"namespaceId": 123,
"owningPublicationId": 987,
"parent": TaxonomyItem,
"publicationId": 123,
"schema": Schema,
"taxonomyId": 123,
"taxonomyType": "KEYWORD",
"title": "abc123",
"totalRelatedItems": 987,
"updatedDate": "abc123",
"hasChildren": false,
"abstract": true,
"navigable": false,
"usedForIdentification": false
}
}
}
page
Description
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.
Response
Returns a Page
Example
Query
query page(
$namespaceId: Int,
$publicationId: Int,
$pageId: Int,
$url: String,
$cmUri: String,
$contextData: [InputClaimValue]
) {
page(
namespaceId: $namespaceId,
publicationId: $publicationId,
pageId: $pageId,
url: $url,
cmUri: $cmUri,
contextData: $contextData
) {
components {
...ContentComponentFragment
}
containerItems {
...ItemFragment
}
content {
...ContentFragment
}
creationDate
customMetas {
...CustomMetaConnectionFragment
}
customMetasStructure {
...UntypedContentFragment
}
fileName
id
initialPublishDate
itemId
itemType
lastPublishDate
name
namespaceId
owningPublicationId
pageTemplate {
...TemplateFragment
}
publicationId
rawContent {
...RawContentFragment
}
regions {
...PageRegionFragment
}
schema {
...SchemaFragment
}
taxonomies {
...TaxonomyItemFragment
}
title
updatedDate
url
}
}
Variables
{
"namespaceId": 123,
"publicationId": 987,
"pageId": 123,
"url": "abc123",
"cmUri": "xyz789",
"contextData": [InputClaimValue]
}
Response
{
"data": {
"page": {
"components": [ContentComponent],
"containerItems": [Item],
"content": Content,
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"fileName": "xyz789",
"id": "4",
"initialPublishDate": "abc123",
"itemId": 987,
"itemType": 987,
"lastPublishDate": "abc123",
"name": "abc123",
"namespaceId": 987,
"owningPublicationId": 987,
"pageTemplate": Template,
"publicationId": 987,
"rawContent": RawContent,
"regions": [PageRegion],
"schema": Schema,
"taxonomies": [TaxonomyItem],
"title": "xyz789",
"updatedDate": "abc123",
"url": "xyz789"
}
}
}
pageLink
Description
Resolve a link by parameters.
Response
Returns a Link
Example
Query
query pageLink(
$namespaceId: Int!,
$publicationId: Int!,
$pageId: Int!,
$renderRelativeLink: Boolean
) {
pageLink(
namespaceId: $namespaceId,
publicationId: $publicationId,
pageId: $pageId,
renderRelativeLink: $renderRelativeLink
) {
itemId
namespaceId
publicationId
type
url
page {
...PageItemFragment
}
}
}
Variables
{
"namespaceId": 123,
"publicationId": 987,
"pageId": 123,
"renderRelativeLink": true
}
Response
{
"data": {
"pageLink": {
"itemId": 123,
"namespaceId": 123,
"publicationId": 987,
"type": "PAGE",
"url": "abc123",
"page": PageItem
}
}
}
pages
Description
Returns the list of pages matching the provided namespace ID and page URL.
Response
Returns a PageConnection
Arguments
| Name | Description |
|---|---|
after - String
|
Fetches nodes after this item exclusively. Use with the first parameter. |
first - Int
|
The number of nodes to return with each page of results. Defaults to 20. Pass -1 to retrieve all nodes. |
namespaceId - Int!
|
the namespace ID |
url - String!
|
the page URL |
contextData - [InputClaimValue]
|
the context data |
Example
Query
query pages(
$after: String,
$first: Int,
$namespaceId: Int!,
$url: String!,
$contextData: [InputClaimValue]
) {
pages(
after: $after,
first: $first,
namespaceId: $namespaceId,
url: $url,
contextData: $contextData
) {
edges {
...PageEdgeFragment
}
}
}
Variables
{
"after": "abc123",
"first": 987,
"namespaceId": 987,
"url": "abc123",
"contextData": [InputClaimValue]
}
Response
{"data": {"pages": {"edges": [PageEdge]}}}
publication
Description
Returns the publication given the specified namespace and publication IDs.
Response
Returns a Publication
Arguments
| Name | Description |
|---|---|
namespaceId - Int!
|
the namespace ID |
publicationId - Int!
|
the publication ID |
contextData - [InputClaimValue]
|
the context data |
Example
Query
query publication(
$namespaceId: Int!,
$publicationId: Int!,
$contextData: [InputClaimValue]
) {
publication(
namespaceId: $namespaceId,
publicationId: $publicationId,
contextData: $contextData
) {
creationDate
customMetas {
...CustomMetaConnectionFragment
}
customMetasStructure {
...UntypedContentFragment
}
id
initialPublishDate
itemId
itemType
lastPublishDate
multimediaPath
multimediaUrl
namespaceId
owningPublicationId
publicationId
publicationKey
publicationPath
publicationUrl
schema {
...SchemaFragment
}
title
updatedDate
}
}
Variables
{
"namespaceId": 123,
"publicationId": 987,
"contextData": [InputClaimValue]
}
Response
{
"data": {
"publication": {
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": "4",
"initialPublishDate": "xyz789",
"itemId": 987,
"itemType": 987,
"lastPublishDate": "xyz789",
"multimediaPath": "abc123",
"multimediaUrl": "abc123",
"namespaceId": 987,
"owningPublicationId": 123,
"publicationId": 987,
"publicationKey": "xyz789",
"publicationPath": "abc123",
"publicationUrl": "xyz789",
"schema": Schema,
"title": "abc123",
"updatedDate": "abc123"
}
}
}
publicationMapping
Description
Returns the publication mapping given the specified namespace and site URL.
Response
Returns a PublicationMapping
Arguments
| Name | Description |
|---|---|
namespaceId - Int!
|
the namespace ID |
siteUrl - String!
|
site URL |
publicationMappingStrategy - [MappingStrategyType]
|
the publication mapping strategies |
Example
Query
query publicationMapping(
$namespaceId: Int!,
$siteUrl: String!,
$publicationMappingStrategy: [MappingStrategyType]
) {
publicationMapping(
namespaceId: $namespaceId,
siteUrl: $siteUrl,
publicationMappingStrategy: $publicationMappingStrategy
) {
domain
namespaceId
path
pathScanDepth
port
protocol
publicationId
}
}
Variables
{
"namespaceId": 987,
"siteUrl": "xyz789",
"publicationMappingStrategy": ["STATIC"]
}
Response
{
"data": {
"publicationMapping": {
"domain": "abc123",
"namespaceId": 123,
"path": "xyz789",
"pathScanDepth": 987,
"port": "xyz789",
"protocol": "xyz789",
"publicationId": 123
}
}
}
publicationMappings
Description
Returns the publication mappings for all publications or specified publication within the specified namespace.
Response
Returns a PublicationMappingConnection
Arguments
| Name | Description |
|---|---|
after - String
|
Fetches nodes after this item exclusively. Use with the first parameter. |
first - Int
|
The number of nodes to return with each page of results. Defaults to 20. Pass -1 to retrieve all nodes. |
namespaceId - Int!
|
the namespace ID |
publicationId - Int
|
the publication ID |
siteUrls - [String]
|
optional site URL(s) to match against |
matchProtocol - Boolean
|
specify if protocol is used during match |
matchPort - Boolean
|
specify if port is used during match |
matchDomain - Boolean
|
specify if domain is used during match |
matchPath - Boolean
|
specify if path is used during match |
Example
Query
query publicationMappings(
$after: String,
$first: Int,
$namespaceId: Int!,
$publicationId: Int,
$siteUrls: [String],
$matchProtocol: Boolean,
$matchPort: Boolean,
$matchDomain: Boolean,
$matchPath: Boolean
) {
publicationMappings(
after: $after,
first: $first,
namespaceId: $namespaceId,
publicationId: $publicationId,
siteUrls: $siteUrls,
matchProtocol: $matchProtocol,
matchPort: $matchPort,
matchDomain: $matchDomain,
matchPath: $matchPath
) {
edges {
...PublicationMappingEdgeFragment
}
}
}
Variables
{
"after": "abc123",
"first": 987,
"namespaceId": 987,
"publicationId": 987,
"siteUrls": ["abc123"],
"matchProtocol": true,
"matchPort": true,
"matchDomain": false,
"matchPath": false
}
Response
{
"data": {
"publicationMappings": {
"edges": [PublicationMappingEdge]
}
}
}
publications
Description
Returns the list of publications given the namespace ID and an optional filter.
Response
Returns a PublicationConnection
Arguments
| Name | Description |
|---|---|
after - String
|
Fetches nodes after this item exclusively. Use with the first parameter. |
first - Int
|
The number of nodes to return with each page of results. Defaults to 20. Pass -1 to retrieve all nodes. |
namespaceId - Int!
|
the namespace ID |
filter - InputPublicationFilter
|
the publications filter |
contextData - [InputClaimValue]
|
the context data |
Example
Query
query publications(
$after: String,
$first: Int,
$namespaceId: Int!,
$filter: InputPublicationFilter,
$contextData: [InputClaimValue]
) {
publications(
after: $after,
first: $first,
namespaceId: $namespaceId,
filter: $filter,
contextData: $contextData
) {
edges {
...PublicationEdgeFragment
}
}
}
Variables
{
"after": "abc123",
"first": 123,
"namespaceId": 123,
"filter": InputPublicationFilter,
"contextData": [InputClaimValue]
}
Response
{"data": {"publications": {"edges": [PublicationEdge]}}}
search
Description
Faceted search using a criteria.
Response
Returns a FacetedSearchResults
Arguments
| Name | Description |
|---|---|
criteria - InputCriteria
|
Search criteria for searching the index. |
rawCriteria - String
|
Search DSL output of SearchQuery builder. |
recommend - InputRecommendation
|
Recommendation parameters. |
resultFilter - InputResultFilter
|
Filtering and highlighting the search results. |
sortBy - InputSortBy
|
Sorting the search results. |
facets - InputFacets
|
Configure facets to include in the result set. |
Example
Query
query search(
$criteria: InputCriteria,
$rawCriteria: String,
$recommend: InputRecommendation,
$resultFilter: InputResultFilter,
$sortBy: InputSortBy,
$facets: InputFacets
) {
search(
criteria: $criteria,
rawCriteria: $rawCriteria,
recommend: $recommend,
resultFilter: $resultFilter,
sortBy: $sortBy,
facets: $facets
) {
facets {
...FacetFragment
}
results {
...SearchResultsConnectionFragment
}
}
}
Variables
{
"criteria": InputCriteria,
"rawCriteria": "xyz789",
"recommend": InputRecommendation,
"resultFilter": InputResultFilter,
"sortBy": InputSortBy,
"facets": InputFacets
}
Response
{
"data": {
"search": {
"facets": [Facet],
"results": SearchResultsConnection
}
}
}
sitemap
Description
Get navigation site map.
Response
Returns a TaxonomySitemapItem
Arguments
| Name | Description |
|---|---|
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 |
Example
Query
query sitemap(
$namespaceId: Int!,
$publicationId: Int!,
$navigationMarker: String,
$categoryId: Int,
$contextData: [InputClaimValue]
) {
sitemap(
namespaceId: $namespaceId,
publicationId: $publicationId,
navigationMarker: $navigationMarker,
categoryId: $categoryId,
contextData: $contextData
) {
classifiedItemsCount
description
id
items {
...SitemapItemFragment
}
key
originalTitle
publishedDate
title
type
url
abstract
hasChildNodes
visible
}
}
Variables
{
"namespaceId": 987,
"publicationId": 987,
"navigationMarker": "abc123",
"categoryId": 123,
"contextData": [InputClaimValue]
}
Response
{
"data": {
"sitemap": {
"classifiedItemsCount": 123,
"description": "abc123",
"id": "4",
"items": [SitemapItem],
"key": "xyz789",
"originalTitle": "abc123",
"publishedDate": "xyz789",
"title": "abc123",
"type": "abc123",
"url": "abc123",
"abstract": false,
"hasChildNodes": false,
"visible": true
}
}
}
sitemapStructure
Description
Get navigation site map subtree.
Response
Returns an UntypedContent
Arguments
| Name | Description |
|---|---|
namespaceId - Int!
|
the namespace ID |
publicationId - Int
|
the publication ID |
rootTaxonomyNodeId - String
|
the root taxonomy node ID |
depth - Int
|
the depth to return |
includeCustomMeta - Boolean
|
include custom metadata |
explicitCustomMetaList - [String]
|
list of custom metadata keys to include. If you do not specify any values all custom meta will be returned |
contextData - [InputClaimValue]
|
the context data |
Example
Query
query sitemapStructure(
$namespaceId: Int!,
$publicationId: Int,
$rootTaxonomyNodeId: String,
$depth: Int,
$includeCustomMeta: Boolean,
$explicitCustomMetaList: [String],
$contextData: [InputClaimValue]
) {
sitemapStructure(
namespaceId: $namespaceId,
publicationId: $publicationId,
rootTaxonomyNodeId: $rootTaxonomyNodeId,
depth: $depth,
includeCustomMeta: $includeCustomMeta,
explicitCustomMetaList: $explicitCustomMetaList,
contextData: $contextData
) {
data
id
type
}
}
Variables
{
"namespaceId": 123,
"publicationId": 123,
"rootTaxonomyNodeId": "abc123",
"depth": 987,
"includeCustomMeta": true,
"explicitCustomMetaList": ["xyz789"],
"contextData": [InputClaimValue]
}
Response
{
"data": {
"sitemapStructure": {
"data": Map,
"id": "4",
"type": "xyz789"
}
}
}
sitemapSubtree
Description
Get navigation site map subtree.
Response
Returns [TaxonomySitemapItem]
Arguments
| Name | Description |
|---|---|
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 |
Example
Query
query sitemapSubtree(
$namespaceId: Int!,
$publicationId: Int,
$taxonomyNodeId: String,
$ancestor: Ancestor,
$excludePages: Boolean,
$contextData: [InputClaimValue]
) {
sitemapSubtree(
namespaceId: $namespaceId,
publicationId: $publicationId,
taxonomyNodeId: $taxonomyNodeId,
ancestor: $ancestor,
excludePages: $excludePages,
contextData: $contextData
) {
classifiedItemsCount
description
id
items {
...SitemapItemFragment
}
key
originalTitle
publishedDate
title
type
url
abstract
hasChildNodes
visible
}
}
Variables
{
"namespaceId": 123,
"publicationId": 987,
"taxonomyNodeId": "xyz789",
"ancestor": "NONE",
"excludePages": false,
"contextData": [InputClaimValue]
}
Response
{
"data": {
"sitemapSubtree": [
{
"classifiedItemsCount": 987,
"description": "xyz789",
"id": 4,
"items": [SitemapItem],
"key": "abc123",
"originalTitle": "xyz789",
"publishedDate": "xyz789",
"title": "xyz789",
"type": "abc123",
"url": "xyz789",
"abstract": false,
"hasChildNodes": true,
"visible": true
}
]
}
}
structureGroup
Description
Returns the structure group for the given namespace, publication and structure group IDs.
Response
Returns a StructureGroup
Arguments
| Name | Description |
|---|---|
namespaceId - Int!
|
the namespace ID |
publicationId - Int!
|
the publication ID |
structureGroupId - Int!
|
the structure group ID |
contextData - [InputClaimValue]
|
the context data |
Example
Query
query structureGroup(
$namespaceId: Int!,
$publicationId: Int!,
$structureGroupId: Int!,
$contextData: [InputClaimValue]
) {
structureGroup(
namespaceId: $namespaceId,
publicationId: $publicationId,
structureGroupId: $structureGroupId,
contextData: $contextData
) {
children {
...TaxonomyItemConnectionFragment
}
creationDate
customMetas {
...CustomMetaConnectionFragment
}
customMetasStructure {
...UntypedContentFragment
}
depth
directory
id
initialPublishDate
itemId
itemType
key
lastPublishDate
namespaceId
owningPublicationId
parent {
...TaxonomyItemFragment
}
publicationId
schema {
...SchemaFragment
}
taxonomyId
taxonomyType
title
updatedDate
hasChildren
abstract
navigable
}
}
Variables
{
"namespaceId": 987,
"publicationId": 123,
"structureGroupId": 123,
"contextData": [InputClaimValue]
}
Response
{
"data": {
"structureGroup": {
"children": TaxonomyItemConnection,
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"depth": 123,
"directory": "abc123",
"id": "4",
"initialPublishDate": "abc123",
"itemId": 123,
"itemType": 123,
"key": "abc123",
"lastPublishDate": "xyz789",
"namespaceId": 123,
"owningPublicationId": 123,
"parent": TaxonomyItem,
"publicationId": 123,
"schema": Schema,
"taxonomyId": 123,
"taxonomyType": "KEYWORD",
"title": "abc123",
"updatedDate": "abc123",
"hasChildren": true,
"abstract": true,
"navigable": false
}
}
}
structureGroups
Description
Returns the structure groups for the given namespace and publication IDs.
Response
Returns a StructureGroupConnection
Arguments
| Name | Description |
|---|---|
after - String
|
Fetches nodes after this item exclusively. Use with the first parameter. |
first - Int
|
The number of nodes to return with each page of results. Defaults to 20. Pass -1 to retrieve all nodes. |
namespaceId - Int!
|
the namespace ID |
publicationId - Int!
|
the publication ID |
contextData - [InputClaimValue]
|
the context data |
Example
Query
query structureGroups(
$after: String,
$first: Int,
$namespaceId: Int!,
$publicationId: Int!,
$contextData: [InputClaimValue]
) {
structureGroups(
after: $after,
first: $first,
namespaceId: $namespaceId,
publicationId: $publicationId,
contextData: $contextData
) {
edges {
...StructureGroupEdgeFragment
}
}
}
Variables
{
"after": "xyz789",
"first": 987,
"namespaceId": 987,
"publicationId": 123,
"contextData": [InputClaimValue]
}
Response
{
"data": {
"structureGroups": {"edges": [StructureGroupEdge]}
}
}
suggest
Description
Suggest
Response
Returns a ConceptSuggestionConnection
Arguments
| Name | Description |
|---|---|
after - String
|
Fetches nodes after this item exclusively. Use with the first parameter. |
first - Int
|
The number of nodes to return with each page of results. Defaults to 20. Pass -1 to retrieve all 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. |
Example
Query
query suggest(
$after: String,
$first: Int,
$connectorId: String,
$label: String!,
$language: String,
$fuzzy: Boolean,
$used: Boolean
) {
suggest(
after: $after,
first: $first,
connectorId: $connectorId,
label: $label,
language: $language,
fuzzy: $fuzzy,
used: $used
) {
edges {
...ConceptSuggestionEdgeFragment
}
}
}
Variables
{
"after": "abc123",
"first": 123,
"connectorId": "xyz789",
"label": "xyz789",
"language": "abc123",
"fuzzy": false,
"used": true
}
Response
{"data": {"suggest": {"edges": [ConceptSuggestionEdge]}}}
taxonomy
Description
Taxonomy search.
Response
Returns [ConceptScheme]
Example
Query
query taxonomy(
$connectorId: String,
$title: String,
$conceptIds: [String],
$language: String
) {
taxonomy(
connectorId: $connectorId,
title: $title,
conceptIds: $conceptIds,
language: $language
) {
defaultLanguage
language
topConcepts {
...TaxonomyTopConceptsSearchResultsConnectionFragment
}
concepts {
...ConceptFragment
}
connectorId
title
uri
}
}
Variables
{
"connectorId": "abc123",
"title": "xyz789",
"conceptIds": ["abc123"],
"language": "xyz789"
}
Response
{
"data": {
"taxonomy": [
{
"defaultLanguage": "abc123",
"language": "xyz789",
"topConcepts": TaxonomyTopConceptsSearchResultsConnection,
"concepts": [Concept],
"connectorId": "xyz789",
"title": "abc123",
"uri": "xyz789"
}
]
}
}
typedComponent
Description
Returns the typed component given the namespace, publication, component IDs.
Response
Returns a ContentComponent
Arguments
| Name | Description |
|---|---|
namespaceId - Int!
|
the namespace ID |
publicationId - Int!
|
the publication ID |
componentId - Int!
|
the component ID |
contextData - [InputClaimValue]
|
the context data |
Example
Query
query typedComponent(
$namespaceId: Int!,
$publicationId: Int!,
$componentId: Int!,
$contextData: [InputClaimValue]
) {
typedComponent(
namespaceId: $namespaceId,
publicationId: $publicationId,
componentId: $componentId,
contextData: $contextData
) {
creationDate
customMetas {
...CustomMetaConnectionFragment
}
customMetasStructure {
...UntypedContentFragment
}
id
initialPublishDate
itemId
itemType
lastPublishDate
namespaceId
owningPublicationId
publicationId
schema {
...SchemaFragment
}
schemaId
taxonomies {
...TaxonomyItemFragment
}
title
updatedDate
multiMedia
}
}
Variables
{
"namespaceId": 123,
"publicationId": 987,
"componentId": 123,
"contextData": [InputClaimValue]
}
Response
{
"data": {
"typedComponent": {
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "abc123",
"itemId": 987,
"itemType": 123,
"lastPublishDate": "xyz789",
"namespaceId": 123,
"owningPublicationId": 987,
"publicationId": 987,
"schema": Schema,
"schemaId": 987,
"taxonomies": [TaxonomyItem],
"title": "abc123",
"updatedDate": "abc123",
"multiMedia": true
}
}
}
typedPage
Description
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.
Response
Returns a PageItem
Example
Query
query typedPage(
$namespaceId: Int,
$publicationId: Int,
$pageId: Int,
$url: String,
$cmUri: String,
$contextData: [InputClaimValue]
) {
typedPage(
namespaceId: $namespaceId,
publicationId: $publicationId,
pageId: $pageId,
url: $url,
cmUri: $cmUri,
contextData: $contextData
) {
components {
...ContentComponentFragment
}
containerItems {
...ItemFragment
}
content {
...ContentFragment
}
creationDate
customMetas {
...CustomMetaConnectionFragment
}
customMetasStructure {
...UntypedContentFragment
}
fileName
id
initialPublishDate
itemId
itemType
lastPublishDate
name
namespaceId
owningPublicationId
pageTemplate {
...TemplateFragment
}
publicationId
rawContent {
...RawContentFragment
}
regions {
...PageRegionFragment
}
schema {
...SchemaFragment
}
taxonomies {
...TaxonomyItemFragment
}
title
updatedDate
url
}
}
Variables
{
"namespaceId": 987,
"publicationId": 987,
"pageId": 123,
"url": "abc123",
"cmUri": "abc123",
"contextData": [InputClaimValue]
}
Response
{
"data": {
"typedPage": {
"components": [ContentComponent],
"containerItems": [Item],
"content": Content,
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"fileName": "xyz789",
"id": "4",
"initialPublishDate": "abc123",
"itemId": 987,
"itemType": 123,
"lastPublishDate": "xyz789",
"name": "abc123",
"namespaceId": 123,
"owningPublicationId": 987,
"pageTemplate": Template,
"publicationId": 987,
"rawContent": RawContent,
"regions": [PageRegion],
"schema": Schema,
"taxonomies": [TaxonomyItem],
"title": "abc123",
"updatedDate": "abc123",
"url": "abc123"
}
}
}
Types
Ancestor
Description
Represents ancestor's behaviour of the sitemap subtree response.
Values
| Enum Value | Description |
|---|---|
|
|
By default, do not return ancestors of the given taxonomy node. |
|
|
Returns path from the root ancestor to the given taxonomy node. |
|
|
Returns path from the root ancestor to the given taxonomy node and all siblings. |
Example
"NONE"
BinaryComponent
Description
Represents a component which has binary content.
Fields
| Field Name | Description |
|---|---|
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
schema - Schema
|
Returns the schema for the item. |
schemaId - Int
|
Returns the schema ID for the component. |
taxonomies - [TaxonomyItem]
|
Returns the list of taxonomies for the item. |
Arguments
|
|
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 - BinaryVariantConnection
|
Returns the variants of the binary component. |
Arguments
|
|
multiMedia - Boolean
|
Returns true if the component is a multimedia (binary) component. Redundant given that BinaryComponents do not expose this property |
Example
{
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "xyz789",
"itemId": 123,
"itemType": 987,
"lastPublishDate": "xyz789",
"namespaceId": 123,
"owningPublicationId": 123,
"publicationId": 123,
"schema": Schema,
"schemaId": 123,
"taxonomies": [TaxonomyItem],
"title": "abc123",
"type": "abc123",
"updatedDate": "xyz789",
"variants": BinaryVariantConnection,
"multiMedia": true
}
BinaryVariant
Description
Represents a variant of a binary component.
Fields
| Field Name | Description |
|---|---|
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. |
Example
{
"binaryId": 987,
"description": "abc123",
"downloadUrl": "xyz789",
"id": 4,
"path": "xyz789",
"type": "abc123",
"url": "abc123",
"variantId": "abc123"
}
BinaryVariantConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [BinaryVariantEdge]
|
a list of edges |
Example
{"edges": [BinaryVariantEdge]}
BinaryVariantEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
node - BinaryVariant
|
The item at the end of the edge |
cursor - String!
|
cursor marks a unique position or index into the connection |
Example
{
"node": BinaryVariant,
"cursor": "xyz789"
}
Boolean
Description
Built-in Boolean
ClaimValueType
Description
Represents the type of claim value.
Values
| Enum Value | Description |
|---|---|
|
|
A string value. |
|
|
A date value. |
|
|
A float value. |
|
|
A number value. |
|
|
A boolean value. |
Example
"STRING"
Component
Description
Represents a regular component.
Fields
| Field Name | Description |
|---|---|
content - Content
|
Returns the content of the component. |
Arguments
|
|
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
schema - Schema
|
Returns the schema for the item. |
schemaId - Int
|
Returns the schema ID for the component. |
taxonomies - [TaxonomyItem]
|
Returns the list of taxonomies for the item. |
Arguments
|
|
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. Redundant given that BinaryComponents do not expose this property |
resolvedLink - Link
|
Resolve component link to a page. |
Arguments
|
|
Example
{
"content": Content,
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "abc123",
"itemId": 123,
"itemType": 987,
"lastPublishDate": "xyz789",
"namespaceId": 987,
"owningPublicationId": 987,
"publicationId": 123,
"schema": Schema,
"schemaId": 987,
"taxonomies": [TaxonomyItem],
"title": "abc123",
"updatedDate": "xyz789",
"multiMedia": false,
"resolvedLink": Link
}
ComponentPresentation
Description
Represents a component presentation which has a component associated with a template.
Fields
| Field Name | Description |
|---|---|
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 - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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 - RawContent
|
Returns the raw content of the component presentation. |
Arguments
|
|
schema - Schema
|
Returns the schema for the item. |
title - String
|
Returns the title of the item. |
updatedDate - String
|
Returns the date the item was updated. |
Example
{
"component": ContentComponent,
"componentTemplate": Template,
"content": Content,
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "abc123",
"itemId": 987,
"itemType": 123,
"lastPublishDate": "xyz789",
"namespaceId": 987,
"owningPublicationId": 123,
"publicationId": 123,
"rawContent": RawContent,
"schema": Schema,
"title": "abc123",
"updatedDate": "abc123"
}
ComponentPresentationConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [ComponentPresentationEdge]
|
a list of edges |
Example
{"edges": [ComponentPresentationEdge]}
ComponentPresentationEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
node - ComponentPresentation
|
The item at the end of the edge |
cursor - String!
|
cursor marks a unique position or index into the connection |
Example
{
"node": ComponentPresentation,
"cursor": "xyz789"
}
Concept
Fields
| Field Name | Description |
|---|---|
alternativeLabels - [String]
|
Returns the alternative labels for concept. |
hiddenLabels - [String]
|
Returns the hidden 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 - TaxonomyNarrowerConceptsConnection
|
Returns the narrower concepts. |
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 - TaxonomyRelatedConceptsConnection
|
Returns the related concepts. |
uri - String
|
Returns the concept Uri. |
Example
{
"alternativeLabels": ["abc123"],
"hiddenLabels": ["abc123"],
"id": "xyz789",
"label": "xyz789",
"narrowerConcepts": TaxonomyNarrowerConceptsConnection,
"parentConceptIdsGraph": ["abc123"],
"parentConceptsGraph": ["abc123"],
"relatedConceptIds": ["abc123"],
"relatedConceptLabels": ["xyz789"],
"relatedConcepts": TaxonomyRelatedConceptsConnection,
"uri": "abc123"
}
ConceptAggregation
Example
{
"count": 987,
"id": "xyz789",
"label": "xyz789",
"uri": "abc123"
}
ConceptFacet
Description
Represents a concept facet.
Fields
| Field Name | Description |
|---|---|
id - String
|
Identifies the unique ID of the facet. |
concepts - [ConceptAggregation]
|
Concepts. |
connectorId - String
|
Connector ID. |
title - String
|
Concept scheme title. |
uri - String
|
Concept scheme URI. |
Example
{
"id": "xyz789",
"concepts": [ConceptAggregation],
"connectorId": "abc123",
"title": "abc123",
"uri": "abc123"
}
ConceptScheme
Description
Concept Scheme.
Fields
| Field Name | Description |
|---|---|
defaultLanguage - String
|
Returns the default language for this concept scheme. |
language - String
|
Returns the concept scheme language. |
topConcepts - TaxonomyTopConceptsSearchResultsConnection
|
Returns the top-level concepts (no parents) for this concept scheme. |
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. |
Example
{
"defaultLanguage": "xyz789",
"language": "abc123",
"topConcepts": TaxonomyTopConceptsSearchResultsConnection,
"concepts": [Concept],
"connectorId": "abc123",
"title": "abc123",
"uri": "xyz789"
}
ConceptSuggestion
Fields
| Field Name | Description |
|---|---|
alternativeLabels - [String]
|
Returns the alternative labels for concept. |
connectorId - String
|
Returns the connector Id. |
count - Int
|
Returns number of documents marked with concept. |
hiddenLabels - [String]
|
Returns the hidden labels for 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 - TaxonomyNarrowerConceptsConnection
|
Returns the narrower concepts. |
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 - TaxonomyRelatedConceptsConnection
|
Returns the related concepts. |
uri - String
|
Returns the concept Uri. |
Example
{
"alternativeLabels": ["abc123"],
"connectorId": "abc123",
"count": 987,
"hiddenLabels": ["abc123"],
"highlight": ["xyz789"],
"id": "abc123",
"label": "abc123",
"narrowerConcepts": TaxonomyNarrowerConceptsConnection,
"parentConceptIdsGraph": ["abc123"],
"parentConceptsGraph": ["xyz789"],
"relatedConceptIds": ["abc123"],
"relatedConceptLabels": ["xyz789"],
"relatedConcepts": TaxonomyRelatedConceptsConnection,
"uri": "abc123"
}
ConceptSuggestionConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [ConceptSuggestionEdge]
|
a list of edges |
Example
{"edges": [ConceptSuggestionEdge]}
ConceptSuggestionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
node - ConceptSuggestion
|
The item at the end of the edge |
cursor - String!
|
cursor marks a unique position or index into the connection |
Example
{
"node": ConceptSuggestion,
"cursor": "abc123"
}
Container
Description
Represents a container for items.
Fields
| Field Name | Description |
|---|---|
containerItems - [Item]
|
Returns the items in this container. |
Arguments
|
|
Possible Types
| Container Types |
|---|
Example
{"containerItems": [Item]}
ContainerType
Description
Represents the type of container.
Values
| Enum Value | Description |
|---|---|
|
|
A component presentation container. |
Example
"COMPONENT_PRESENTATION"
Content
ContentComponent
Description
Represents a component which has content.
Fields
| Field Name | Description |
|---|---|
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
schema - Schema
|
Returns the schema for the item. |
schemaId - Int
|
Returns the schema ID for the component. |
taxonomies - [TaxonomyItem]
|
Returns the list of taxonomies for the item. |
Arguments
|
|
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. Redundant given that BinaryComponents do not expose this property |
Possible Types
| ContentComponent Types |
|---|
Example
{
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": "4",
"initialPublishDate": "xyz789",
"itemId": 987,
"itemType": 987,
"lastPublishDate": "xyz789",
"namespaceId": 987,
"owningPublicationId": 123,
"publicationId": 987,
"schema": Schema,
"schemaId": 987,
"taxonomies": [TaxonomyItem],
"title": "xyz789",
"updatedDate": "abc123",
"multiMedia": false
}
ContentFilterQueryType
Values
| Enum Value | Description |
|---|---|
|
|
CUSTOM_META |
Example
"CUSTOM_META"
ContentFragment
Description
Represents a fragment of content.
Fields
| Field Name | Description |
|---|---|
content - Content
|
Returns the content of this fragment. |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
schema - Schema
|
Returns the schema for the item. |
title - String
|
Returns the title of the item. |
updatedDate - String
|
Returns the date the item was updated. |
Possible Types
| ContentFragment Types |
|---|
Example
{
"content": Content,
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "xyz789",
"itemId": 123,
"itemType": 987,
"lastPublishDate": "abc123",
"namespaceId": 123,
"owningPublicationId": 123,
"publicationId": 123,
"schema": Schema,
"title": "xyz789",
"updatedDate": "xyz789"
}
CriteriaScope
Values
| Enum Value | Description |
|---|---|
|
|
Publication |
|
|
Item |
|
|
ItemInPublication |
Example
"Publication"
CustomMeta
Description
Represents custom metadata.
Fields
| Field Name | Description |
|---|---|
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. |
Example
{
"id": "4",
"itemId": 987,
"key": "abc123",
"namespaceId": 987,
"publicationId": 123,
"value": "abc123",
"valueType": "STRING"
}
CustomMetaConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [CustomMetaEdge]
|
a list of edges |
Example
{"edges": [CustomMetaEdge]}
CustomMetaEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
node - CustomMeta
|
The item at the end of the edge |
cursor - String!
|
cursor marks a unique position or index into the connection |
Example
{
"node": CustomMeta,
"cursor": "xyz789"
}
CustomMetaValueType
Values
| Enum Value | Description |
|---|---|
|
|
STRING |
|
|
DATE |
|
|
FLOAT |
|
|
NUMBER |
|
|
UNKNOWN |
Example
"STRING"
DateRangeType
Values
| Enum Value | Description |
|---|---|
|
|
CREATION_DATE |
|
|
UPDATED_DATE |
|
|
INITIAL_PUBLISH_DATE |
|
|
LAST_PUBLISH_DATE |
Example
"CREATION_DATE"
Facet
Description
Represents a facet node.
Fields
| Field Name | Description |
|---|---|
id - String
|
Identifies the unique ID of the facet. |
Possible Types
| Facet Types |
|---|
Example
{"id": "xyz789"}
FacetedSearchResults
Description
Faceted search results.
Fields
| Field Name | Description |
|---|---|
facets - [Facet]
|
Facets. |
Arguments
|
|
results - SearchResultsConnection
|
Search results. |
Example
{
"facets": [Facet],
"results": SearchResultsConnection
}
FieldValueAggregation
FieldValueFacet
Description
Represents a Field facet.
Fields
| Field Name | Description |
|---|---|
id - String
|
Identifies the unique ID of the facet. |
buckets - [FieldValueAggregation]
|
Buckets. |
field - String
|
Field. |
Example
{
"id": "abc123",
"buckets": [FieldValueAggregation],
"field": "xyz789"
}
FilterItemType
Values
| Enum Value | Description |
|---|---|
|
|
PUBLICATION |
|
|
COMPONENT |
|
|
COMPONENT_TEMPLATE |
|
|
PAGE |
|
|
PAGE_TEMPLATE |
|
|
CATEGORY |
|
|
KEYWORD |
Example
"PUBLICATION"
Float
Description
Built-in Float
Example
987.65
ID
Description
Built-in ID
Example
"4"
InputClaimValue
Description
Represents an Ambient Data Framework claim value.
Fields
| Input Field | Description |
|---|---|
type - ClaimValueType!
|
The claim value type. |
uri - String!
|
The claim URI. |
value - String!
|
The claim Value. |
Example
{
"type": "STRING",
"uri": "xyz789",
"value": "abc123"
}
InputComponentPresentationFilter
Description
Filter for the componentPresentation root query. When the filter is applied, only the component presentations matching the filter will be in the query result
Fields
| Input Field | Description |
|---|---|
and - [InputComponentPresentationFilter]
|
List of filters. Items in the query result will match ALL of the elements of the list |
customMeta - InputCustomMetaCriteria
|
|
customMetaDateRange - InputCustomMetaDateRangeCriteria
|
|
dateRange - InputDateRangeCriteriaImpl
|
|
itemTemplate - InputItemTemplateCriteria
|
|
keyword - InputKeywordCriteria
|
|
or - [InputComponentPresentationFilter]
|
List of filters. Items in the query result will match ANY of the elements of the list |
schema - InputSchemaCriteria
|
|
template - InputTemplateCriteria
|
Example
{
"and": [InputComponentPresentationFilter],
"customMeta": InputCustomMetaCriteria,
"customMetaDateRange": InputCustomMetaDateRangeCriteria,
"dateRange": InputDateRangeCriteriaImpl,
"itemTemplate": InputItemTemplateCriteria,
"keyword": InputKeywordCriteria,
"or": [InputComponentPresentationFilter],
"schema": InputSchemaCriteria,
"template": InputTemplateCriteria
}
InputConcept
Example
{
"conceptIds": ["abc123"],
"conceptLabels": ["abc123"],
"connectorId": "xyz789",
"language": "xyz789",
"schemeTitle": "xyz789"
}
InputConceptFacet
Description
Concept Facet
Example
{
"schemeTitle": "abc123",
"connectorId": "abc123",
"first": 987,
"language": "xyz789"
}
InputConceptRecommendation
Description
Input Concept Recommendation
Fields
| Input Field | Description |
|---|---|
boostBy - Float
|
Boost factor for given concept scheme. Default value is 1.0 |
broadenBy - Int
|
Parent level used when broadening the results with hierarchy for given concept scheme. Default value is 0, broadening will not happen. When value is 1 or higher, broadening will happen until given level. |
conceptIds - [String]
|
When defined concept IDs will be used for recommendations |
connectorId - String!
|
Namespace connector ID |
Example
{
"boostBy": 987.65,
"broadenBy": 123,
"conceptIds": ["xyz789"],
"connectorId": "xyz789"
}
InputCriteria
Fields
| Input Field | Description |
|---|---|
and - [InputCriteria]
|
|
concept - InputConcept
|
|
field - InputField
|
|
groupBy - [InputCriteria]
|
|
id - InputId
|
|
languageField - InputFieldLanguage
|
|
localeField - InputLocaleField
|
|
metadataField - InputFieldMetadata
|
|
or - [InputCriteria]
|
Example
{
"and": [InputCriteria],
"concept": InputConcept,
"field": InputField,
"groupBy": [InputCriteria],
"id": InputId,
"languageField": InputFieldLanguage,
"localeField": InputLocaleField,
"metadataField": InputFieldMetadata,
"or": [InputCriteria]
}
InputCustomMetaCriteria
Fields
| Input Field | Description |
|---|---|
key - String!
|
|
scope - CriteriaScope
|
If not given, defaults to Item |
value - String!
|
|
valueType - CustomMetaValueType
|
Example
{
"key": "abc123",
"scope": "Publication",
"value": "xyz789",
"valueType": "STRING"
}
InputCustomMetaDateRangeCriteria
Fields
| Input Field | Description |
|---|---|
end - String!
|
End date & time |
inclusive - Boolean
|
If true, the start and end dates are inclusive |
key - String
|
|
scope - CriteriaScope
|
If not given, defaults to Item |
start - String!
|
Start date & time |
valueType - CustomMetaValueType
|
Example
{
"end": "xyz789",
"inclusive": true,
"key": "xyz789",
"scope": "Publication",
"start": "abc123",
"valueType": "STRING"
}
InputDateRangeCriteriaImpl
Fields
| Input Field | Description |
|---|---|
end - String
|
End date & time |
start - String
|
Start date & time |
type - DateRangeType
|
Date range type |
Example
{
"end": "xyz789",
"start": "abc123",
"type": "CREATION_DATE"
}
InputFacets
Description
Input Facets
Fields
| Input Field | Description |
|---|---|
concepts - [InputConceptFacet]
|
Concept facets |
fields - [InputFieldValueFacet]
|
Field Value facets |
Example
{
"concepts": [InputConceptFacet],
"fields": [InputFieldValueFacet]
}
InputField
InputFieldLanguage
InputFieldMetadata
Fields
| Input Field | Description |
|---|---|
keys - [String]!
|
|
strict - Boolean
|
|
type - MetadataFieldType
|
|
value - String!
|
Example
{
"keys": ["xyz789"],
"strict": false,
"type": "ANY",
"value": "xyz789"
}
InputFieldValueFacet
InputId
Fields
| Input Field | Description |
|---|---|
values - [String]!
|
Example
{"values": ["abc123"]}
InputIshCondition
InputIshItemFilter
Description
Docs Item filter for the topics root query. When the filter is applied, only the items matching the filter will be in the query result
Fields
| Input Field | Description |
|---|---|
and - [InputIshItemFilter]
|
List of filters. Items in the query result will match ALL of the elements of the list |
customMeta - InputCustomMetaCriteria
|
|
or - [InputIshItemFilter]
|
List of filters. Items in the query result will match ANY of the elements of the list |
publicationIds - [Int]
|
list of publication IDs |
Example
{
"and": [InputIshItemFilter],
"customMeta": InputCustomMetaCriteria,
"or": [InputIshItemFilter],
"publicationIds": [987]
}
InputItemFilter
Description
Item filter for the items root query. When the filter is applied, only the items matching the filter will be in the query result
Fields
| Input Field | Description |
|---|---|
and - [InputItemFilter]
|
List of filters. Items in the query result will match ALL of the elements of the list |
customMeta - InputCustomMetaCriteria
|
|
customMetaDateRange - InputCustomMetaDateRangeCriteria
|
|
itemTemplate - InputItemTemplateCriteria
|
|
itemTitle - InputItemTitleCriteria
|
|
itemTypes - [FilterItemType]
|
list of item types to be selected |
keyword - InputKeywordCriteria
|
|
multimedia - InputMultimediaCriteria
|
|
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 |
schema - InputSchemaCriteria
|
|
template - InputTemplateCriteria
|
Example
{
"and": [InputItemFilter],
"customMeta": InputCustomMetaCriteria,
"customMetaDateRange": InputCustomMetaDateRangeCriteria,
"itemTemplate": InputItemTemplateCriteria,
"itemTitle": InputItemTitleCriteria,
"itemTypes": ["PUBLICATION"],
"keyword": InputKeywordCriteria,
"multimedia": InputMultimediaCriteria,
"namespaceIds": [123],
"or": [InputItemFilter],
"publicationIds": [987],
"schema": InputSchemaCriteria,
"template": InputTemplateCriteria
}
InputItemTemplateCriteria
Fields
| Input Field | Description |
|---|---|
templateURI - String!
|
URI of the template. |
Example
{"templateURI": "xyz789"}
InputItemTitleCriteria
Fields
| Input Field | Description |
|---|---|
itemTitle - String!
|
Item title. |
Example
{"itemTitle": "xyz789"}
InputKeywordCriteria
Example
{
"categoryId": 123,
"categoryName": "xyz789",
"key": "xyz789",
"keywordId": 123
}
InputLocaleField
InputMultimediaCriteria
Fields
| Input Field | Description |
|---|---|
multimedia - Boolean!
|
True if this criteria includes only multimedia components, false if it includes only normal components |
Example
{"multimedia": false}
InputPublicationFilter
Description
Represents a filter for a publication query.
Fields
| Input Field | Description |
|---|---|
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. |
Example
{
"queryType": "CUSTOM_META",
"value": "abc123",
"valueType": "STRING"
}
InputRecommendation
Description
Input parameter to enable recommendations
Fields
| Input Field | Description |
|---|---|
concepts - [InputConceptRecommendation]
|
Recommend items for the given concepts |
id - String
|
Recommend items for the given item ID |
mode - RecommendationMode
|
Recommendation mode |
Example
{
"concepts": [InputConceptRecommendation],
"id": "abc123",
"mode": "semantic"
}
InputResultFilter
Description
Filtering and highlighting the search results
Example
{
"excludeFields": ["abc123"],
"highlightInAllIsEnabled": true,
"highlightingIsEnabled": false
}
InputSchemaCriteria
InputSortBy
Description
Sorting the search results
Fields
| Input Field | Description |
|---|---|
fields - [String]!
|
Fields to sort. |
sortAsText - Boolean
|
Sort values as text. |
sortingDirection - SortingDirectionType!
|
Sorting direction. |
Example
{
"fields": ["abc123"],
"sortAsText": false,
"sortingDirection": "ASCENDING"
}
InputSortParam
Description
Represents a typical sort type. When used, the default sorting mechanism (by namespace and by id) is overridden
Fields
| Input Field | Description |
|---|---|
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 |
Example
{
"key": "xyz789",
"keyType": "STRING",
"order": "Ascending",
"sortBy": "CREATION_DATE"
}
InputTemplateCriteria
Fields
| Input Field | Description |
|---|---|
id - Int
|
Id of the template. |
Example
{"id": 987}
Int
Description
Built-in Int
Example
123
IshConceptTopic
Description
Represents a concept topic.
Fields
| Field Name | Description |
|---|---|
abstract - IshTopicSection
|
Topic abstract |
body - IshConceptTopicBody
|
Topic body |
bodyXhtml - String
|
Topic Body XHTML |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
links - [IshTopicLink]
|
Links |
metadata - IshTopicMetadata
|
Metadata |
namespaceId - Int!
|
Identifies the namespace ID of the item. |
nestedTopics - [IshTopic]
|
Nested topics |
owningPublicationId - Int
|
Returns the publication ID of the publication to which this item belongs. |
publicationId - Int!
|
Identifies the publication ID of the item. |
relatedLinks - IshTopicRelatedLinks
|
Related links |
schema - Schema
|
Returns the schema for the item. |
shortDescription - String
|
Topic short description |
title - String
|
Returns the title of the item. |
topicsWithSameLogicalRef - [IshTopicsByLogicalRef]
|
Retrieve all topics that share the same topic ref |
updatedDate - String
|
Returns the date the item was updated. |
url - String
|
Topic Url |
usedConditions - Map
|
Used conditions within topic. |
xhtml - String
|
Topic XHTML |
publication - IshPublication
|
Get publication of this topic. |
publications - [IshPublication]
|
Get all publication this topic appears within. |
Example
{
"abstract": IshTopicSection,
"body": IshConceptTopicBody,
"bodyXhtml": "abc123",
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": "4",
"initialPublishDate": "abc123",
"itemId": 987,
"itemType": 123,
"lastPublishDate": "abc123",
"links": [IshTopicLink],
"metadata": IshTopicMetadata,
"namespaceId": 987,
"nestedTopics": [IshTopic],
"owningPublicationId": 123,
"publicationId": 123,
"relatedLinks": IshTopicRelatedLinks,
"schema": Schema,
"shortDescription": "xyz789",
"title": "xyz789",
"topicsWithSameLogicalRef": [IshTopicsByLogicalRef],
"updatedDate": "abc123",
"url": "xyz789",
"usedConditions": Map,
"xhtml": "abc123",
"publication": IshPublication,
"publications": [IshPublication]
}
IshConceptTopicBody
Description
Represents a concept topic body.
Fields
| Field Name | Description |
|---|---|
anonymousSections - [IshTopicSection]
|
Returns the anonymous topic body sections. |
examples - [IshTopicSection]
|
Return Examples |
sections - [IshTopicSection]
|
Returns the topic body sections. |
Arguments
|
|
xhtml - String
|
Topic XHTML |
Example
{
"anonymousSections": [IshTopicSection],
"examples": [IshTopicSection],
"sections": [IshTopicSection],
"xhtml": "xyz789"
}
IshConditions
Description
Represents a collection of ish conditions.
Example
{
"conditionDefinitions": Map,
"publicationDefinedConditions": Map,
"usedConditions": Map
}
IshGenericTopic
Description
Represents a generic topic.
Fields
| Field Name | Description |
|---|---|
abstract - IshTopicSection
|
Topic abstract |
body - IshGenericTopicBody
|
Topic body |
bodyXhtml - String
|
Topic Body XHTML |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
links - [IshTopicLink]
|
Links |
metadata - IshTopicMetadata
|
Metadata |
namespaceId - Int!
|
Identifies the namespace ID of the item. |
nestedTopics - [IshTopic]
|
Nested topics |
owningPublicationId - Int
|
Returns the publication ID of the publication to which this item belongs. |
publicationId - Int!
|
Identifies the publication ID of the item. |
relatedLinks - IshTopicRelatedLinks
|
Related links |
schema - Schema
|
Returns the schema for the item. |
shortDescription - String
|
Topic short description |
title - String
|
Returns the title of the item. |
topicsWithSameLogicalRef - [IshTopicsByLogicalRef]
|
Retrieve all topics that share the same topic ref |
updatedDate - String
|
Returns the date the item was updated. |
url - String
|
Topic Url |
usedConditions - Map
|
Used conditions within topic. |
xhtml - String
|
Topic XHTML |
publication - IshPublication
|
Get publication of this topic. |
publications - [IshPublication]
|
Get all publication this topic appears within. |
Example
{
"abstract": IshTopicSection,
"body": IshGenericTopicBody,
"bodyXhtml": "xyz789",
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": "4",
"initialPublishDate": "xyz789",
"itemId": 123,
"itemType": 987,
"lastPublishDate": "xyz789",
"links": [IshTopicLink],
"metadata": IshTopicMetadata,
"namespaceId": 123,
"nestedTopics": [IshTopic],
"owningPublicationId": 987,
"publicationId": 987,
"relatedLinks": IshTopicRelatedLinks,
"schema": Schema,
"shortDescription": "xyz789",
"title": "xyz789",
"topicsWithSameLogicalRef": [IshTopicsByLogicalRef],
"updatedDate": "abc123",
"url": "abc123",
"usedConditions": Map,
"xhtml": "abc123",
"publication": IshPublication,
"publications": [IshPublication]
}
IshGenericTopicBody
Description
Represents a generic topic body.
Fields
| Field Name | Description |
|---|---|
anonymousSections - [IshTopicSection]
|
Returns the anonymous topic body sections. |
examples - [IshTopicSection]
|
Return Examples |
sections - [IshTopicSection]
|
Returns the topic body sections. |
Arguments
|
|
xhtml - String
|
Topic XHTML |
Example
{
"anonymousSections": [IshTopicSection],
"examples": [IshTopicSection],
"sections": [IshTopicSection],
"xhtml": "abc123"
}
IshGlossaryEntryTopic
Description
Represents a glossary entry topic.
Fields
| Field Name | Description |
|---|---|
abstract - IshTopicSection
|
Topic abstract |
body - IshConceptTopicBody
|
Topic body |
bodyXhtml - String
|
Topic Body XHTML |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
glossaryDefinition - IshTopicSection
|
Glossary Definition |
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. |
links - [IshTopicLink]
|
Links |
metadata - IshTopicMetadata
|
Metadata |
namespaceId - Int!
|
Identifies the namespace ID of the item. |
nestedTopics - [IshTopic]
|
Nested topics |
owningPublicationId - Int
|
Returns the publication ID of the publication to which this item belongs. |
publicationId - Int!
|
Identifies the publication ID of the item. |
relatedLinks - IshTopicRelatedLinks
|
Related links |
schema - Schema
|
Returns the schema for the item. |
shortDescription - String
|
Topic short description |
title - String
|
Returns the title of the item. |
topicsWithSameLogicalRef - [IshTopicsByLogicalRef]
|
Retrieve all topics that share the same topic ref |
updatedDate - String
|
Returns the date the item was updated. |
url - String
|
Topic Url |
usedConditions - Map
|
Used conditions within topic. |
xhtml - String
|
Topic XHTML |
publication - IshPublication
|
Get publication of this topic. |
publications - [IshPublication]
|
Get all publication this topic appears within. |
Example
{
"abstract": IshTopicSection,
"body": IshConceptTopicBody,
"bodyXhtml": "abc123",
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"glossaryDefinition": IshTopicSection,
"id": "4",
"initialPublishDate": "abc123",
"itemId": 123,
"itemType": 123,
"lastPublishDate": "xyz789",
"links": [IshTopicLink],
"metadata": IshTopicMetadata,
"namespaceId": 123,
"nestedTopics": [IshTopic],
"owningPublicationId": 123,
"publicationId": 123,
"relatedLinks": IshTopicRelatedLinks,
"schema": Schema,
"shortDescription": "xyz789",
"title": "abc123",
"topicsWithSameLogicalRef": [IshTopicsByLogicalRef],
"updatedDate": "abc123",
"url": "xyz789",
"usedConditions": Map,
"xhtml": "xyz789",
"publication": IshPublication,
"publications": [IshPublication]
}
IshGlossaryGroupTopic
Description
Represents a glossary group topic.
Fields
| Field Name | Description |
|---|---|
abstract - IshTopicSection
|
Topic abstract |
body - IshConceptTopicBody
|
Topic body |
bodyXhtml - String
|
Topic Body XHTML |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
glossaryEntries - [IshGlossaryEntryTopic]
|
Glossary Entries |
glossaryGroups - [IshGlossaryGroupTopic]
|
Glossary Groups |
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. |
links - [IshTopicLink]
|
Links |
metadata - IshTopicMetadata
|
Metadata |
namespaceId - Int!
|
Identifies the namespace ID of the item. |
nestedTopics - [IshTopic]
|
Nested topics |
owningPublicationId - Int
|
Returns the publication ID of the publication to which this item belongs. |
publicationId - Int!
|
Identifies the publication ID of the item. |
relatedLinks - IshTopicRelatedLinks
|
Related links |
schema - Schema
|
Returns the schema for the item. |
shortDescription - String
|
Topic short description |
title - String
|
Returns the title of the item. |
topicsWithSameLogicalRef - [IshTopicsByLogicalRef]
|
Retrieve all topics that share the same topic ref |
updatedDate - String
|
Returns the date the item was updated. |
url - String
|
Topic Url |
usedConditions - Map
|
Used conditions within topic. |
xhtml - String
|
Topic XHTML |
publication - IshPublication
|
Get publication of this topic. |
publications - [IshPublication]
|
Get all publication this topic appears within. |
Example
{
"abstract": IshTopicSection,
"body": IshConceptTopicBody,
"bodyXhtml": "xyz789",
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"glossaryEntries": [IshGlossaryEntryTopic],
"glossaryGroups": [IshGlossaryGroupTopic],
"id": 4,
"initialPublishDate": "xyz789",
"itemId": 987,
"itemType": 987,
"lastPublishDate": "xyz789",
"links": [IshTopicLink],
"metadata": IshTopicMetadata,
"namespaceId": 987,
"nestedTopics": [IshTopic],
"owningPublicationId": 987,
"publicationId": 987,
"relatedLinks": IshTopicRelatedLinks,
"schema": Schema,
"shortDescription": "xyz789",
"title": "abc123",
"topicsWithSameLogicalRef": [IshTopicsByLogicalRef],
"updatedDate": "xyz789",
"url": "xyz789",
"usedConditions": Map,
"xhtml": "xyz789",
"publication": IshPublication,
"publications": [IshPublication]
}
IshLearningAssessmentTopic
Description
Represents a learning assessment topic.
Fields
| Field Name | Description |
|---|---|
abstract - IshTopicSection
|
Topic abstract |
body - IshLearningAssessmentTopicBody
|
Topic body |
bodyXhtml - String
|
Topic Body XHTML |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
links - [IshTopicLink]
|
Links |
metadata - IshTopicMetadata
|
Metadata |
namespaceId - Int!
|
Identifies the namespace ID of the item. |
nestedTopics - [IshTopic]
|
Nested topics |
owningPublicationId - Int
|
Returns the publication ID of the publication to which this item belongs. |
publicationId - Int!
|
Identifies the publication ID of the item. |
relatedLinks - IshTopicRelatedLinks
|
Related links |
schema - Schema
|
Returns the schema for the item. |
shortDescription - String
|
Topic short description |
title - String
|
Returns the title of the item. |
topicsWithSameLogicalRef - [IshTopicsByLogicalRef]
|
Retrieve all topics that share the same topic ref |
updatedDate - String
|
Returns the date the item was updated. |
url - String
|
Topic Url |
usedConditions - Map
|
Used conditions within topic. |
xhtml - String
|
Topic XHTML |
publication - IshPublication
|
Get publication of this topic. |
publications - [IshPublication]
|
Get all publication this topic appears within. |
Example
{
"abstract": IshTopicSection,
"body": IshLearningAssessmentTopicBody,
"bodyXhtml": "xyz789",
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "abc123",
"itemId": 987,
"itemType": 123,
"lastPublishDate": "abc123",
"links": [IshTopicLink],
"metadata": IshTopicMetadata,
"namespaceId": 123,
"nestedTopics": [IshTopic],
"owningPublicationId": 987,
"publicationId": 123,
"relatedLinks": IshTopicRelatedLinks,
"schema": Schema,
"shortDescription": "abc123",
"title": "xyz789",
"topicsWithSameLogicalRef": [IshTopicsByLogicalRef],
"updatedDate": "xyz789",
"url": "abc123",
"usedConditions": Map,
"xhtml": "abc123",
"publication": IshPublication,
"publications": [IshPublication]
}
IshLearningAssessmentTopicBody
Description
Represents a learning assessment topic body.
Fields
| Field Name | Description |
|---|---|
anonymousSections - [IshTopicSection]
|
Returns the anonymous topic body sections. |
lcDuration - IshTopicSection
|
Return lcDuration |
lcInteraction - [IshTopicSection]
|
Return lcInteraction |
lcIntro - IshTopicSection
|
Return lcIntro |
lcObjectives - IshTopicSection
|
Return lcObjectives |
lcSummary - IshTopicSection
|
Return lcSummary |
sections - [IshTopicSection]
|
Returns the topic body sections. |
Arguments
|
|
xhtml - String
|
Topic XHTML |
Example
{
"anonymousSections": [IshTopicSection],
"lcDuration": IshTopicSection,
"lcInteraction": [IshTopicSection],
"lcIntro": IshTopicSection,
"lcObjectives": IshTopicSection,
"lcSummary": IshTopicSection,
"sections": [IshTopicSection],
"xhtml": "abc123"
}
IshLearningContentTopic
Description
Represents a learning content topic.
Fields
| Field Name | Description |
|---|---|
abstract - IshTopicSection
|
Topic abstract |
body - IshLearningContentTopicBody
|
Topic body |
bodyXhtml - String
|
Topic Body XHTML |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
links - [IshTopicLink]
|
Links |
metadata - IshTopicMetadata
|
Metadata |
namespaceId - Int!
|
Identifies the namespace ID of the item. |
nestedTopics - [IshTopic]
|
Nested topics |
owningPublicationId - Int
|
Returns the publication ID of the publication to which this item belongs. |
publicationId - Int!
|
Identifies the publication ID of the item. |
relatedLinks - IshTopicRelatedLinks
|
Related links |
schema - Schema
|
Returns the schema for the item. |
shortDescription - String
|
Topic short description |
title - String
|
Returns the title of the item. |
topicsWithSameLogicalRef - [IshTopicsByLogicalRef]
|
Retrieve all topics that share the same topic ref |
updatedDate - String
|
Returns the date the item was updated. |
url - String
|
Topic Url |
usedConditions - Map
|
Used conditions within topic. |
xhtml - String
|
Topic XHTML |
publication - IshPublication
|
Get publication of this topic. |
publications - [IshPublication]
|
Get all publication this topic appears within. |
Example
{
"abstract": IshTopicSection,
"body": IshLearningContentTopicBody,
"bodyXhtml": "xyz789",
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "abc123",
"itemId": 987,
"itemType": 123,
"lastPublishDate": "xyz789",
"links": [IshTopicLink],
"metadata": IshTopicMetadata,
"namespaceId": 987,
"nestedTopics": [IshTopic],
"owningPublicationId": 123,
"publicationId": 123,
"relatedLinks": IshTopicRelatedLinks,
"schema": Schema,
"shortDescription": "xyz789",
"title": "abc123",
"topicsWithSameLogicalRef": [IshTopicsByLogicalRef],
"updatedDate": "xyz789",
"url": "abc123",
"usedConditions": Map,
"xhtml": "xyz789",
"publication": IshPublication,
"publications": [IshPublication]
}
IshLearningContentTopicBody
Description
Represents a learning content topic body.
Fields
| Field Name | Description |
|---|---|
anonymousSections - [IshTopicSection]
|
Returns the anonymous topic body sections. |
lcChallenge - IshTopicSection
|
Return lcChallenge |
lcDuration - [IshTopicSection]
|
Return lcDuration |
lcInstruction - IshTopicSection
|
Return lcIntructions |
lcIntro - [IshTopicSection]
|
Return lcIntro |
lcObjectives - [IshTopicSection]
|
Return lcObjectives |
sections - [IshTopicSection]
|
Returns the topic body sections. |
Arguments
|
|
xhtml - String
|
Topic XHTML |
Example
{
"anonymousSections": [IshTopicSection],
"lcChallenge": IshTopicSection,
"lcDuration": [IshTopicSection],
"lcInstruction": IshTopicSection,
"lcIntro": [IshTopicSection],
"lcObjectives": [IshTopicSection],
"sections": [IshTopicSection],
"xhtml": "xyz789"
}
IshLearningOverviewTopic
Description
Represents a learning overview topic.
Fields
| Field Name | Description |
|---|---|
abstract - IshTopicSection
|
Topic abstract |
body - IshLearningOverviewTopicBody
|
Topic body |
bodyXhtml - String
|
Topic Body XHTML |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
links - [IshTopicLink]
|
Links |
metadata - IshTopicMetadata
|
Metadata |
namespaceId - Int!
|
Identifies the namespace ID of the item. |
nestedTopics - [IshTopic]
|
Nested topics |
owningPublicationId - Int
|
Returns the publication ID of the publication to which this item belongs. |
publicationId - Int!
|
Identifies the publication ID of the item. |
relatedLinks - IshTopicRelatedLinks
|
Related links |
schema - Schema
|
Returns the schema for the item. |
shortDescription - String
|
Topic short description |
title - String
|
Returns the title of the item. |
topicsWithSameLogicalRef - [IshTopicsByLogicalRef]
|
Retrieve all topics that share the same topic ref |
updatedDate - String
|
Returns the date the item was updated. |
url - String
|
Topic Url |
usedConditions - Map
|
Used conditions within topic. |
xhtml - String
|
Topic XHTML |
publication - IshPublication
|
Get publication of this topic. |
publications - [IshPublication]
|
Get all publication this topic appears within. |
Example
{
"abstract": IshTopicSection,
"body": IshLearningOverviewTopicBody,
"bodyXhtml": "xyz789",
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "xyz789",
"itemId": 987,
"itemType": 123,
"lastPublishDate": "abc123",
"links": [IshTopicLink],
"metadata": IshTopicMetadata,
"namespaceId": 987,
"nestedTopics": [IshTopic],
"owningPublicationId": 987,
"publicationId": 987,
"relatedLinks": IshTopicRelatedLinks,
"schema": Schema,
"shortDescription": "xyz789",
"title": "xyz789",
"topicsWithSameLogicalRef": [IshTopicsByLogicalRef],
"updatedDate": "abc123",
"url": "abc123",
"usedConditions": Map,
"xhtml": "abc123",
"publication": IshPublication,
"publications": [IshPublication]
}
IshLearningOverviewTopicBody
Description
Represents a learning overview topic body.
Fields
| Field Name | Description |
|---|---|
anonymousSections - [IshTopicSection]
|
Returns the anonymous topic body sections. |
lcAudience - [IshTopicSection]
|
Return lcAudience |
lcDuration - IshTopicSection
|
Return lcDuration |
lcObjectives - IshTopicSection
|
Return lcObjectives |
lcPrereqs - IshTopicSection
|
Return lcPrereqs |
lcResources - IshTopicSection
|
Return lcResources |
sections - [IshTopicSection]
|
Returns the topic body sections. |
Arguments
|
|
xhtml - String
|
Topic XHTML |
Example
{
"anonymousSections": [IshTopicSection],
"lcAudience": [IshTopicSection],
"lcDuration": IshTopicSection,
"lcObjectives": IshTopicSection,
"lcPrereqs": IshTopicSection,
"lcResources": IshTopicSection,
"sections": [IshTopicSection],
"xhtml": "xyz789"
}
IshLearningPlanTopic
Description
Represents a learning plan topic.
Fields
| Field Name | Description |
|---|---|
abstract - IshTopicSection
|
Topic abstract |
body - IshLearningPlanTopicBody
|
Topic body |
bodyXhtml - String
|
Topic Body XHTML |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
links - [IshTopicLink]
|
Links |
metadata - IshTopicMetadata
|
Metadata |
namespaceId - Int!
|
Identifies the namespace ID of the item. |
nestedTopics - [IshTopic]
|
Nested topics |
owningPublicationId - Int
|
Returns the publication ID of the publication to which this item belongs. |
publicationId - Int!
|
Identifies the publication ID of the item. |
relatedLinks - IshTopicRelatedLinks
|
Related links |
schema - Schema
|
Returns the schema for the item. |
shortDescription - String
|
Topic short description |
title - String
|
Returns the title of the item. |
topicsWithSameLogicalRef - [IshTopicsByLogicalRef]
|
Retrieve all topics that share the same topic ref |
updatedDate - String
|
Returns the date the item was updated. |
url - String
|
Topic Url |
usedConditions - Map
|
Used conditions within topic. |
xhtml - String
|
Topic XHTML |
publication - IshPublication
|
Get publication of this topic. |
publications - [IshPublication]
|
Get all publication this topic appears within. |
Example
{
"abstract": IshTopicSection,
"body": IshLearningPlanTopicBody,
"bodyXhtml": "xyz789",
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "abc123",
"itemId": 987,
"itemType": 987,
"lastPublishDate": "xyz789",
"links": [IshTopicLink],
"metadata": IshTopicMetadata,
"namespaceId": 987,
"nestedTopics": [IshTopic],
"owningPublicationId": 987,
"publicationId": 123,
"relatedLinks": IshTopicRelatedLinks,
"schema": Schema,
"shortDescription": "abc123",
"title": "xyz789",
"topicsWithSameLogicalRef": [IshTopicsByLogicalRef],
"updatedDate": "abc123",
"url": "abc123",
"usedConditions": Map,
"xhtml": "abc123",
"publication": IshPublication,
"publications": [IshPublication]
}
IshLearningPlanTopicBody
Description
Represents a learning plan topic body.
Fields
| Field Name | Description |
|---|---|
anonymousSections - [IshTopicSection]
|
Returns the anonymous topic body sections. |
lcGapAnalysis - IshTopicSection
|
Return lcGapAnalysis |
lcIntervention - IshTopicSection
|
Return lcIntervention |
lcNeedsAnalysis - IshTopicSection
|
Return lcNeedsAnalysis |
lcProject - IshTopicSection
|
Return lcProject |
lcTechnical - IshTopicSection
|
Return lcTechnical |
sections - [IshTopicSection]
|
Returns the topic body sections. |
Arguments
|
|
xhtml - String
|
Topic XHTML |
Example
{
"anonymousSections": [IshTopicSection],
"lcGapAnalysis": IshTopicSection,
"lcIntervention": IshTopicSection,
"lcNeedsAnalysis": IshTopicSection,
"lcProject": IshTopicSection,
"lcTechnical": IshTopicSection,
"sections": [IshTopicSection],
"xhtml": "xyz789"
}
IshLearningSummaryTopic
Description
Represents a learning summary topic.
Fields
| Field Name | Description |
|---|---|
abstract - IshTopicSection
|
Topic abstract |
body - IshLearningSummaryTopicBody
|
Topic body |
bodyXhtml - String
|
Topic Body XHTML |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
links - [IshTopicLink]
|
Links |
metadata - IshTopicMetadata
|
Metadata |
namespaceId - Int!
|
Identifies the namespace ID of the item. |
nestedTopics - [IshTopic]
|
Nested topics |
owningPublicationId - Int
|
Returns the publication ID of the publication to which this item belongs. |
publicationId - Int!
|
Identifies the publication ID of the item. |
relatedLinks - IshTopicRelatedLinks
|
Related links |
schema - Schema
|
Returns the schema for the item. |
shortDescription - String
|
Topic short description |
title - String
|
Returns the title of the item. |
topicsWithSameLogicalRef - [IshTopicsByLogicalRef]
|
Retrieve all topics that share the same topic ref |
updatedDate - String
|
Returns the date the item was updated. |
url - String
|
Topic Url |
usedConditions - Map
|
Used conditions within topic. |
xhtml - String
|
Topic XHTML |
publication - IshPublication
|
Get publication of this topic. |
publications - [IshPublication]
|
Get all publication this topic appears within. |
Example
{
"abstract": IshTopicSection,
"body": IshLearningSummaryTopicBody,
"bodyXhtml": "abc123",
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": "4",
"initialPublishDate": "xyz789",
"itemId": 987,
"itemType": 987,
"lastPublishDate": "xyz789",
"links": [IshTopicLink],
"metadata": IshTopicMetadata,
"namespaceId": 123,
"nestedTopics": [IshTopic],
"owningPublicationId": 123,
"publicationId": 987,
"relatedLinks": IshTopicRelatedLinks,
"schema": Schema,
"shortDescription": "xyz789",
"title": "abc123",
"topicsWithSameLogicalRef": [IshTopicsByLogicalRef],
"updatedDate": "abc123",
"url": "xyz789",
"usedConditions": Map,
"xhtml": "abc123",
"publication": IshPublication,
"publications": [IshPublication]
}
IshLearningSummaryTopicBody
Description
Represents a learning summary topic body.
Fields
| Field Name | Description |
|---|---|
anonymousSections - [IshTopicSection]
|
Returns the anonymous topic body sections. |
lcNextSteps - [IshTopicSection]
|
Return lcNextSteps |
lcObjectives - [IshTopicSection]
|
Return lcObjectives |
lcResources - [IshTopicSection]
|
Return lcResources |
lcReview - [IshTopicSection]
|
Return lcReview |
lcSummary - [IshTopicSection]
|
Return lcSummary |
sections - [IshTopicSection]
|
Returns the topic body sections. |
Arguments
|
|
xhtml - String
|
Topic XHTML |
Example
{
"anonymousSections": [IshTopicSection],
"lcNextSteps": [IshTopicSection],
"lcObjectives": [IshTopicSection],
"lcResources": [IshTopicSection],
"lcReview": [IshTopicSection],
"lcSummary": [IshTopicSection],
"sections": [IshTopicSection],
"xhtml": "abc123"
}
IshPublication
Fields
| Field Name | Description |
|---|---|
conditions - IshConditions
|
Get conditions for the publication. |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
metadata - IshPublicationMetadata
|
Metadata |
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. |
schema - Schema
|
Returns the schema for the item. |
title - String
|
Returns the title of the item. |
updatedDate - String
|
Returns the date the item was updated. |
Example
{
"conditions": IshConditions,
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": "4",
"initialPublishDate": "abc123",
"itemId": 987,
"itemType": 123,
"lastPublishDate": "abc123",
"metadata": IshPublicationMetadata,
"multimediaPath": "abc123",
"multimediaUrl": "xyz789",
"namespaceId": 123,
"owningPublicationId": 987,
"publicationId": 987,
"publicationKey": "xyz789",
"publicationPath": "xyz789",
"publicationUrl": "xyz789",
"schema": Schema,
"title": "xyz789",
"updatedDate": "abc123"
}
IshPublicationConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [IshPublicationEdge]
|
a list of edges |
Example
{"edges": [IshPublicationEdge]}
IshPublicationEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
node - IshPublication
|
The item at the end of the edge |
cursor - String!
|
cursor marks a unique position or index into the connection |
Example
{
"node": IshPublication,
"cursor": "abc123"
}
IshPublicationMetadata
Fields
| Field Name | Description |
|---|---|
createdOn - String
|
Created On |
locale - String
|
Locale |
logicalRef - String
|
Logical Ref |
modifiedOn - String
|
Modified On |
onlineStatus - String
|
Online Status |
productFamilies - [String]
|
Product Families |
productReleases - [String]
|
Product Releases |
title - String
|
Title |
version - String
|
Version |
Example
{
"createdOn": "abc123",
"locale": "abc123",
"logicalRef": "xyz789",
"modifiedOn": "xyz789",
"onlineStatus": "xyz789",
"productFamilies": ["abc123"],
"productReleases": ["abc123"],
"title": "abc123",
"version": "xyz789"
}
IshReferenceTopic
Description
Represents a reference topic.
Fields
| Field Name | Description |
|---|---|
abstract - IshTopicSection
|
Topic abstract |
body - IshReferenceTopicBody
|
Topic body |
bodyXhtml - String
|
Topic Body XHTML |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
links - [IshTopicLink]
|
Links |
metadata - IshTopicMetadata
|
Metadata |
namespaceId - Int!
|
Identifies the namespace ID of the item. |
nestedTopics - [IshTopic]
|
Nested topics |
owningPublicationId - Int
|
Returns the publication ID of the publication to which this item belongs. |
publicationId - Int!
|
Identifies the publication ID of the item. |
relatedLinks - IshTopicRelatedLinks
|
Related links |
schema - Schema
|
Returns the schema for the item. |
shortDescription - String
|
Topic short description |
title - String
|
Returns the title of the item. |
topicsWithSameLogicalRef - [IshTopicsByLogicalRef]
|
Retrieve all topics that share the same topic ref |
updatedDate - String
|
Returns the date the item was updated. |
url - String
|
Topic Url |
usedConditions - Map
|
Used conditions within topic. |
xhtml - String
|
Topic XHTML |
publication - IshPublication
|
Get publication of this topic. |
publications - [IshPublication]
|
Get all publication this topic appears within. |
Example
{
"abstract": IshTopicSection,
"body": IshReferenceTopicBody,
"bodyXhtml": "abc123",
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": "4",
"initialPublishDate": "abc123",
"itemId": 123,
"itemType": 987,
"lastPublishDate": "xyz789",
"links": [IshTopicLink],
"metadata": IshTopicMetadata,
"namespaceId": 987,
"nestedTopics": [IshTopic],
"owningPublicationId": 987,
"publicationId": 123,
"relatedLinks": IshTopicRelatedLinks,
"schema": Schema,
"shortDescription": "abc123",
"title": "abc123",
"topicsWithSameLogicalRef": [IshTopicsByLogicalRef],
"updatedDate": "abc123",
"url": "xyz789",
"usedConditions": Map,
"xhtml": "xyz789",
"publication": IshPublication,
"publications": [IshPublication]
}
IshReferenceTopicBody
Description
Represents a reference topic body.
Fields
| Field Name | Description |
|---|---|
anonymousSections - [IshTopicSection]
|
Returns the anonymous topic body sections. |
examples - [IshTopicSection]
|
Return Examples |
refSyn - [IshTopicSection]
|
Return syntax or signature contents |
sections - [IshTopicSection]
|
Returns the topic body sections. |
Arguments
|
|
xhtml - String
|
Topic XHTML |
Example
{
"anonymousSections": [IshTopicSection],
"examples": [IshTopicSection],
"refSyn": [IshTopicSection],
"sections": [IshTopicSection],
"xhtml": "abc123"
}
IshTaskTopic
Description
Represents a task topic.
Fields
| Field Name | Description |
|---|---|
abstract - IshTopicSection
|
Topic abstract |
body - IshTaskTopicBody
|
Topic body |
bodyXhtml - String
|
Topic Body XHTML |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
links - [IshTopicLink]
|
Links |
metadata - IshTopicMetadata
|
Metadata |
namespaceId - Int!
|
Identifies the namespace ID of the item. |
nestedTopics - [IshTopic]
|
Nested topics |
owningPublicationId - Int
|
Returns the publication ID of the publication to which this item belongs. |
publicationId - Int!
|
Identifies the publication ID of the item. |
relatedLinks - IshTopicRelatedLinks
|
Related links |
schema - Schema
|
Returns the schema for the item. |
shortDescription - String
|
Topic short description |
title - String
|
Returns the title of the item. |
topicsWithSameLogicalRef - [IshTopicsByLogicalRef]
|
Retrieve all topics that share the same topic ref |
updatedDate - String
|
Returns the date the item was updated. |
url - String
|
Topic Url |
usedConditions - Map
|
Used conditions within topic. |
xhtml - String
|
Topic XHTML |
publication - IshPublication
|
Get publication of this topic. |
publications - [IshPublication]
|
Get all publication this topic appears within. |
Example
{
"abstract": IshTopicSection,
"body": IshTaskTopicBody,
"bodyXhtml": "abc123",
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": "4",
"initialPublishDate": "xyz789",
"itemId": 987,
"itemType": 123,
"lastPublishDate": "xyz789",
"links": [IshTopicLink],
"metadata": IshTopicMetadata,
"namespaceId": 987,
"nestedTopics": [IshTopic],
"owningPublicationId": 123,
"publicationId": 987,
"relatedLinks": IshTopicRelatedLinks,
"schema": Schema,
"shortDescription": "abc123",
"title": "xyz789",
"topicsWithSameLogicalRef": [IshTopicsByLogicalRef],
"updatedDate": "abc123",
"url": "xyz789",
"usedConditions": Map,
"xhtml": "xyz789",
"publication": IshPublication,
"publications": [IshPublication]
}
IshTaskTopicBody
Description
Represents a task topic body.
Fields
| Field Name | Description |
|---|---|
anonymousSections - [IshTopicSection]
|
Returns the anonymous topic body sections. |
context - IshTopicSection
|
Return Context |
examples - [IshTopicSection]
|
Return Examples |
postreq - IshTopicSection
|
Return Postreq |
prereq - IshTopicSection
|
Return Prereq |
result - IshTopicSection
|
Return Result |
sections - [IshTopicSection]
|
Returns the topic body sections. |
Arguments
|
|
steps - IshTopicSection
|
Return Steps |
xhtml - String
|
Topic XHTML |
Example
{
"anonymousSections": [IshTopicSection],
"context": IshTopicSection,
"examples": [IshTopicSection],
"postreq": IshTopicSection,
"prereq": IshTopicSection,
"result": IshTopicSection,
"sections": [IshTopicSection],
"steps": IshTopicSection,
"xhtml": "abc123"
}
IshToc
Description
Table of Contents
Fields
| Field Name | Description |
|---|---|
entries - [IshTocItem]
|
Returns the child entries in the TOC. |
Arguments
|
|
id - ID
|
Identifies the unique ID of the TOC. |
title - String
|
Returns the title of the TOC. |
hasChildren - Boolean
|
Returns true if TOC has entries below it. |
Example
{
"entries": [IshTocItem],
"id": 4,
"title": "abc123",
"hasChildren": false
}
IshTocItem
Description
Table of Contents
Fields
| Field Name | Description |
|---|---|
customMeta - Map
|
Returns custom meta for this TOC entry. |
entries - [IshTocItem]
|
Returns TOC entries. |
id - ID
|
Identifies the unique ID of the TOC item. |
title - String
|
Returns the title of the table of contents. |
tocId - String
|
Returns the id of the table of contents entry. |
url - String
|
Returns the url for the entry in the TOC. |
hasChildren - Boolean
|
Returns true if this TOC item has entries below it. |
Example
{
"customMeta": Map,
"entries": [IshTocItem],
"id": 4,
"title": "abc123",
"tocId": "xyz789",
"url": "abc123",
"hasChildren": false
}
IshTopic
Description
Represents an ish Topic.
Fields
| Field Name | Description |
|---|---|
abstract - IshTopicSection
|
Topic abstract |
bodyXhtml - String
|
Topic Body XHTML |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
links - [IshTopicLink]
|
Links |
metadata - IshTopicMetadata
|
Metadata |
namespaceId - Int!
|
Identifies the namespace ID of the item. |
nestedTopics - [IshTopic]
|
Nested topics |
owningPublicationId - Int
|
Returns the publication ID of the publication to which this item belongs. |
publicationId - Int!
|
Identifies the publication ID of the item. |
relatedLinks - IshTopicRelatedLinks
|
Related links |
schema - Schema
|
Returns the schema for the item. |
shortDescription - String
|
Topic short description |
title - String
|
Returns the title of the item. |
topicsWithSameLogicalRef - [IshTopicsByLogicalRef]
|
Retrieve all topics that share the same topic ref |
updatedDate - String
|
Returns the date the item was updated. |
url - String
|
Topic Url |
usedConditions - Map
|
Used conditions within topic. |
xhtml - String
|
Topic XHTML |
publication - IshPublication
|
Get publication of this topic. |
publications - [IshPublication]
|
Get all publication this topic appears within. |
Example
{
"abstract": IshTopicSection,
"bodyXhtml": "xyz789",
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": "4",
"initialPublishDate": "abc123",
"itemId": 123,
"itemType": 123,
"lastPublishDate": "abc123",
"links": [IshTopicLink],
"metadata": IshTopicMetadata,
"namespaceId": 123,
"nestedTopics": [IshTopic],
"owningPublicationId": 123,
"publicationId": 987,
"relatedLinks": IshTopicRelatedLinks,
"schema": Schema,
"shortDescription": "abc123",
"title": "abc123",
"topicsWithSameLogicalRef": [IshTopicsByLogicalRef],
"updatedDate": "abc123",
"url": "abc123",
"usedConditions": Map,
"xhtml": "abc123",
"publication": IshPublication,
"publications": [IshPublication]
}
IshTopicConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [IshTopicEdge]
|
a list of edges |
Example
{"edges": [IshTopicEdge]}
IshTopicEdge
IshTopicLink
IshTopicLinkRenderOptions
Values
| Enum Value | Description |
|---|---|
|
|
ABSOLUTE |
|
|
RELATIVE |
Example
"ABSOLUTE"
IshTopicMetadata
Fields
| Field Name | Description |
|---|---|
createdOn - String
|
Created On |
locale - String
|
Locale |
locales - [String]
|
Locales |
logicalRef - String
|
Logical Ref |
modifiedOn - String
|
Modified On |
onlineStatus - String
|
Online Status |
productFamilies - [String]
|
Product Families |
productFamily - String
|
Product Family |
productRelease - String
|
Product Release |
productReleases - [String]
|
Product Releases |
publicationTitle - String
|
Publication Title |
publicationTitles - [String]
|
Publication Titles |
title - String
|
Title |
version - String
|
Version |
Example
{
"createdOn": "abc123",
"locale": "abc123",
"locales": ["xyz789"],
"logicalRef": "abc123",
"modifiedOn": "xyz789",
"onlineStatus": "xyz789",
"productFamilies": ["xyz789"],
"productFamily": "xyz789",
"productRelease": "xyz789",
"productReleases": ["xyz789"],
"publicationTitle": "xyz789",
"publicationTitles": ["xyz789"],
"title": "xyz789",
"version": "xyz789"
}
IshTopicRelatedLinks
Fields
| Field Name | Description |
|---|---|
links - [IshTopicLink]
|
Links. |
xhtml - String
|
Xhtml. |
Example
{
"links": [IshTopicLink],
"xhtml": "abc123"
}
IshTopicRenderOptions
Values
| Enum Value | Description |
|---|---|
|
|
RENDER_IMAGES |
|
|
FAST_RENDER_IMAGES |
|
|
NONE |
Example
"RENDER_IMAGES"
IshTopicSection
Description
Represents a topic section.
Fields
| Field Name | Description |
|---|---|
id - ID
|
Identifies the unique ID of the node. |
links - [IshTopicLink]
|
Links |
title - String
|
Name |
type - String
|
Type |
xhtml - String
|
XHTML |
Example
{
"id": "4",
"links": [IshTopicLink],
"title": "abc123",
"type": "abc123",
"xhtml": "abc123"
}
IshTopicsByLogicalRef
Fields
| Field Name | Description |
|---|---|
itemId - Int!
|
Identifies the topic ID. |
publicationId - Int!
|
Identifies the publication ID of the topic. |
topic - IshTopic
|
Returns the full topic. |
Arguments
|
|
topicTitle - String
|
Returns the title of the topic. |
url - String
|
Returns the url of the topic. |
Example
{
"itemId": 987,
"publicationId": 123,
"topic": IshTopic,
"topicTitle": "xyz789",
"url": "abc123"
}
Item
Description
Represents an item. The root of all content models.
Fields
| Field Name | Description |
|---|---|
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
schema - Schema
|
Returns the schema for the item. |
title - String
|
Returns the title of the item. |
updatedDate - String
|
Returns the date the item was updated. |
Possible Types
| Item Types |
|---|
Example
{
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": "4",
"initialPublishDate": "abc123",
"itemId": 123,
"itemType": 123,
"lastPublishDate": "xyz789",
"namespaceId": 987,
"owningPublicationId": 123,
"publicationId": 123,
"schema": Schema,
"title": "xyz789",
"updatedDate": "abc123"
}
ItemConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [ItemEdge]
|
a list of edges |
Example
{"edges": [ItemEdge]}
ItemEdge
Keyword
Description
Represents a keyword taxonomy item.
Fields
| Field Name | Description |
|---|---|
children - TaxonomyItemConnection
|
Returns the child taxonomies for the taxonomy. |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
name - String
|
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. |
schema - Schema
|
Returns the schema for 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. |
Example
{
"children": TaxonomyItemConnection,
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"depth": 123,
"description": "xyz789",
"id": "4",
"initialPublishDate": "abc123",
"itemId": 123,
"itemType": 123,
"key": "xyz789",
"lastPublishDate": "abc123",
"name": "abc123",
"namespaceId": 123,
"owningPublicationId": 123,
"parent": TaxonomyItem,
"publicationId": 123,
"schema": Schema,
"taxonomyId": 123,
"taxonomyType": "KEYWORD",
"title": "xyz789",
"totalRelatedItems": 987,
"updatedDate": "abc123",
"hasChildren": true,
"abstract": false,
"navigable": false,
"usedForIdentification": true
}
KeywordConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [KeywordEdge]
|
a list of edges |
Example
{"edges": [KeywordEdge]}
KeywordEdge
Link
Description
Represents a Link.
Example
{
"itemId": 123,
"namespaceId": 987,
"publicationId": 987,
"type": "PAGE",
"url": "abc123",
"page": PageItem
}
LinkType
Description
Represents the type of link.
Values
| Enum Value | Description |
|---|---|
|
|
A page link. |
|
|
A component link. |
|
|
A binary link. |
|
|
A dynamic component link. |
Example
"PAGE"
Long
Description
A 64-bit signed integer
Example
{}
Map
Description
Coercing Map
Example
Map
MappingStrategyType
Description
Represents the type of mapping strategy used.
Values
| Enum Value | Description |
|---|---|
|
|
Resolve based on using cd_dynamic configuration static mappings. |
|
|
Resolve based on storage values of specific publication properties in Publication table. |
|
|
Dynamically matches publication properties against values in Publication DB table. |
|
|
Resolve by attempting to use page metadata against and finding a matched publication by relative path. |
Example
"STATIC"
MetadataFieldType
Description
To define the metadata field type
Values
| Enum Value | Description |
|---|---|
|
|
ANY |
|
|
DATE |
|
|
DOUBLE |
|
|
LONG |
|
|
TEXT |
Example
"ANY"
MetadataType
Values
| Enum Value | Description |
|---|---|
|
|
STRING |
|
|
DATE |
|
|
FLOAT |
Example
"STRING"
Page
Description
Represents a page.
Fields
| Field Name | Description |
|---|---|
components - [ContentComponent]
|
Returns the list of components in region. |
Arguments
|
|
containerItems - [Item]
|
Returns the items in this container. |
Arguments
|
|
content - Content
|
Returns the content in the page. |
Arguments
|
|
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the region. Can be used to group related fields together. |
Arguments
|
|
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. |
name - String
|
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 - RawContent
|
Returns the raw content in the page. |
Arguments
|
|
regions - [PageRegion]
|
Returns the regions for the page. |
Arguments
|
|
schema - Schema
|
Returns the schema for the item. |
taxonomies - [TaxonomyItem]
|
Returns the list of taxonomies for the item. |
Arguments
|
|
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. |
Example
{
"components": [ContentComponent],
"containerItems": [Item],
"content": Content,
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"fileName": "abc123",
"id": "4",
"initialPublishDate": "xyz789",
"itemId": 987,
"itemType": 123,
"lastPublishDate": "abc123",
"name": "abc123",
"namespaceId": 987,
"owningPublicationId": 987,
"pageTemplate": Template,
"publicationId": 987,
"rawContent": RawContent,
"regions": [PageRegion],
"schema": Schema,
"taxonomies": [TaxonomyItem],
"title": "abc123",
"updatedDate": "abc123",
"url": "xyz789"
}
PageConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [PageEdge]
|
a list of edges |
Example
{"edges": [PageEdge]}
PageEdge
PageInfo
Description
Information about pagination in a connection.
Fields
| Field Name | Description |
|---|---|
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
endCursor - String
|
When paginating forwards, the cursor to continue. |
Example
{
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123",
"endCursor": "xyz789"
}
PageItem
Description
Represents a page item. The root of all page models.
Fields
| Field Name | Description |
|---|---|
components - [ContentComponent]
|
Returns the list of components in region. |
Arguments
|
|
containerItems - [Item]
|
Returns the items in this container. |
Arguments
|
|
content - Content
|
Returns the content in the page. |
Arguments
|
|
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the region. Can be used to group related fields together. |
Arguments
|
|
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. |
name - String
|
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 - RawContent
|
Returns the raw content in the page. |
Arguments
|
|
regions - [PageRegion]
|
Returns the regions for the page. |
Arguments
|
|
schema - Schema
|
Returns the schema for the item. |
taxonomies - [TaxonomyItem]
|
Returns the list of taxonomies for the item. |
Arguments
|
|
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. |
Possible Types
| PageItem Types |
|---|
Example
{
"components": [ContentComponent],
"containerItems": [Item],
"content": Content,
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"fileName": "xyz789",
"id": "4",
"initialPublishDate": "xyz789",
"itemId": 987,
"itemType": 123,
"lastPublishDate": "abc123",
"name": "abc123",
"namespaceId": 987,
"owningPublicationId": 123,
"pageTemplate": Template,
"publicationId": 123,
"rawContent": RawContent,
"regions": [PageRegion],
"schema": Schema,
"taxonomies": [TaxonomyItem],
"title": "xyz789",
"updatedDate": "xyz789",
"url": "xyz789"
}
PageRegion
Description
Represents a page region.
Fields
| Field Name | Description |
|---|---|
components - [ContentComponent]
|
Returns the list of components in region. |
Arguments
|
|
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the region. Can be used to group related fields together. |
Arguments
|
|
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. |
name - String
|
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. |
publicationId - Int!
|
Identifies the publication ID of the item. |
regions - [PageRegion]
|
Returns the regions for the page. |
Arguments
|
|
schema - Schema
|
Returns the schema for the item. |
title - String
|
Returns the title of the item. |
updatedDate - String
|
Returns the date the item was updated. |
Possible Types
| PageRegion Types |
|---|
Example
{
"components": [ContentComponent],
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "xyz789",
"itemId": 987,
"itemType": 123,
"lastPublishDate": "xyz789",
"name": "abc123",
"namespaceId": 123,
"owningPublicationId": 987,
"publicationId": 123,
"regions": [PageRegion],
"schema": Schema,
"title": "abc123",
"updatedDate": "abc123"
}
PageSitemapItem
Example
{
"id": "4",
"originalTitle": "xyz789",
"publishedDate": "abc123",
"title": "xyz789",
"type": "abc123",
"url": "abc123",
"visible": false
}
Publication
Description
Represents a publication.
Fields
| Field Name | Description |
|---|---|
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
schema - Schema
|
Returns the schema for the item. |
title - String
|
Returns the title of the item. |
updatedDate - String
|
Returns the date the item was updated. |
Example
{
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": "4",
"initialPublishDate": "xyz789",
"itemId": 123,
"itemType": 123,
"lastPublishDate": "xyz789",
"multimediaPath": "xyz789",
"multimediaUrl": "xyz789",
"namespaceId": 123,
"owningPublicationId": 123,
"publicationId": 123,
"publicationKey": "xyz789",
"publicationPath": "abc123",
"publicationUrl": "abc123",
"schema": Schema,
"title": "abc123",
"updatedDate": "abc123"
}
PublicationConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [PublicationEdge]
|
a list of edges |
Example
{"edges": [PublicationEdge]}
PublicationEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
node - Publication
|
The item at the end of the edge |
cursor - String!
|
cursor marks a unique position or index into the connection |
Example
{
"node": Publication,
"cursor": "xyz789"
}
PublicationMapping
Description
Represents a publication mapping.
Fields
| Field Name | Description |
|---|---|
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. |
Example
{
"domain": "xyz789",
"namespaceId": 987,
"path": "abc123",
"pathScanDepth": 123,
"port": "abc123",
"protocol": "abc123",
"publicationId": 123
}
PublicationMappingConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [PublicationMappingEdge]
|
a list of edges |
Example
{"edges": [PublicationMappingEdge]}
PublicationMappingEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
node - PublicationMapping
|
The item at the end of the edge |
cursor - String!
|
cursor marks a unique position or index into the connection |
Example
{
"node": PublicationMapping,
"cursor": "xyz789"
}
RawContent
Description
Represents an item with content.
Example
{
"charSet": "xyz789",
"content": "xyz789",
"data": Map,
"id": 4
}
RecommendationMode
Values
| Enum Value | Description |
|---|---|
|
|
semantic |
|
|
smart |
Example
"semantic"
Schema
Description
Represents a schema.
Example
{
"content": Map,
"namespaceId": 123,
"publicationId": 987,
"schemaId": 123,
"title": "abc123"
}
Search
Fields
| Field Name | Description |
|---|---|
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. |
title - String
|
The title of the search result containing no tags (indexed by locale). |
url - String
|
The url of the search result. |
Example
{
"author": "xyz789",
"binaryAuthor": "xyz789",
"binaryContentLength": {},
"binaryContentType": "xyz789",
"binaryCreatedDate": "xyz789",
"binaryFileName": "abc123",
"binaryLanguage": "xyz789",
"binaryTitle": "xyz789",
"conceptSchemes": [ConceptScheme],
"createdDate": "xyz789",
"fields": Map,
"highlighted": Map,
"id": "abc123",
"itemType": "xyz789",
"locale": "abc123",
"location": "xyz789",
"mainContentField": "xyz789",
"majorVersion": "xyz789",
"minorVersion": "abc123",
"modifiedDate": "abc123",
"namespace": "abc123",
"publicationId": 987,
"publicationTitle": "xyz789",
"rawContent": "abc123",
"rawLanguageTitle": "abc123",
"schemaId": "abc123",
"score": 987.65,
"title": "abc123",
"url": "xyz789"
}
SearchResults
SearchResultsConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
hits - Int
|
The total number of the hits |
edges - [SearchResultsEdge]
|
a list of edges |
pageInfo - PageInfo!
|
details about this specific page |
Example
{
"hits": 987,
"edges": [SearchResultsEdge],
"pageInfo": PageInfo
}
SearchResultsEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
node - SearchResults
|
The item at the end of the edge |
cursor - String!
|
cursor marks a unique position or index into the connection |
Example
{
"node": SearchResults,
"cursor": "abc123"
}
SitemapItem
Description
Sitemap Item
Fields
| Field Name | Description |
|---|---|
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 |
Possible Types
| SitemapItem Types |
|---|
Example
{
"id": 4,
"originalTitle": "abc123",
"publishedDate": "abc123",
"title": "abc123",
"type": "abc123",
"url": "xyz789",
"visible": true
}
SortFieldType
Description
These are the fields that allow sorting
Values
| Enum Value | Description |
|---|---|
|
|
CREATION_DATE |
|
|
INITIAL_PUBLISH_DATE |
|
|
ITEM_ID |
|
|
ITEM_TYPE |
|
|
LAST_PUBLISH_DATE |
|
|
NAMESPACE_ID |
|
|
OWNING_PUBLICATION_ID |
|
|
PUBLICATION_ID |
|
|
TITLE |
|
|
UPDATED_DATE |
|
|
CUSTOM_META |
Example
"CREATION_DATE"
SortOrderType
Description
Represents a type of natural sort: descending or ascending
Values
| Enum Value | Description |
|---|---|
|
|
A string value |
|
|
A string value |
Example
"Ascending"
SortingDirectionType
Description
Sorting direction of results
Values
| Enum Value | Description |
|---|---|
|
|
ASCENDING |
|
|
DESCENDING |
Example
"ASCENDING"
String
Description
Built-in String
Example
"abc123"
StructureGroup
Description
Represents a structure group.
Fields
| Field Name | Description |
|---|---|
children - TaxonomyItemConnection
|
Returns the child taxonomies for the taxonomy. |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
schema - Schema
|
Returns the schema for 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. |
Example
{
"children": TaxonomyItemConnection,
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"depth": 987,
"directory": "abc123",
"id": "4",
"initialPublishDate": "abc123",
"itemId": 987,
"itemType": 123,
"key": "xyz789",
"lastPublishDate": "abc123",
"namespaceId": 123,
"owningPublicationId": 987,
"parent": TaxonomyItem,
"publicationId": 987,
"schema": Schema,
"taxonomyId": 123,
"taxonomyType": "KEYWORD",
"title": "xyz789",
"updatedDate": "abc123",
"hasChildren": false,
"abstract": true,
"navigable": true
}
StructureGroupConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [StructureGroupEdge]
|
a list of edges |
Example
{"edges": [StructureGroupEdge]}
StructureGroupEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
node - StructureGroup
|
The item at the end of the edge |
cursor - String!
|
cursor marks a unique position or index into the connection |
Example
{
"node": StructureGroup,
"cursor": "xyz789"
}
Taggable
Description
Represents a related set of entities.
Fields
| Field Name | Description |
|---|---|
taxonomies - [TaxonomyItem]
|
Returns the list of taxonomies for the item. |
Arguments
|
|
Possible Types
| Taggable Types |
|---|
Example
{"taxonomies": [TaxonomyItem]}
TaxonomyItem
Description
Represents a taxonomy item.
Fields
| Field Name | Description |
|---|---|
children - TaxonomyItemConnection
|
Returns the child taxonomies for the taxonomy. |
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
schema - Schema
|
Returns the schema for 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. |
Possible Types
| TaxonomyItem Types |
|---|
Example
{
"children": TaxonomyItemConnection,
"creationDate": "xyz789",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"depth": 123,
"id": 4,
"initialPublishDate": "xyz789",
"itemId": 123,
"itemType": 987,
"key": "abc123",
"lastPublishDate": "xyz789",
"namespaceId": 987,
"owningPublicationId": 987,
"parent": TaxonomyItem,
"publicationId": 123,
"schema": Schema,
"taxonomyId": 987,
"taxonomyType": "KEYWORD",
"title": "xyz789",
"updatedDate": "xyz789",
"hasChildren": true,
"abstract": false,
"navigable": true
}
TaxonomyItemConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [TaxonomyItemEdge]
|
a list of edges |
Example
{"edges": [TaxonomyItemEdge]}
TaxonomyItemEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
node - TaxonomyItem
|
The item at the end of the edge |
cursor - String!
|
cursor marks a unique position or index into the connection |
Example
{
"node": TaxonomyItem,
"cursor": "abc123"
}
TaxonomyNarrowerConceptsConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [TaxonomyNarrowerConceptsEdge]
|
a list of edges |
Example
{"edges": [TaxonomyNarrowerConceptsEdge]}
TaxonomyNarrowerConceptsEdge
TaxonomyRelatedConceptsConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [TaxonomyRelatedConceptsEdge]
|
a list of edges |
Example
{"edges": [TaxonomyRelatedConceptsEdge]}
TaxonomyRelatedConceptsEdge
TaxonomySitemapItem
Fields
| Field Name | Description |
|---|---|
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 |
Example
{
"classifiedItemsCount": 987,
"description": "xyz789",
"id": 4,
"items": [SitemapItem],
"key": "abc123",
"originalTitle": "abc123",
"publishedDate": "xyz789",
"title": "abc123",
"type": "abc123",
"url": "abc123",
"abstract": false,
"hasChildNodes": true,
"visible": false
}
TaxonomyTopConceptsSearchResultsConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [TaxonomyTopConceptsSearchResultsEdge]
|
a list of edges |
Example
{"edges": [TaxonomyTopConceptsSearchResultsEdge]}
TaxonomyTopConceptsSearchResultsEdge
TaxonomyType
Values
| Enum Value | Description |
|---|---|
|
|
KEYWORD |
|
|
CATEGORY |
|
|
STRUCTUREGROUP |
Example
"KEYWORD"
Template
Description
Represents a template.
Fields
| Field Name | Description |
|---|---|
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the item. Can be used to group related fields together. |
Arguments
|
|
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. |
schema - Schema
|
Returns the schema for the item. |
title - String
|
Returns the title of the item. |
updatedDate - String
|
Returns the date the item was updated. |
Example
{
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "xyz789",
"itemId": 987,
"itemType": 987,
"lastPublishDate": "xyz789",
"namespaceId": 987,
"outputFormat": "xyz789",
"owningPublicationId": 123,
"priority": 123,
"publicationId": 987,
"schema": Schema,
"title": "abc123",
"updatedDate": "xyz789"
}
UntypedContent
UntypedPageRegion
Description
Untyped page region.
Fields
| Field Name | Description |
|---|---|
components - [ContentComponent]
|
Returns the list of components in region. |
Arguments
|
|
creationDate - String
|
Returns the date the item was created. |
customMetas - CustomMetaConnection
|
Returns the custom meta data for the item. |
customMetasStructure - UntypedContent
|
Returns the custom meta data structure for the region. Can be used to group related fields together. |
Arguments
|
|
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. |
name - String
|
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. |
publicationId - Int!
|
Identifies the publication ID of the item. |
regions - [PageRegion]
|
Returns the regions for the page. |
Arguments
|
|
schema - Schema
|
Returns the schema for the item. |
title - String
|
Returns the title of the item. |
updatedDate - String
|
Returns the date the item was updated. |
Example
{
"components": [ContentComponent],
"creationDate": "abc123",
"customMetas": CustomMetaConnection,
"customMetasStructure": UntypedContent,
"id": 4,
"initialPublishDate": "xyz789",
"itemId": 987,
"itemType": 987,
"lastPublishDate": "abc123",
"name": "xyz789",
"namespaceId": 987,
"owningPublicationId": 123,
"publicationId": 987,
"regions": [PageRegion],
"schema": Schema,
"title": "xyz789",
"updatedDate": "abc123"
}