Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Complex Types - catalogItemListType

  • Article
  • 1 minutes to read

Description

Information about a catalog item

Properties

Name Type Occurrence Description
catalogItemId xs:unsignedInt Required The ID of the Catalog Item
serviceId xs:unsignedInt Required The ID of the service
icon xs:anyURI Required The icon used to present this catalog item
iconType xs:integer Optional The type of icon to display. (0=class name
isEnabled xs:boolean Optional
Default=false		 Is this catalog item enabled.
language xs:language Optional If present, indicates that the name and description properties are a language variant
name xs:string Required The catalog item name
description xs:string Optional The catalog item description
catalogItemClass catalogItemClassType Optional The class of the catalog item: issue (needs help) or serviceRequest (wants something)
slaSchemeId xs:unsignedInt Optional The SLA scheme ID assigned to this catalog item (overrides service-level SLA)
slaSchemeName xs:string Optional The name of the SLA scheme
action serviceActionType Required The action configured for this catalog item
knowledgeArticles Array<knowledgeArticleRefType> Optional Knowledge base articles associated with this catalog item
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document