Documentation

This is taking longer than usual. If nothing appears, refresh the page.

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 - notifyMessageItemType

  • Article
  • 1 minutes to read

Description

This represents the notification message posted via event service.

Properties

Name Type Occurrence Description
transactionId xs:string Optional The transaction ID generated for the API request.
application appNameType Optional Application for resolving application strings. If not defined “system” should be assumed.
templateId xs:string Optional The messageId defined in the app-strings for this message. Eg: urn.user.buzz.social.wall.postMessage. This is used to create the notification title.
title xs:string Optional The title if no templateId specified or the app-string look up fails.
param Array<xs:string> Optional The substitution parameter.
shortParam Array<xs:string> Optional The substitution parameter for short titles.
objectRef xs:string Optional The unique identifier of the message. eg: urn:xxx:xxx:xxx
relatedObjectRef Array<xs:string> Optional The unique identifier of parent, grandparent, … related objects.
class xs:string Required The class of the message belonging to. eg: entity, newsfeed, conversation
action xs:string Optional The action performed to notify the subscribers.
category xs:string Optional The category of the message.
actor xs:anyURI Optional The urn of the user who performed the action.
content xs:string Optional The message to be notified to the subscriber.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document