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

  • Article
  • 1 minutes to read

Description

This type represents the configuration for a request sub-status

Properties

Name Type Occurrence Description
baseStatus requestSubStatusBaseType Required The status type this sub-status extends
subStatus simpleIdType Required The value of this status. This would typically be combined with the baseValue in the form of baseStatus.subStatus which is what will be stored in the database
subStatusDisplayName Array<bpmLabelType> Optional The name of this sub-status as displayed to the service provider users.
waitingFor requestWaitingForType Optional
Default=none		 No description provided
pauseRequesterTimers xs:boolean Optional
Default=false		 If set to true, this will pause requester response/fix timers.
requesterDisplayName Array<bpmLabelType> Optional The name of this sub-status as displayed to the service requester. This allows a sub-status to be displayed differently to the Service Requester on the Employee or Customer portals. For example, there may be a number of sub-states that are suitable for showing more granular details like With Development, Waiting for Documentation, In QA, but for the service requester, you may want all of these to just read In Development so you are not exposing some of the internal workings to the service requester.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document