spi namespace

A JavaScript representation of the objects in the raw i2 Connect gateway REST SPI.

Signature:

export namespace spi

Introduced: API version 2.3

Type Aliases

Type Alias	Description
Async	Indicates that queries are asynchronous, and provides configuration settings. If this is present, then acquireUrl must not be present.
AsyncQueryResponse	The result of successfully starting an asynchronous query.
AsyncQueryStatus	Information about the progress of an asynchronous query.
AsyncQuerySubstatus	A message about the progress of an asynchronous query, which might be displayed to users.
AuthConfig	Information about how to authenticate the users of a connector.
AuthConfigForm	A form that users complete with their credentials.
AuthConfigFormField	A field in an authentication form.
AuthResponse	The result of successful user authentication.
ClientConfig	An indication of how a client should interact with the service.
ClientConfigType	The type of the client configuration.
ConnectorConfig	Complete information about a connector for the i2 Connect gateway.
ConnectorConfigBase	Information about the services that a connector provides.
ConnectorDefaultValues	Settings for clients to apply to the data they receive, if the data does not indicate otherwise.
ConnectorSeedConstraintItemType	A seed constraint that is based on the item type of seed records.
ConnectorSeedConstraints	The constraints on the seeds that users can specify, or null if the service does not support seeds.
ConnectorSeedItemTypes	The item types that records must have in order to be used as seeds.
ConnectorSeedSemanticPropertyTypes	The semantic types of properties that records must have in order to be used as seeds.
ConnectorSeedTypes	The types that to be used as seeds.
DaodRequest	A search request that a service receives from a client.
DaodRequestCondition	A condition in a search request.
DaodRequestPayload	A custom payload that an i2 Connect service can use to determine what data to retrieve from a connected source.
DaodSeedEntityData	The data from an entity record to be used as a seed in a search operation.
DaodSeedItemData	Data from a record to be used as a seed in a search operation.
DaodSeedLinkData	The data from a link record to be used as a seed in a search operation.
DaodSeeds	The data from all the records that are to be used as seeds in a search operation.
DateAndTime	A fully qualified date and time, including a time zone.
EntityDataIdentifier	The identifier of the data for a record in its source.If the record was a seed in the request, then this contains the seed identifier in string form. If the record is from the Information Store, then this contains the record identifier. Alternatively, the value can be a source identifier.
EntityDataIdentifierSourceId	A source identifier being used to identify an entity or a link.
ExtraStringValidation	A regular expression for extra validation of a string value.
Feature	A geospatial feature, which can be a point, a polygon, or a multi-polygon.
FeatureCollection	A collection of geospatial features.
FormConfig	A form that is presented to users in the client.
FormConfigCondition	A condition in a form.
FormConfigSection	A section in a form that is presented to users.
FormLogicalType	The logical type of a value that can be used in a form condition.
GeoJSONMultiPolygon	The definitions of several polygons in geospace.
GeoJSONPoint	The definition of a point in geospace.
GeoJSONPolygon	The definition of a polygon in geospace.
Geometry	A point or an area in geospace.
GeospatialCoordinate	An array in which the first element represents longitude, the second represents latitude, and the (optional) third represents altitude.
I2ConnectData	The results of a request for data to an i2 Connect service.
I2ConnectEntityData	An entity in the results of a request for data to an i2 Connect service.
I2ConnectLinkData	A link in the results of a request for data to an i2 Connect service.
InfoStoreIdentifier	The identifier of a record in the Information Store.
ItemType	An item type from an i2 Analyze schema.
LinkDirection	The logical direction of this link, expressed relative to its 'from' and 'to' ends.
LogicalType	The logical type of a value.
MaxStringLength	The maximum length of a string in a condition, expressed as a raw size with its units.
PayloadValidationResponse	The result of validating the contents of a request for data.
PossibleConditionValue	A possible value for use by `SELECTED_FROM` and `SUGGESTED_FROM` conditions.
ProblemDetails	The contents of the result of a failed HTTP request.
PropertyType	A property type of an item type from an i2 Analyze schema.
PropertyValueType	The type of a property value of a record.
ResultItemTypeIds	A set of item type identifiers from a particular schema.
SchemaTypeLocation	The schema in which an item type is defined.
SecurityDimensionAndValues	A set of values from a particular security dimension.
SeedSourceIdentifier	A source identifier in use as a seed identifier.
SemanticProperty	A property of a semantic seed.
SemanticSeed	The properties of a record in use as a semantic seed.
SemanticTypeIdentifier	The identifier of the semantic type for this property type.
Service	A service that a connector for the i2 Connect gateway makes available.
SourceIdentifier	A source identifier.
SourceReference	A source reference for a record.
SourceReferenceInfo	The information that the source reference contains.
TypeLocation	The schema in which the item type is defined.
UserConnectorConfig	User-specific information about the services that a connector provides.
VisualQueryBooleanCondition	A Boolean condition on a query item in a Visual Query structure.
VisualQueryCondition	A condition on a query item in a Visual Query structure.
VisualQueryConditionAspect	The aspect of the identified property or metadata to use in the Visual Query condition.
VisualQueryConditionOperator	The operator to use in the Visual Query condition.Operations on logical types whose data type is `string` are case-insensitive. In the same context, a sequence of consecutive white space characters is equivalent to a single white space character.Operations on logical types whose data type is `Calendar` perform their comparisons at the level of milliseconds.Operations on logical types with other data types proceed as follows:- For `DECIMAL`, `java.math.BigDecimal#doubleValue()` is used for the comparison - For `DOUBLE`, `Double#equals(Object)` is used for the comparison - For `INTEGER`, `Integer#equals(Object)` is used for the comparison - For `BOOLEAN`, `Boolean#equals(Object)` is used for the comparison
VisualQueryConditionValueType	The type of the values to use in this query condition.
VisualQueryConfig	The configuration that governs the behavior and content of Visual Queries.
VisualQueryConstraints	The constraints that apply to Visual Query structures.
VisualQueryCountCondition	A count condition on a query item in a Visual Query structure.
VisualQueryCountConditionOperator	The operator in a Visual Query count condition.
VisualQueryDateAndTimeCondition	A date-and-time condition on a query item in a Visual Query structure.
VisualQueryEntity	A query entity in a Visual Query structure.
VisualQueryEntityPosition	The position of a query entity in a Visual Query structure.
VisualQueryGeospatialCondition	A geospatial condition on a query item in a Visual Query structure.
VisualQueryItem	A query item in a Visual Query structure.
VisualQueryLink	A query link in a Visual Query structure.
VisualQueryNumericCondition	A numeric condition on a query item in a Visual Query structure.
VisualQueryOperatorUsageRule	A rule that governs the property types and operators that can appear in the conditions of a query item.
VisualQueryPaletteItemTypes	The specification of which item types appear in the Visual Query palette.
VisualQueryStringCondition	A string condition on a query item in a Visual Query structure.