siren_investigate (5.6.10)

Download OpenAPI specification:

SIREn Solutions : info@siren.io License: SEE LICENSE IN LICENSE.md

Siren Investigate extends Kibana with data intelligence features. At the core, Investigate can join and filter data live from multiple indexes (elasticsearch) or from SQL/NOSQL sources. Kibana is a trademark of Elasticsearch BV, registered in the U.S. and in other countries.

Api version - v1

CreateObjectDefinition

API to create an object definition

Authorizations:

basicAuth

path Parameters

type

required

string (ObjectDefinitionType)

Enum: "search" "eid" "relation" "sirenapiscript" "iconpack" "dataspace"

The object definition type, e.g. search, eid, etc ...

query Parameters

dataspace	string
returnAttributes	boolean

Request Body schema: application/json
required

Any of

required	object (SavedSearchAttributes)
isGlobal	boolean <boolean> Is global true/false
version	string <string> Opaque version token from a prior GET response, used for optimistic concurrency control. When seq_no/primary_term concurrency is supported (default), this is a base64-encoded JSON array: [seq_no, primary_term] (e.g. "WzEsMV0=" for [1,1]). If the backend only supports legacy numeric versioning, this may instead be the Elasticsearch _version integer.
	object (ObjectMetadataInput) Make all properties in T optional

Responses

Request samples

Payload

Content type

application/json

Example

SavedSearchPayload

{"attributes": {"version": 108,
"compositePrimaryKeyFields": ["string"
],
"siren": {"semanticSearch": [{"targetEntityTableId": "string",
"isChunkDocumentField": "string",
"originalIDocIdField": "string",
"chunkEndOffsetField": "string",
"chunkStartOffsetField": "string",
"chunkNoField": "string",
"chunkField": "string",
"vectorField": "string",
"sourceField": "string",
"scenario": "noChunking"
}
],
"computedFieldsScripts": {"scripts": [{"id": "string"
}
],
"fields": [{"type": "string",
"label": "string",
"name": "string"
}
]
},
"import": {"allowedFields": ["string"
],
"targetIndex": "string",
"projectImportsEnabled": true
},
"entityResolution": {"enabled": true
},
"dynamicFilters": [{"filterId": "string",
"field": "string"
}
],
"templateScripts": {"recordTable": [{"type": "view",
"perspective": "string",
"scriptId": "string"
}
],
"recordView": [{"type": "view",
"perspective": "string",
"scriptId": "string"
}
]
},
"globalSearch": {"selectedByDefault": true,
"forceSearchedOnTimeFilter": true,
"recencyBoost": [{"boost": 0.1,
"from": {"count": 0.1,
"unit": "y"
}
}
],
"boost": 0.1,
"enabled": true
},
"highlight": {"fields": "string"
},
"revision": {"copyToFields": {"property1": ["string"
],
"property2": ["string"
]
},
"indexingScope": "G:S",
"editableFieldsExceptions": ["string"
],
"editableFieldsMode": "whitelist",
"primaryKey": "string",
"isEditable": true,
"index": "string"
},
"limits": {"maxJoinCardinalityApplyToTarget": true,
"maxJoinCardinalityApplyToSource": true,
"maxJoinCardinalityUnit": "string",
"maxJoinCardinality": 0,
"maxJoinCardinalityEnabled": true,
"maxCardinalityUnit": "string",
"maxCardinality": 0,
"maxCardinalityEnabled": true,
"maxTimeRangeUnit": "string",
"maxTimeRange": 0,
"maxTimeRangeEnabled": true
},
"ui": {"instanceImageValue": "string",
"instanceImageType": "string",
"instanceLabelValue": "string",
"instanceLabelType": "string",
"shortDescription": "string",
"color": "string",
"icon": "string"
},
"samplingScriptId": "string",
"indexingScope": "G:S",
"parentId": "string"
},
"indexPattern": {"error": null,
"fieldFormatMap": "string",
"excludeIndices": true,
"sourceFilters": "string",
"fields": "string",
"intervalName": "string",
"timeFieldName": "string",
"pattern": "string"
},
"kibanaSavedObjectMeta": {"searchSourceJSON": "string"
},
"sort": ["string"
],
"columns": ["string"
],
"hits": 0,
"description": "string",
"title": "string"
},
"isGlobal": true,
"version": "string",
"metadata": {"ownerId": "string",
"creatorId": "string",
"creationDate": 0.1,
"permissions": [{"role": "string",
"rules": [{"action": "allow",
"permission": "create",
"context": "string"
}
]
}
],
"childPermissions": [{"role": "string",
"rules": [{"action": "allow",
"permission": "create",
"context": "string"
}
]
}
],
"sharingMode": "private",
"generalAccessLevel": "view",
"userAccessLevels": [{"username": "string",
"accessLevel": "view"
}
],
"fileSystem": {"parentId": "string",
"position": {"v": [[0.1
]
]
}
},
"version": 0.1
}
}

