Home > @i2analyze/i2connect > services > ISemanticSeededServiceConfig
services.ISemanticSeededServiceConfig interface
A collection of properties that provide the name and configuration for a service that has semantic property type seed constraints.
Signature:
interface ISemanticSeededServiceConfig extends ICoreServiceConfig, ISemanticSeedServiceConfig, ILongRunningServiceConfig, IAuthenticatorServiceConfig, IFormServiceConfig
Extends: ICoreServiceConfig, ISemanticSeedServiceConfig, ILongRunningServiceConfig, IAuthenticatorServiceConfig, IFormServiceConfig
Introduced: API version 2.2
Properties
| Property | Type | Description |
|---|---|---|
| authenticator? | IAuthenticator | undefined | (Optional) Gets the authenticator to use, or undefined if authentication is not required. (Inherited from IAuthenticatorServiceConfig) |
| description? | string | RequestSpecificValue<string> | (Optional) Gets a description of what the service does, which might be displayed to users. (Inherited from ICoreServiceConfig) |
| form? | BasicForm | SectionedForm | (Optional) Gets the form definition, which configures a service to prompt for values that a user provides, subject to conditions that you specify. (Inherited from IFormServiceConfig) |
| formIsMandatory? | boolean | (Optional) Indicates whether the form should be presented to the user even if there are no mandatory conditions. (Inherited from IFormServiceConfig) |
| 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) |
| seedConstraints? | never | (Optional) (Inherited from ISemanticSeedServiceConfig) |
| semanticSeedConstraints? | ISemanticSeedConstraints | (Optional) Gets the semantic property type constraints on records that can be passed as seeds to the service. (Inherited from ISemanticSeedServiceConfig) |