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

/ admin / sysOptionGet

  • Article
  • 2 minutes to read

Description

Invoke this method to get one or more application options and their associated values.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
System Rights Database Rights Mail Rights Calendar Rights
sys.c.manageSystemSettings
 --- --- ---

Request Parameters

The sysOptionGet method takes the following input parameters.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

Name Type Attributes Description
filter xs:string Optional DEPRECIATED: Use ‘filters’ instead. If you want to list just a sub-set of the options provide the filter string. This is matched to the left of option Id, all options that match are returned.
filters Array<xs:string> Optional Specify one or more filters for options you want to get. Each filter is matched to the left of option Id, all options that match are returned.
searchMode xs:boolean Optional
Default=false		 If set to ‘true’ then the ‘filter’ can use DOS-style wildcard searches. For example, ‘filter’ would return all settings that have the word ‘filter’ in the setting id.
returnNonDefaultValuesOnly xs:boolean Optional
Default=false		 If you want to list just values that have been set to a non-default value set this to ‘true’. If set to false or not specified, then all config values scoped for the specified application are returned.
wantReadOnlyValues xs:boolean Optional
Default=false		 It is possible for the application to include a (potentially) large number of read-only values that can not be edited by the administrator. If you want to include these values in the result set, then set this parameter to ‘true’.
wantAdvancedOptions xs:boolean Optional
Default=true		 Advanced options are generally not for users to be set, so will not be visible in the admin tool by default. Set this to true of you want to also return advanced settings.
pageInfo pageInfoType Optional Controls the paging. If element is not specified, paging is disabled

Response Parameters

Name Type Attributes Description
option Array<configOptionListType> Required The option value.
maxPages numberType Optional A number indicating the maximum number of pages that could be returned.
totalItemCount numberType Optional The total number of items that can be returned by this query.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document