Response samples

Content type

application/json

{"acknowledged": true,
"error": {"name": "string",
"message": "string",
"stack": "string"
},
"action": "string",
"status": 0,
"warning": "string",
"version": "string",
"attributes": null,
"namespace": "string",
"type": "string",
"id": "string"
}

CreateObjectDefinitionWithId

API to create an object definition with a specified id

Authorizations:

basicAuth

path Parameters

type required	string (ObjectDefinitionType) Enum: "search" "eid" "relation" "sirenapiscript" "iconpack" "dataspace" The object type, e.g. search, eid, etc ...
id required	string (ObjectDefinitionId) ^(?:([\w\d-]{1,25}):)?[2a-z_-]+:[\w\d-.()]+$ Example: search:a14c5675-1fdd-4bfb-804c-b2f67594656a The object id

query Parameters

dataspace	string
overwrite	boolean
returnAttributes	boolean
__private	boolean

Request Body schema: application/json
required

Any of

required	object (SavedSearchAttributes)
isGlobal	boolean <boolean> Is global true/false
version	string <string> Opaque version token from a prior GET response, used for optimistic concurrency control. When seq_no/primary_term concurrency is supported (default), this is a base64-encoded JSON array: [seq_no, primary_term] (e.g. "WzEsMV0=" for [1,1]). If the backend only supports legacy numeric versioning, this may instead be the Elasticsearch _version integer.
	object (ObjectMetadataInput) Make all properties in T optional

Responses

Request samples

Payload

Content type

application/json

Example

SavedSearchPayload

{"attributes": {"version": 108,
"compositePrimaryKeyFields": ["string"
],
"siren": {"semanticSearch": [{"targetEntityTableId": "string",
"isChunkDocumentField": "string",
"originalIDocIdField": "string",
"chunkEndOffsetField": "string",
"chunkStartOffsetField": "string",
"chunkNoField": "string",
"chunkField": "string",
"vectorField": "string",
"sourceField": "string",
"scenario": "noChunking"
}
],
"computedFieldsScripts": {"scripts": [{"id": "string"
}
],
"fields": [{"type": "string",
"label": "string",
"name": "string"
}
]
},
"import": {"allowedFields": ["string"
],
"targetIndex": "string",
"projectImportsEnabled": true
},
"entityResolution": {"enabled": true
},
"dynamicFilters": [{"filterId": "string",
"field": "string"
}
],
"templateScripts": {"recordTable": [{"type": "view",
"perspective": "string",
"scriptId": "string"
}
],
"recordView": [{"type": "view",
"perspective": "string",
"scriptId": "string"
}
]
},
"globalSearch": {"selectedByDefault": true,
"forceSearchedOnTimeFilter": true,
"recencyBoost": [{"boost": 0.1,
"from": {"count": 0.1,
"unit": "y"
}
}
],
"boost": 0.1,
"enabled": true
},
"highlight": {"fields": "string"
},
"revision": {"copyToFields": {"property1": ["string"
],
"property2": ["string"
]
},
"indexingScope": "G:S",
"editableFieldsExceptions": ["string"
],
"editableFieldsMode": "whitelist",
"primaryKey": "string",
"isEditable": true,
"index": "string"
},
"limits": {"maxJoinCardinalityApplyToTarget": true,
"maxJoinCardinalityApplyToSource": true,
"maxJoinCardinalityUnit": "string",
"maxJoinCardinality": 0,
"maxJoinCardinalityEnabled": true,
"maxCardinalityUnit": "string",
"maxCardinality": 0,
"maxCardinalityEnabled": true,
"maxTimeRangeUnit": "string",
"maxTimeRange": 0,
"maxTimeRangeEnabled": true
},
"ui": {"instanceImageValue": "string",
"instanceImageType": "string",
"instanceLabelValue": "string",
"instanceLabelType": "string",
"shortDescription": "string",
"color": "string",
"icon": "string"
},
"samplingScriptId": "string",
"indexingScope": "G:S",
"parentId": "string"
},
"indexPattern": {"error": null,
"fieldFormatMap": "string",
"excludeIndices": true,
"sourceFilters": "string",
"fields": "string",
"intervalName": "string",
"timeFieldName": "string",
"pattern": "string"
},
"kibanaSavedObjectMeta": {"searchSourceJSON": "string"
},
"sort": ["string"
],
"columns": ["string"
],
"hits": 0,
"description": "string",
"title": "string"
},
"isGlobal": true,
"version": "string",
"metadata": {"ownerId": "string",
"creatorId": "string",
"creationDate": 0.1,
"permissions": [{"role": "string",
"rules": [{"action": "allow",
"permission": "create",
"context": "string"
}
]
}
],
"childPermissions": [{"role": "string",
"rules": [{"action": "allow",
"permission": "create",
"context": "string"
}
]
}
],
"sharingMode": "private",
"generalAccessLevel": "view",
"userAccessLevels": [{"username": "string",
"accessLevel": "view"
}
],
"fileSystem": {"parentId": "string",
"position": {"v": [[0.1
]
]
}
},
"version": 0.1
}
}

