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

  • Article
  • 1 minutes to read

Description

This type represents the configuration of a request type.

Properties

Name Type Occurrence Description
displayName Array<bpmLabelType> Optional The translatable display name of the request type
description Array<bpmLabelType> Optional The translatable description of the request type i.e. what is the request type record used for
icon xs:string Optional icon class used to represent request type when shown in lists and menus
colorCode xs:string Optional color used to represent request type when shown in lists and menus i.e. green, blue , red, orange
requesterDataModel requesterDataModelType Optional You must specify the customer data model this request bust support
requestIdAutoValPattern xs:string Optional The autoval pattern to use for generating request reference numbers.
options requestTypeOptionsType Optional Options that control how a requst can
features Array<requestFeatureType> Optional A request can have one or more features enabled/configured.
plugins Array<requestPluginType> Optional A request can have one or more plugins enabled.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document