Home > @i2analyze/i2connect > services > IServiceConfig
services.IServiceConfig interface
A collection of properties that provide the name and configuration for a service.
Signature:
interface IServiceConfig
Introduced: API version 1.0
Properties
Property | Type | Description |
---|---|---|
async? | boolean | { pollingIntervalInSeconds?: number; } | (Optional) Indicates whether the service involves a long-running operation. |
description? | string | RequestSpecificValue<string> | (Optional) Gets a description of what the service does, which might be displayed to users. |
hasPersistentResultIds? | boolean | (Optional) Indicates whether the identifiers of result records from the service are persistent from one call to the next. |
hide? | HidePredicate | (Optional) Gets whether the service should be hidden from the current user, based on information in the request. |
name | string | RequestSpecificValue<string> | Gets the name of the service. |
resultItemTypes? | schema.IItemType[] | (Optional) Gets the item types that result records from the service can have. |