Response samples

Content type

application/json

{"acknowledged": true,
"error": {"name": "string",
"message": "string",
"stack": "string"
},
"action": "string",
"status": 0,
"warning": "string",
"version": "string",
"attributes": null,
"namespace": "string",
"type": "string",
"id": "string"
}

UpdateObjectDefinition

API to update an object definition with a specific id

Authorizations:

basicAuth

path Parameters

type required	string (ObjectDefinitionType) Enum: "search" "eid" "relation" "sirenapiscript" "iconpack" "dataspace" The object definition type, e.g. search, eid, etc ...
id required	string (ObjectDefinitionId) ^(?:([\w\d-]{1,25}):)?[2a-z_-]+:[\w\d-.()]+$ Example: search:a14c5675-1fdd-4bfb-804c-b2f67594656a The object definition id

query Parameters

dataspace	string
returnAttributes	boolean

Request Body schema: application/json
required

Any of

required	object (SavedSearchAttributes)
isGlobal	boolean <boolean> Is global true/false
version	string <string> Opaque version token from a prior GET response, used for optimistic concurrency control. When seq_no/primary_term concurrency is supported (default), this is a base64-encoded JSON array: [seq_no, primary_term] (e.g. "WzEsMV0=" for [1,1]). If the backend only supports legacy numeric versioning, this may instead be the Elasticsearch _version integer.
	object (ObjectMetadataInput) Make all properties in T optional

Responses

Request samples

Payload

Content type

application/json

Example

SavedSearchPayload

