services.IVisualQueryServiceConfig interface

A collection of properties that provide the name and configuration for a visual query service.

Signature:

interface IVisualQueryServiceConfig extends ICoreServiceConfig, ILongRunningServiceConfig, IAuthenticatorServiceConfig

Extends: ICoreServiceConfig, ILongRunningServiceConfig, IAuthenticatorServiceConfig

Introduced: API version 2.3

Properties

Property	Type	Description
authenticator?	IAuthenticator \| undefined	(Optional) Gets the authenticator to use, or `undefined` if authentication is not required. (Inherited from IAuthenticatorServiceConfig)
config	spi.VisualQueryConfig	Gets the restrictions on the visual queries that users can create with the service.
description?	string \| RequestSpecificValue<string>	(Optional) Gets a description of what the service does, which might be displayed to users. (Inherited from ICoreServiceConfig)
hasPersistentResultIds?	boolean	(Optional) Indicates whether the identifiers of result records from the service are persistent from one call to the next. (Inherited from ICoreServiceConfig)
hide?	HidePredicate	(Optional) Gets whether the service should be hidden from the current user, based on information in the request. (Inherited from ICoreServiceConfig)
id	string	Gets the identifier of the service. (Inherited from ICoreServiceConfig)
longRunning?	boolean \| { pollingIntervalInSeconds?: number; }	(Optional) Indicates whether the service involves a long-running operation. (Inherited from ILongRunningServiceConfig)
name	string \| RequestSpecificValue<string>	Gets the name of the service. (Inherited from ICoreServiceConfig)
resultItemTypes?	schema.IItemType[]	(Optional) Gets the item types that result records from the service can have. (Inherited from ICoreServiceConfig)