Portal Community
10 operations across 2 resources. The document resource covers individual record operations: create, get, getMany, search, update, and delete. The index resource covers index lifecycle: create, get, getMany, and delete. Each operation is documented on its own page with configuration, output schema, and a real workflow example.

Authentication

All operations share the same connection properties, configured once per node instance:

PropertyTypeDescription
HoststringFull URL to the cluster, e.g. https://localhost:9200 or https://my-cluster.es.io. Include protocol and non-standard ports.
UsernamestringElasticsearch username. Typically elastic on Elastic Cloud.
PasswordcredentialStore in BizFirst Credentials Manager — never hard-code in workflow expressions.
IgnoreSSLbooleanDefault false. Set true only for self-signed certificates in dev/test. Never in production.
ConnectTimeoutinteger (ms)Default 30000. Max time to establish connection.
RequestTimeoutinteger (ms)Default 60000. Increase for large aggregation or bulk index operations.
Document Operations

document/create

Index a new document. Supports single insert with an explicit or auto-generated ID, and bulk insert via the Elasticsearch Bulk API.

document/get

Retrieve a single document by its _id. Returns the full _source body plus version metadata.

document/getMany

Retrieve multiple documents with an optional Query DSL filter. Supports pagination and full scroll-through for large result sets.

document/search

Full Elasticsearch search with complete Query DSL support: bool, multi_match, range, aggregations, sorting, highlighting, and field filtering.

document/update

Partially update a document — only the specified fields change, all others are preserved. Supports upsert mode.

document/delete

Permanently delete a single document by ID. The index and all other documents are unaffected.

Index Operations

index/create

Create a new index with explicit field mappings and settings — shard count, replicas, custom analyzers.

index/get

Retrieve full index details: mappings, settings, aliases, document count, and storage size.

index/getMany

List all indices accessible to the configured user — name, health, status, document count, and store size.

index/delete

Permanently delete an index and every document it contains. Irreversible — use with care in automated workflows.