{"attributes": {"version": 108,
"compositePrimaryKeyFields": ["string"
],
"siren": {"semanticSearch": [{"targetEntityTableId": "string",
"isChunkDocumentField": "string",
"originalIDocIdField": "string",
"chunkEndOffsetField": "string",
"chunkStartOffsetField": "string",
"chunkNoField": "string",
"chunkField": "string",
"vectorField": "string",
"sourceField": "string",
"scenario": "noChunking"
}
],
"computedFieldsScripts": {"scripts": [{"id": "string"
}
],
"fields": [{"type": "string",
"label": "string",
"name": "string"
}
]
},
"import": {"allowedFields": ["string"
],
"targetIndex": "string",
"projectImportsEnabled": true
},
"entityResolution": {"enabled": true
},
"dynamicFilters": [{"filterId": "string",
"field": "string"
}
],
"templateScripts": {"recordTable": [{"type": "view",
"perspective": "string",
"scriptId": "string"
}
],
"recordView": [{"type": "view",
"perspective": "string",
"scriptId": "string"
}
]
},
"globalSearch": {"selectedByDefault": true,
"forceSearchedOnTimeFilter": true,
"recencyBoost": [{"boost": 0.1,
"from": {"count": 0.1,
"unit": "y"
}
}
],
"boost": 0.1,
"enabled": true
},
"highlight": {"fields": "string"
},
"revision": {"copyToFields": {"property1": ["string"
],
"property2": ["string"
]
},
"indexingScope": "G:S",
"editableFieldsExceptions": ["string"
],
"editableFieldsMode": "whitelist",
"primaryKey": "string",
"isEditable": true,
"index": "string"
},
"limits": {"maxJoinCardinalityApplyToTarget": true,
"maxJoinCardinalityApplyToSource": true,
"maxJoinCardinalityUnit": "string",
"maxJoinCardinality": 0,
"maxJoinCardinalityEnabled": true,
"maxCardinalityUnit": "string",
"maxCardinality": 0,
"maxCardinalityEnabled": true,
"maxTimeRangeUnit": "string",
"maxTimeRange": 0,
"maxTimeRangeEnabled": true
},
"ui": {"instanceImageValue": "string",
"instanceImageType": "string",
"instanceLabelValue": "string",
"instanceLabelType": "string",
"shortDescription": "string",
"color": "string",
"icon": "string"
},
"samplingScriptId": "string",
"indexingScope": "G:S",
"parentId": "string"
},
"indexPattern": {"error": null,
"fieldFormatMap": "string",
"excludeIndices": true,
"sourceFilters": "string",
"fields": "string",
"intervalName": "string",
"timeFieldName": "string",
"pattern": "string"
},
"kibanaSavedObjectMeta": {"searchSourceJSON": "string"
},
"sort": ["string"
],
"columns": ["string"
],
"hits": 0,
"description": "string",
"title": "string"
},
"isGlobal": true,
"version": "string",
"metadata": {"ownerId": "string",
"creatorId": "string",
"creationDate": 0.1,
"permissions": [{"role": "string",
"rules": [{"action": "allow",
"permission": "create",
"context": "string"
}
]
}
],
"childPermissions": [{"role": "string",
"rules": [{"action": "allow",
"permission": "create",
"context": "string"
}
]
}
],
"sharingMode": "private",
"generalAccessLevel": "view",
"userAccessLevels": [{"username": "string",
"accessLevel": "view"
}
],
"fileSystem": {"parentId": "string",
"position": {"v": [[0.1
]
]
}
},
"version": 0.1
}
}

Response samples

Content type

application/json

{"acknowledged": true,
"error": {"name": "string",
"message": "string",
"stack": "string"
},
"action": "string",
"status": 0,
"warning": "string",
"version": "string",
"attributes": null,
"namespace": "string",
"type": "string",
"id": "string"
}

DeleteObjectDefinition

Authorizations:

basicAuth

path Parameters

required

string (ObjectDefinitionId) ^(?:([\w\d-]{1,25}):)?[2a-z_-]+:[\w\d-.()]+$

Example: search:a14c5675-1fdd-4bfb-804c-b2f67594656a

An investigate object stringified id with the following format [DataspaceShortcode:]InvestigateObject:UUID.

Responses

Response samples

Content type

application/json

{"deletedIds": ["string"
],
"acknowledged": true
}

ValidateObjectDefinition

API to validate an object definition

Authorizations:

basicAuth

path Parameters

type

required

string (ObjectDefinitionType)

Enum: "search" "eid" "relation" "sirenapiscript" "iconpack" "dataspace"

The object definition type, e.g. search, eid, etc ...

query Parameters

id	string (ObjectDefinitionId) ^(?:([\w\d-]{1,25}):)?[2a-z_-]+:[\w\d-.()]+$ Example: id=search:a14c5675-1fdd-4bfb-804c-b2f67594656a An investigate object stringified id with the following format [DataspaceShortcode:]InvestigateObject:UUID.

Request Body schema: application/json
required

Any of

required	object (SavedSearchAttributes)
isGlobal	boolean <boolean> Is global true/false
version	string <string> Opaque version token from a prior GET response, used for optimistic concurrency control. When seq_no/primary_term concurrency is supported (default), this is a base64-encoded JSON array: [seq_no, primary_term] (e.g. "WzEsMV0=" for [1,1]). If the backend only supports legacy numeric versioning, this may instead be the Elasticsearch _version integer.
	object (ObjectMetadataInput) Make all properties in T optional

Responses

Request samples

Payload

Content type

application/json

Example

SavedSearchPayload

{"attributes": {"version": 108,
"compositePrimaryKeyFields": ["string"
],
"siren": {"semanticSearch": [{"targetEntityTableId": "string",
"isChunkDocumentField": "string",
"originalIDocIdField": "string",
"chunkEndOffsetField": "string",
"chunkStartOffsetField": "string",
"chunkNoField": "string",
"chunkField": "string",
"vectorField": "string",
"sourceField": "string",
"scenario": "noChunking"
}
],
"computedFieldsScripts": {"scripts": [{"id": "string"
}
],
"fields": [{"type": "string",
"label": "string",
"name": "string"
}
]
},
"import": {"allowedFields": ["string"
],
"targetIndex": "string",
"projectImportsEnabled": true
},
"entityResolution": {"enabled": true
},
"dynamicFilters": [{"filterId": "string",
"field": "string"
}
],
"templateScripts": {"recordTable": [{"type": "view",
"perspective": "string",
"scriptId": "string"
}
],
"recordView": [{"type": "view",
"perspective": "string",
"scriptId": "string"
}
]
},
"globalSearch": {"selectedByDefault": true,
"forceSearchedOnTimeFilter": true,
"recencyBoost": [{"boost": 0.1,
"from": {"count": 0.1,
"unit": "y"
}
}
],
"boost": 0.1,
"enabled": true
},
"highlight": {"fields": "string"
},
"revision": {"copyToFields": {"property1": ["string"
],
"property2": ["string"
]
},
"indexingScope": "G:S",
"editableFieldsExceptions": ["string"
],
"editableFieldsMode": "whitelist",
"primaryKey": "string",
"isEditable": true,
"index": "string"
},
"limits": {"maxJoinCardinalityApplyToTarget": true,
"maxJoinCardinalityApplyToSource": true,
"maxJoinCardinalityUnit": "string",
"maxJoinCardinality": 0,
"maxJoinCardinalityEnabled": true,
"maxCardinalityUnit": "string",
"maxCardinality": 0,
"maxCardinalityEnabled": true,
"maxTimeRangeUnit": "string",
"maxTimeRange": 0,
"maxTimeRangeEnabled": true
},
"ui": {"instanceImageValue": "string",
"instanceImageType": "string",
"instanceLabelValue": "string",
"instanceLabelType": "string",
"shortDescription": "string",
"color": "string",
"icon": "string"
},
"samplingScriptId": "string",
"indexingScope": "G:S",
"parentId": "string"
},
"indexPattern": {"error": null,
"fieldFormatMap": "string",
"excludeIndices": true,
"sourceFilters": "string",
"fields": "string",
"intervalName": "string",
"timeFieldName": "string",
"pattern": "string"
},
"kibanaSavedObjectMeta": {"searchSourceJSON": "string"
},
"sort": ["string"
],
"columns": ["string"
],
"hits": 0,
"description": "string",
"title": "string"
},
"isGlobal": true,
"version": "string",
"metadata": {"ownerId": "string",
"creatorId": "string",
"creationDate": 0.1,
"permissions": [{"role": "string",
"rules": [{"action": "allow",
"permission": "create",
"context": "string"
}
]
}
],
"childPermissions": [{"role": "string",
"rules": [{"action": "allow",
"permission": "create",
"context": "string"
}
]
}
],
"sharingMode": "private",
"generalAccessLevel": "view",
"userAccessLevels": [{"username": "string",
"accessLevel": "view"
}
],
"fileSystem": {"parentId": "string",
"position": {"v": [[0.1
]
]
}
},
"version": 0.1
}
}

Response samples

Content type

application/json

{"acknowledged": true,
"error": {"name": "string",
"message": "string",
"stack": "string"
},
"action": "string",
"status": 0,
"warning": "string",
"version": "string",
"attributes": null,
"namespace": "string",
"type": "string",
"id": "string"
}

siren_investigate (5.6.10)

Api version - v1

CreateObjectDefinition

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

CreateObjectDefinitionWithId

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

UpdateObjectDefinition

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

DeleteObjectDefinition

Authorizations:

path Parameters

Responses

Response samples

ValidateObjectDefinition

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required