API docs by Redocly

Schemas

ObjectDefinitionAttributes

any (ObjectDefinitionAttributes)
null

integer

number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

0
0

Error

name
required
string
message
required
string
stack
string
{
  • "name": "string",
  • "message": "string",
  • "stack": "string"
}

ObjectDefinitionNormalized

acknowledged
boolean <boolean>

Some objects call other apis internally which have an acknowledged property, e.g. dataspace api

object (Error)
name
required
string
message
required
string
stack
string
action
string <string>

Some objects call other apis internally which have an acknowledged property, e.g. dataspace api

status
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

warning
string <string>

A warning may mean that further action is required

version
string <string>

Value of the _version metadata field

attributes
any (ObjectDefinitionAttributes)
namespace
string <string>

Namespace string

type
required
string <string>

Saved Object Type e.g 'search'

id
string <string>

Saved Object ID

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

double

number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

0.1

GlobalSearchSettingsV103

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

{
  • "boost": 0.1,
  • "enabled": true
}

keyword

string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

"string"

DynamicFilterMappingV103

filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "filterId": "string",
  • "field": "string"
}

BookmarkedSearchSavedSearchDefinitionV100

required
Array of objects (DynamicFilterMappingV103)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

timeFieldName
string
fields
required
object
required
object (GlobalSearchSettingsV103)
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

id
required
string
{
  • "dynamicFilters": [
    ],
  • "timeFieldName": "string",
  • "fields": {
    },
  • "globalSearch": {
    },
  • "id": "string"
}

DynamicFilterAttributesV101

version
required
number <integer>
Value: 101

DynamicFilter object version

required
object
inputMask
required
string <string>

Input mask value to apply to input

useRange
required
boolean <boolean>

Whether to display a range or single input box. Search a value within a range instead of exact value

showExactMatchOption
required
boolean <boolean>

Whether to show the option that allows a user to indicate that matching should be strict or fuzzy/tokenized

options
required
string <string>

Additional options on dynamic filters, e.g filter by number ranges

histogram
required
boolean <boolean>

Whether to show the counts and bar charts for the categories

multiselect
required
boolean <boolean>

Whether the user should be able to select more than a single category (ORed together). If true, the categories become checkboxes instead of radio buttons

searchable
required
boolean <boolean>

Whether the categories can be filtered using a text field. This is useful if there are hundreds of categories available to choose from

sorting
required
string <string>
Enum: "fixed" "alphabetic" "hits"

How categories are sorted when the dynamic filter is rendered

visibleOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

type
required
string <keyword>
Enum: "manual" "automatic" "none"

How categories (i.e. options) shall be determined. These categories represent values for the mapped fields and are used to filter the data

type
required
string <keyword>
Enum: "text" "keyword" "number" "date" "age"

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

{
  • "version": 101,
  • "categories": {
    },
  • "type": "text",
  • "title": "string"
}

BookmarkedSearchDynamicFilterDefinitionV100

required
object (DynamicFilterAttributesV101)
version
required
number <integer>
Value: 101

DynamicFilter object version

required
object
inputMask
required
string <string>

Input mask value to apply to input

useRange
required
boolean <boolean>

Whether to display a range or single input box. Search a value within a range instead of exact value

showExactMatchOption
required
boolean <boolean>

Whether to show the option that allows a user to indicate that matching should be strict or fuzzy/tokenized

options
required
string <string>

Additional options on dynamic filters, e.g filter by number ranges

histogram
required
boolean <boolean>

Whether to show the counts and bar charts for the categories

multiselect
required
boolean <boolean>

Whether the user should be able to select more than a single category (ORed together). If true, the categories become checkboxes instead of radio buttons

searchable
required
boolean <boolean>

Whether the categories can be filtered using a text field. This is useful if there are hundreds of categories available to choose from

sorting
required
string <string>
Enum: "fixed" "alphabetic" "hits"

How categories are sorted when the dynamic filter is rendered

visibleOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

type
required
string <keyword>
Enum: "manual" "automatic" "none"

How categories (i.e. options) shall be determined. These categories represent values for the mapped fields and are used to filter the data

type
required
string <keyword>
Enum: "text" "keyword" "number" "date" "age"

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

id
required
string
{
  • "attributes": {
    },
  • "id": "string"
}

BookmarkedSearchDefinitionsV100

required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV100)

Dynamic filter objects

Array
required
object (DynamicFilterAttributesV101)
version
required
number <integer>
Value: 101

DynamicFilter object version

required
object
type
required
string <keyword>
Enum: "text" "keyword" "number" "date" "age"

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

id
required
string
required
Array of objects (BookmarkedSearchSavedSearchDefinitionV100)

Saved search objects.

Array
required
Array of objects (DynamicFilterMappingV103)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

timeFieldName
string
fields
required
object
required
object (GlobalSearchSettingsV103)
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

id
required
string
config
required
object

Configuration object.

kibiVersion
required
string

Investigate version.

{
  • "dynamicFilters": [
    ],
  • "savedSearches": [
    ],
  • "config": {
    },
  • "kibiVersion": "string"
}

AnyObjectEsType_BookmarkedSearchDefinitionsV100_

required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV100)

Dynamic filter objects

Array
required
object (DynamicFilterAttributesV101)
version
required
number <integer>
Value: 101

DynamicFilter object version

required
object
type
required
string <keyword>
Enum: "text" "keyword" "number" "date" "age"

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

id
required
string
required
Array of objects (BookmarkedSearchSavedSearchDefinitionV100)

Saved search objects.

Array
required
Array of objects (DynamicFilterMappingV103)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

timeFieldName
string
fields
required
object
required
object (GlobalSearchSettingsV103)
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

id
required
string
config
required
object

Configuration object.

kibiVersion
required
string

Investigate version.

{
  • "dynamicFilters": [
    ],
  • "savedSearches": [
    ],
  • "config": {
    },
  • "kibiVersion": "string"
}

BookmarkedSearchStringRangeV100

to
string

The start of the range. Dates should use the ISO 8601 format.

from
string

The start of the range. Dates should use the ISO 8601 format.

{
  • "to": "string",
  • "from": "string"
}

BookmarkedSearchNumberRangeV100

to
number <double>

The end of the range.

from
number <double>

The start of the range.

{
  • "to": 0.1,
  • "from": 0.1
}

BookmarkedSearchPlainTextMatchV100

exactMatch
required
boolean

Whether the text string should match the whole field value or just part of it.

string or number

Value to match.

Any of
string

Value to match.

{
  • "exactMatch": true,
  • "query": "string"
}

BookmarkedSearchMaskedTextMatchV100

exactMatch
required
boolean

Whether the text string should match the whole field value or just part of it.

unmaskedValue
required
string

Searched value.

maskedValue
required
string

Value to match as displayed in the search bar.

{
  • "exactMatch": true,
  • "unmaskedValue": "string",
  • "maskedValue": "string"
}

BookmarkedSearchDynamicFilterValuesV100

Any of
terms
required
Array of strings
{
  • "maskedTextMatch": {
    }
}

BookmarkedSearchFilterValuesV100

dynamicFilters
required
object

Filter values associated to specific dynamic filters.

object (BookmarkedSearchStringRangeV100)
to
string

The start of the range. Dates should use the ISO 8601 format.

from
string

The start of the range. Dates should use the ISO 8601 format.

entityIds
required
Array of strings

List of entity table ids used in the search.

{
  • "dynamicFilters": {
    },
  • "primaryTime": {
    },
  • "entityIds": [
    ]
}

AnyObjectEsType_BookmarkedSearchFilterValuesV100_

dynamicFilters
required
object

Filter values associated to specific dynamic filters.

object (BookmarkedSearchStringRangeV100)
to
string

The start of the range. Dates should use the ISO 8601 format.

from
string

The start of the range. Dates should use the ISO 8601 format.

entityIds
required
Array of strings

List of entity table ids used in the search.

{
  • "dynamicFilters": {
    },
  • "primaryTime": {
    },
  • "entityIds": [
    ]
}

long

number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

0
0

SavedBookmarkedSearchAttributesV100

version
required
number <integer>
Value: 100

Bookmarked search object version.

updatedAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

createdAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

Array of objects

List of records filtered by selection in the search the last time it was saved. An empty array means no filtering.

Array
searchId
required
string
_index
required
string
_id
required
string
required
object (AnyObjectEsType_BookmarkedSearchFilterValuesV100_)
dynamicFilters
required
object

Filter values associated to specific dynamic filters.

object (BookmarkedSearchStringRangeV100)
to
string

The start of the range. Dates should use the ISO 8601 format.

from
string

The start of the range. Dates should use the ISO 8601 format.

entityIds
required
Array of strings

List of entity table ids used in the search.

inputString
required
string

Search string from the search bar.

required
object (AnyObjectEsType_BookmarkedSearchDefinitionsV100_)
required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV100)

Dynamic filter objects

Array
required
object (DynamicFilterAttributesV101)
id
required
string
required
Array of objects (BookmarkedSearchSavedSearchDefinitionV100)

Saved search objects.

Array
required
Array of objects (DynamicFilterMappingV103)
timeFieldName
string
fields
required
object
required
object (GlobalSearchSettingsV103)
id
required
string
config
required
object

Configuration object.

kibiVersion
required
string

Investigate version.

title
required
string

Title for bookmarked search

{
  • "version": 100,
  • "updatedAt": 0,
  • "createdAt": 0,
  • "selectedDMRecordIds": [
    ],
  • "filterValues": {
    },
  • "inputString": "string",
  • "definitions": {
    },
  • "title": "string"
}

ObjectPayload_SavedBookmarkedSearchAttributesV100_

required
object (SavedBookmarkedSearchAttributesV100)
version
required
number <integer>
Value: 100

Bookmarked search object version.

updatedAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

createdAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

Array of objects

List of records filtered by selection in the search the last time it was saved. An empty array means no filtering.

Array
searchId
required
string
_index
required
string
_id
required
string
required
object (AnyObjectEsType_BookmarkedSearchFilterValuesV100_)
dynamicFilters
required
object

Filter values associated to specific dynamic filters.

object (BookmarkedSearchStringRangeV100)
to
string

The start of the range. Dates should use the ISO 8601 format.

from
string

The start of the range. Dates should use the ISO 8601 format.

entityIds
required
Array of strings

List of entity table ids used in the search.

inputString
required
string

Search string from the search bar.

required
object (AnyObjectEsType_BookmarkedSearchDefinitionsV100_)
required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV100)

Dynamic filter objects

Array
required
object (DynamicFilterAttributesV101)
id
required
string
required
Array of objects (BookmarkedSearchSavedSearchDefinitionV100)

Saved search objects.

Array
required
Array of objects (DynamicFilterMappingV103)
timeFieldName
string
fields
required
object
required
object (GlobalSearchSettingsV103)
id
required
string
config
required
object

Configuration object.

kibiVersion
required
string

Investigate version.

title
required
string

Title for bookmarked search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

ObjectDefinitionId

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

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

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

GlobalSearchSettingsV104

selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

{
  • "selectedByDefault": true,
  • "forceSearchedOnTimeFilter": true,
  • "boost": 0.1,
  • "enabled": true
}

DynamicFilterMappingV104

filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "filterId": "string",
  • "field": "string"
}

BookmarkedSearchSavedSearchDefinitionV101

required
Array of objects (DynamicFilterMappingV104)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

timeFieldName
string
fields
required
object
required
object (GlobalSearchSettingsV104)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

id
required
string
{
  • "dynamicFilters": [
    ],
  • "timeFieldName": "string",
  • "fields": {
    },
  • "globalSearch": {
    },
  • "id": "string"
}

DynamicFilterAttributesV102

version
required
number <integer>
Value: 102

DynamicFilter object version

required
object
ignoreTimezone
boolean <boolean>

Don't use local time zone to convert Date queries to UTC

includeTime
required
boolean <boolean>

Include/Exclude time

inputMask
required
string <string>

Input mask value to apply to input

useRange
required
boolean <boolean>

Whether to display a range or single input box. Search a value within a range instead of exact value

showExactMatchOption
required
boolean <boolean>

Whether to show the option that allows a user to indicate that matching should be strict or fuzzy/tokenized

options
required
string <string>

Additional options on dynamic filters, e.g filter by number ranges

histogram
required
boolean <boolean>

Whether to show the counts and bar charts for the categories

multiselect
required
boolean <boolean>

Whether the user should be able to select more than a single category (ORed together). If true, the categories become checkboxes instead of radio buttons

searchable
required
boolean <boolean>

Whether the categories can be filtered using a text field. This is useful if there are hundreds of categories available to choose from

sorting
required
string <string>
Enum: "fixed" "alphabetic" "hits"

How categories are sorted when the dynamic filter is rendered

visibleOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

type
required
string <keyword>
Enum: "manual" "automatic" "none"

How categories (i.e. options) shall be determined. These categories represent values for the mapped fields and are used to filter the data

required
string or string <keyword>

The type of field the dynamic filter will be mapped to

Any of
string <keyword>

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

{
  • "version": 102,
  • "categories": {
    },
  • "type": "string",
  • "title": "string"
}

BookmarkedSearchDynamicFilterDefinitionV101

required
object (DynamicFilterAttributesV102)
version
required
number <integer>
Value: 102

DynamicFilter object version

required
object
ignoreTimezone
boolean <boolean>

Don't use local time zone to convert Date queries to UTC

includeTime
required
boolean <boolean>

Include/Exclude time

inputMask
required
string <string>

Input mask value to apply to input

useRange
required
boolean <boolean>

Whether to display a range or single input box. Search a value within a range instead of exact value

showExactMatchOption
required
boolean <boolean>

Whether to show the option that allows a user to indicate that matching should be strict or fuzzy/tokenized

options
required
string <string>

Additional options on dynamic filters, e.g filter by number ranges

histogram
required
boolean <boolean>

Whether to show the counts and bar charts for the categories

multiselect
required
boolean <boolean>

Whether the user should be able to select more than a single category (ORed together). If true, the categories become checkboxes instead of radio buttons

searchable
required
boolean <boolean>

Whether the categories can be filtered using a text field. This is useful if there are hundreds of categories available to choose from

sorting
required
string <string>
Enum: "fixed" "alphabetic" "hits"

How categories are sorted when the dynamic filter is rendered

visibleOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

type
required
string <keyword>
Enum: "manual" "automatic" "none"

How categories (i.e. options) shall be determined. These categories represent values for the mapped fields and are used to filter the data

required
string or string <keyword>

The type of field the dynamic filter will be mapped to

Any of
string <keyword>

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

id
required
string
{
  • "attributes": {
    },
  • "id": "string"
}

BookmarkedSearchDefinitionsV101

required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV101)

Dynamic filter objects

Array
required
object (DynamicFilterAttributesV102)
version
required
number <integer>
Value: 102

DynamicFilter object version

required
object
required
string or string <keyword>

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

id
required
string
required
Array of objects (BookmarkedSearchSavedSearchDefinitionV101)

Saved search objects.

Array
required
Array of objects (DynamicFilterMappingV104)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

timeFieldName
string
fields
required
object
required
object (GlobalSearchSettingsV104)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

id
required
string
config
required
object

Configuration object.

kibiVersion
required
string

Investigate version.

{
  • "dynamicFilters": [
    ],
  • "savedSearches": [
    ],
  • "config": {
    },
  • "kibiVersion": "string"
}

AnyObjectEsType_BookmarkedSearchDefinitionsV101_

required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV101)

Dynamic filter objects

Array
required
object (DynamicFilterAttributesV102)
version
required
number <integer>
Value: 102

DynamicFilter object version

required
object
required
string or string <keyword>

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

id
required
string
required
Array of objects (BookmarkedSearchSavedSearchDefinitionV101)

Saved search objects.

Array
required
Array of objects (DynamicFilterMappingV104)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

timeFieldName
string
fields
required
object
required
object (GlobalSearchSettingsV104)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

id
required
string
config
required
object

Configuration object.

kibiVersion
required
string

Investigate version.

{
  • "dynamicFilters": [
    ],
  • "savedSearches": [
    ],
  • "config": {
    },
  • "kibiVersion": "string"
}

BookmarkedSearchStringRangeV101

to
string

The start of the range. Dates should use the ISO 8601 format.

from
string

The start of the range. Dates should use the ISO 8601 format.

{
  • "to": "string",
  • "from": "string"
}

BookmarkedSearchNumberRangeV101

to
number <double>

The end of the range.

from
number <double>

The start of the range.

{
  • "to": 0.1,
  • "from": 0.1
}

BookmarkedSearchPlainTextMatchV101

exactMatch
required
boolean

Whether the text string should match the whole field value or just part of it.

string or number

Value to match.

Any of
string

Value to match.

{
  • "exactMatch": true,
  • "query": "string"
}

BookmarkedSearchMaskedTextMatchV101

exactMatch
required
boolean

Whether the text string should match the whole field value or just part of it.

unmaskedValue
required
string

Searched value.

maskedValue
required
string

Value to match as displayed in the search bar.

{
  • "exactMatch": true,
  • "unmaskedValue": "string",
  • "maskedValue": "string"
}

BookmarkedSearchDynamicFilterValuesV101

Any of
terms
required
Array of strings
{
  • "range": {
    }
}

BookmarkedSearchFilterValuesV101

dynamicFilters
required
object

Filter values associated to specific dynamic filters.

object (BookmarkedSearchStringRangeV101)
to
string

The start of the range. Dates should use the ISO 8601 format.

from
string

The start of the range. Dates should use the ISO 8601 format.

entityIds
required
Array of strings

List of entity table ids used in the search.

{
  • "dynamicFilters": {
    },
  • "primaryTime": {
    },
  • "entityIds": [
    ]
}

AnyObjectEsType_BookmarkedSearchFilterValuesV101_

dynamicFilters
required
object

Filter values associated to specific dynamic filters.

object (BookmarkedSearchStringRangeV101)
to
string

The start of the range. Dates should use the ISO 8601 format.

from
string

The start of the range. Dates should use the ISO 8601 format.

entityIds
required
Array of strings

List of entity table ids used in the search.

{
  • "dynamicFilters": {
    },
  • "primaryTime": {
    },
  • "entityIds": [
    ]
}

SavedBookmarkedSearchAttributesV101

version
required
number <integer>
Value: 101

Bookmarked search object version.

updatedAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

createdAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

Array of objects

List of records filtered by selection in the search the last time it was saved. An empty array means no filtering.

Array
searchId
required
string
_index
required
string
_id
required
string
required
object (AnyObjectEsType_BookmarkedSearchFilterValuesV101_)
dynamicFilters
required
object

Filter values associated to specific dynamic filters.

object (BookmarkedSearchStringRangeV101)
to
string

The start of the range. Dates should use the ISO 8601 format.

from
string

The start of the range. Dates should use the ISO 8601 format.

entityIds
required
Array of strings

List of entity table ids used in the search.

inputString
required
string

Search string from the search bar.

required
object (AnyObjectEsType_BookmarkedSearchDefinitionsV101_)
required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV101)

Dynamic filter objects

Array
required
object (DynamicFilterAttributesV102)
id
required
string
required
Array of objects (BookmarkedSearchSavedSearchDefinitionV101)

Saved search objects.

Array
required
Array of objects (DynamicFilterMappingV104)
timeFieldName
string
fields
required
object
required
object (GlobalSearchSettingsV104)
id
required
string
config
required
object

Configuration object.

kibiVersion
required
string

Investigate version.

title
required
string

Title for bookmarked search

{
  • "version": 101,
  • "updatedAt": 0,
  • "createdAt": 0,
  • "selectedDMRecordIds": [
    ],
  • "filterValues": {
    },
  • "inputString": "string",
  • "definitions": {
    },
  • "title": "string"
}

ObjectPayload_SavedBookmarkedSearchAttributesV101_

required
object (SavedBookmarkedSearchAttributesV101)
version
required
number <integer>
Value: 101

Bookmarked search object version.

updatedAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

createdAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

Array of objects

List of records filtered by selection in the search the last time it was saved. An empty array means no filtering.

Array
searchId
required
string
_index
required
string
_id
required
string
required
object (AnyObjectEsType_BookmarkedSearchFilterValuesV101_)
dynamicFilters
required
object

Filter values associated to specific dynamic filters.

object (BookmarkedSearchStringRangeV101)
to
string

The start of the range. Dates should use the ISO 8601 format.

from
string

The start of the range. Dates should use the ISO 8601 format.

entityIds
required
Array of strings

List of entity table ids used in the search.

inputString
required
string

Search string from the search bar.

required
object (AnyObjectEsType_BookmarkedSearchDefinitionsV101_)
required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV101)

Dynamic filter objects

Array
required
object (DynamicFilterAttributesV102)
id
required
string
required
Array of objects (BookmarkedSearchSavedSearchDefinitionV101)

Saved search objects.

Array
required
Array of objects (DynamicFilterMappingV104)
timeFieldName
string
fields
required
object
required
object (GlobalSearchSettingsV104)
id
required
string
config
required
object

Configuration object.

kibiVersion
required
string

Investigate version.

title
required
string

Title for bookmarked search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

GlobalSearchRecencyBoostRangeV108

boost
required
number <double>
required
object
count
required
number <double>
unit
required
string
Enum: "y" "M" "w" "d" "h" "m" "s"
{
  • "boost": 0.1,
  • "from": {
    }
}

GlobalSearchSettings

selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

Array
boost
required
number <double>
required
object
count
required
number <double>
unit
required
string
Enum: "y" "M" "w" "d" "h" "m" "s"
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

{
  • "selectedByDefault": true,
  • "forceSearchedOnTimeFilter": true,
  • "recencyBoost": [
    ],
  • "boost": 0.1,
  • "enabled": true
}

DynamicFilterMapping

filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "filterId": "string",
  • "field": "string"
}

BookmarkedSearchSavedSearchDefinitionV102

id
required
string
required
object (GlobalSearchSettings)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

Array
boost
required
number <double>
required
object
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

fields
required
object
timeFieldName
string
required
Array of objects (DynamicFilterMapping)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "id": "string",
  • "globalSearch": {
    },
  • "fields": {
    },
  • "timeFieldName": "string",
  • "dynamicFilters": [
    ]
}

DynamicFilterAttributes

version
required
number <integer>
Value: 102

DynamicFilter object version

required
object
ignoreTimezone
boolean <boolean>

Don't use local time zone to convert Date queries to UTC

includeTime
required
boolean <boolean>

Include/Exclude time

inputMask
required
string <string>

Input mask value to apply to input

useRange
required
boolean <boolean>

Whether to display a range or single input box. Search a value within a range instead of exact value

showExactMatchOption
required
boolean <boolean>

Whether to show the option that allows a user to indicate that matching should be strict or fuzzy/tokenized

options
required
string <string>

Additional options on dynamic filters, e.g filter by number ranges

histogram
required
boolean <boolean>

Whether to show the counts and bar charts for the categories

multiselect
required
boolean <boolean>

Whether the user should be able to select more than a single category (ORed together). If true, the categories become checkboxes instead of radio buttons

searchable
required
boolean <boolean>

Whether the categories can be filtered using a text field. This is useful if there are hundreds of categories available to choose from

sorting
required
string <string>
Enum: "fixed" "alphabetic" "hits"

How categories are sorted when the dynamic filter is rendered

visibleOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

type
required
string <keyword>
Enum: "manual" "automatic" "none"

How categories (i.e. options) shall be determined. These categories represent values for the mapped fields and are used to filter the data

required
string or string <keyword>

The type of field the dynamic filter will be mapped to

Any of
string <keyword>

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

{
  • "version": 102,
  • "categories": {
    },
  • "type": "string",
  • "title": "string"
}

BookmarkedSearchDynamicFilterDefinitionV102

id
required
string
required
object (DynamicFilterAttributes)
version
required
number <integer>
Value: 102

DynamicFilter object version

required
object
ignoreTimezone
boolean <boolean>

Don't use local time zone to convert Date queries to UTC

includeTime
required
boolean <boolean>

Include/Exclude time

inputMask
required
string <string>

Input mask value to apply to input

useRange
required
boolean <boolean>

Whether to display a range or single input box. Search a value within a range instead of exact value

showExactMatchOption
required
boolean <boolean>

Whether to show the option that allows a user to indicate that matching should be strict or fuzzy/tokenized

options
required
string <string>

Additional options on dynamic filters, e.g filter by number ranges

histogram
required
boolean <boolean>

Whether to show the counts and bar charts for the categories

multiselect
required
boolean <boolean>

Whether the user should be able to select more than a single category (ORed together). If true, the categories become checkboxes instead of radio buttons

searchable
required
boolean <boolean>

Whether the categories can be filtered using a text field. This is useful if there are hundreds of categories available to choose from

sorting
required
string <string>
Enum: "fixed" "alphabetic" "hits"

How categories are sorted when the dynamic filter is rendered

visibleOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

type
required
string <keyword>
Enum: "manual" "automatic" "none"

How categories (i.e. options) shall be determined. These categories represent values for the mapped fields and are used to filter the data

required
string or string <keyword>

The type of field the dynamic filter will be mapped to

Any of
string <keyword>

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

{
  • "id": "string",
  • "attributes": {
    }
}

BookmarkedSearchDefinitionsV102

kibiVersion
required
string

Investigate version.

config
required
object

Configuration object.

required
Array of objects (BookmarkedSearchSavedSearchDefinitionV102)

Saved search objects.

Array
id
required
string
required
object (GlobalSearchSettings)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

fields
required
object
timeFieldName
string
required
Array of objects (DynamicFilterMapping)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV102)

Dynamic filter objects

Array
id
required
string
required
object (DynamicFilterAttributes)
version
required
number <integer>
Value: 102

DynamicFilter object version

required
object
required
string or string <keyword>

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

{
  • "kibiVersion": "string",
  • "config": {
    },
  • "savedSearches": [
    ],
  • "dynamicFilters": [
    ]
}

AnyObjectEsType_BookmarkedSearchDefinitionsV102_

kibiVersion
required
string

Investigate version.

config
required
object

Configuration object.

required
Array of objects (BookmarkedSearchSavedSearchDefinitionV102)

Saved search objects.

Array
id
required
string
required
object (GlobalSearchSettings)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

fields
required
object
timeFieldName
string
required
Array of objects (DynamicFilterMapping)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV102)

Dynamic filter objects

Array
id
required
string
required
object (DynamicFilterAttributes)
version
required
number <integer>
Value: 102

DynamicFilter object version

required
object
required
string or string <keyword>

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

{
  • "kibiVersion": "string",
  • "config": {
    },
  • "savedSearches": [
    ],
  • "dynamicFilters": [
    ]
}

BookmarkedSearchStringRangeV102

from
string

The start of the range. Dates should use the ISO 8601 format.

to
string

The start of the range. Dates should use the ISO 8601 format.

boostRecent
boolean

Apply boosting of recent documents based on the recencyBoost configuration for Entity tables.

{
  • "from": "string",
  • "to": "string",
  • "boostRecent": true
}

BookmarkedSearchMaskedTextMatchV102

maskedValue
required
string

Value to match as displayed in the search bar.

unmaskedValue
required
string

Searched value.

exactMatch
required
boolean

Whether the text string should match the whole field value or just part of it.

isComplete
required
boolean

Whether the masked value fully completes the input mask

{
  • "maskedValue": "string",
  • "unmaskedValue": "string",
  • "exactMatch": true,
  • "isComplete": true
}

BookmarkedSearchTextNoCategoriesValueV102

Any of
exactMatch
required
boolean
query
required
string
Example
{
  • "exactMatch": true,
  • "query": "string"
}

BookmarkedSearchKeywordNoCategoriesValueV102

Any of
string
Example
"string"

BookmarkedSearchNumberManualValueV102

Array
to
number <double>
from
number <double>
[
  • {
    }
]

BookmarkedSearchAgeManualValueV102

Array
to
number <double>
from
number <double>
[
  • {
    }
]

BookmarkedSearchDateNoCategoriesValueV102

Any of
from
string

The start of the range. Dates should use the ISO 8601 format.

to
string

The start of the range. Dates should use the ISO 8601 format.

boostRecent
boolean

Apply boosting of recent documents based on the recencyBoost configuration for Entity tables.

Example
{
  • "from": "string",
  • "to": "string",
  • "boostRecent": true
}

BookmarkedSearchNumberNoCategoriesValueV102

number <double> (BookmarkedSearchNumberNoCategoriesValueV102)
0.1

BookmarkedSearchAgeNoCategoriesValueV102

number <double> (BookmarkedSearchAgeNoCategoriesValueV102)
0.1

BookmarkedSearchKeywordAutomaticValueV102

Array
string
[
  • "string"
]

BookmarkedSearchExistsAutomaticValueV102

string (BookmarkedSearchExistsAutomaticValueV102)
Enum: "Exists" "Does not exist"
"Exists"

BookmarkedSearchDynamicFilterValueV102

Any of
Any of
exactMatch
required
boolean
query
required
string
Example
{
  • "exactMatch": true,
  • "query": "string"
}

BookmarkedSearchFilterValuesV102

entityIds
required
Array of strings

List of entity table ids used in the search.

object (BookmarkedSearchStringRangeV102)
from
string

The start of the range. Dates should use the ISO 8601 format.

to
string

The start of the range. Dates should use the ISO 8601 format.

boostRecent
boolean

Apply boosting of recent documents based on the recencyBoost configuration for Entity tables.

dynamicFilters
object

Filter values associated to specific dynamic filters.

{
  • "entityIds": [
    ],
  • "primaryTime": {
    },
  • "dynamicFilters": {
    }
}

AnyObjectEsType_BookmarkedSearchFilterValuesV102_

entityIds
required
Array of strings

List of entity table ids used in the search.

object (BookmarkedSearchStringRangeV102)
from
string

The start of the range. Dates should use the ISO 8601 format.

to
string

The start of the range. Dates should use the ISO 8601 format.

boostRecent
boolean

Apply boosting of recent documents based on the recencyBoost configuration for Entity tables.

dynamicFilters
object

Filter values associated to specific dynamic filters.

{
  • "entityIds": [
    ],
  • "primaryTime": {
    },
  • "dynamicFilters": {
    }
}

SavedBookmarkedSearchAttributesV102

version
required
number <integer>
Value: 102

Bookmarked search object version.

updatedAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

createdAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

Array of objects

List of records filtered by selection in the search the last time it was saved. An empty array means no filtering.

Array
searchId
required
string
_index
required
string
_id
required
string
required
object (AnyObjectEsType_BookmarkedSearchFilterValuesV102_)
entityIds
required
Array of strings

List of entity table ids used in the search.

object (BookmarkedSearchStringRangeV102)
from
string

The start of the range. Dates should use the ISO 8601 format.

to
string

The start of the range. Dates should use the ISO 8601 format.

boostRecent
boolean

Apply boosting of recent documents based on the recencyBoost configuration for Entity tables.

dynamicFilters
object

Filter values associated to specific dynamic filters.

object

Search options.

showEquivalentResults
required
boolean <boolean>

Should equivalent results be shown

inputString
required
string

Search string from the search bar.

required
object (AnyObjectEsType_BookmarkedSearchDefinitionsV102_)
kibiVersion
required
string

Investigate version.

config
required
object

Configuration object.

required
Array of objects (BookmarkedSearchSavedSearchDefinitionV102)

Saved search objects.

Array
id
required
string
required
object (GlobalSearchSettings)
fields
required
object
timeFieldName
string
required
Array of objects (DynamicFilterMapping)
required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV102)

Dynamic filter objects

Array
id
required
string
required
object (DynamicFilterAttributes)
title
required
string

Title for bookmarked search

{
  • "version": 102,
  • "updatedAt": 0,
  • "createdAt": 0,
  • "selectedDMRecordIds": [
    ],
  • "filterValues": {
    },
  • "options": {
    },
  • "inputString": "string",
  • "definitions": {
    },
  • "title": "string"
}

ObjectPayload_SavedBookmarkedSearchAttributesV102_

required
object (SavedBookmarkedSearchAttributesV102)
version
required
number <integer>
Value: 102

Bookmarked search object version.

updatedAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

createdAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

Array of objects

List of records filtered by selection in the search the last time it was saved. An empty array means no filtering.

Array
searchId
required
string
_index
required
string
_id
required
string
required
object (AnyObjectEsType_BookmarkedSearchFilterValuesV102_)
entityIds
required
Array of strings

List of entity table ids used in the search.

object (BookmarkedSearchStringRangeV102)
from
string

The start of the range. Dates should use the ISO 8601 format.

to
string

The start of the range. Dates should use the ISO 8601 format.

boostRecent
boolean

Apply boosting of recent documents based on the recencyBoost configuration for Entity tables.

dynamicFilters
object

Filter values associated to specific dynamic filters.

object

Search options.

showEquivalentResults
required
boolean <boolean>

Should equivalent results be shown

inputString
required
string

Search string from the search bar.

required
object (AnyObjectEsType_BookmarkedSearchDefinitionsV102_)
kibiVersion
required
string

Investigate version.

config
required
object

Configuration object.

required
Array of objects (BookmarkedSearchSavedSearchDefinitionV102)

Saved search objects.

Array
id
required
string
required
object (GlobalSearchSettings)
fields
required
object
timeFieldName
string
required
Array of objects (DynamicFilterMapping)
required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV102)

Dynamic filter objects

Array
id
required
string
required
object (DynamicFilterAttributes)
title
required
string

Title for bookmarked search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedConfigAttributesV100

version
required
number <integer>
Value: 100

config object version

kibi:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

buildNum
number or null <integer>

Custom Setting Default: 12342

jira:csvExportSize
number or null <integer>

Max number of documents to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:showIntroVideos
boolean or null <boolean>

Enable introductory videos Default: false

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between documents that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

(boolean or null) or (string or null) <boolean>

The URL can sometimes grow to be too large for some browsers to handle. To counter-act this we are testing if storing parts of the URL in sessions storage could help. Please let us know how it goes! Default: true

Any of
boolean or null <boolean>

The URL can sometimes grow to be too large for some browsers to handle. To counter-act this we are testing if storing parts of the URL in sessions storage could help. Please let us know how it goes! Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to Infinity will disable. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to Infinity will disable. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to Infinity will disable. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to Infinity will disable. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile maps: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big documents. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our document when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight-type
string or null <keyword>
Enum: "unified" "plain"

Sets the default highlighter type for highlighted query matches. The two types of highlighter are 'unified' and 'plain'. For more information, see the Siren Investigate documentation. Default: unified

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns documents based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of documents allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of documents sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

siren:autoRelations:shardTimeout
number or null <integer>

Milliseconds reserved for computing a single Fingerprints/Relations Wizard request Default: 5000

property name*
additional property
any
{
  • "version": 100,
  • "kibi:timeline:highlight:number_of_fragments": 0,
  • "siren:timeline:highlight:number_of_fragments": 0,
  • "buildNum": 0,
  • "jira:csvExportSize": 0,
  • "jira:fields": "string",
  • "timelion:min_interval": "string",
  • "timelion:default_rows": 0,
  • "timelion:default_columns": 0,
  • "timelion:max_buckets": 0,
  • "timelion:target_buckets": 0,
  • "timelion:es.default_index": "string",
  • "timelion:es.timefield": "string",
  • "timelion:showTutorial": true,
  • "siren:scoringSearchType": "query_then_fetch",
  • "siren:globalSearchDebugging": true,
  • "siren:elasticsearch:searchErrorTrace": true,
  • "siren:showIntroVideos": true,
  • "siren:defaultGraphVisualizerId": "string",
  • "siren:bufferAreaDefaultUnit": "Kilometers",
  • "siren:countFetchingStrategyRelationalFilters": "string",
  • "siren:countFetchingStrategyDashboards": "string",
  • "siren:graphStatesLimit": 0,
  • "siren:excludedIndices": "string",
  • "siren:defaultDashboardId": "string",
  • "siren:enableAllRelBtnCounts": true,
  • "siren:vertical_grid_resolution": 0,
  • "siren:panel_vertical_size": 0,
  • "siren:joinTaskTimeout": 0,
  • "siren:timePrecision": "y",
  • "siren:support-large-numbers": true,
  • "siren:dashboards360:showDashboardDataModelPopup": true,
  • "context:tieBreakerFields": [
    ],
  • "context:step": 0,
  • "context:defaultSize": 0,
  • "indexPattern:placeholder": "string",
  • "state:storeInSessionStorage": true,
  • "metrics:max_buckets": 0,
  • "notifications:lifetime:info": 0,
  • "notifications:lifetime:warning": 0,
  • "notifications:lifetime:error": 0,
  • "notifications:lifetime:banner": 0,
  • "notifications:banner": "string",
  • "filterEditor:suggestValues": true,
  • "filters:pinnedByDefault": true,
  • "dashboard:defaultDarkTheme": true,
  • "timepicker:autoRefreshAllDashboardCount": true,
  • "timepicker:refreshIntervalDefaults": "string",
  • "timepicker:timeDefaults": "string",
  • "savedObjects:listingLimit": 0,
  • "savedObjects:perPage": 0,
  • "format:currency:defaultPattern": "string",
  • "format:percent:defaultPattern": "string",
  • "format:bytes:defaultPattern": "string",
  • "format:number:defaultPattern": "string",
  • "format:defaultTypeMap": "string",
  • "truncate:maxHeight": 0,
  • "shortDots:enable": true,
  • "history:limit": 0,
  • "csv:quoteValues": true,
  • "csv:separator": "string",
  • "visualization:dimmingOpacity": 0.1,
  • "visualization:loadingDelay": "string",
  • "visualization:colorMapping": "string",
  • "visualization:regionmap:showWarnings": true,
  • "visualization:tileMap:WMSdefaults": "string",
  • "visualization:tileMap:maxPrecision": 0,
  • "histogram:maxBars": 0,
  • "histogram:barTarget": 0,
  • "fields:popularLimit": 0,
  • "courier:sequentialSearches": true,
  • "courier:batchSearches": true,
  • "courier:ignoreFilterIfFieldNotInIndex": true,
  • "courier:maxSegmentCount": 0,
  • "doc_table:highlight": true,
  • "discover:aggs:terms:size": 0,
  • "discover:sampleSize": 0,
  • "metaFields": [
    ],
  • "defaultColumns": [
    ],
  • "dateFormat:dow": "Monday",
  • "dateFormat:scaled": "string",
  • "dateFormat:tz": "string",
  • "dateFormat": "string",
  • "sort:options": "string",
  • "query:queryString:options": "string",
  • "default:highlight-type": "unified",
  • "inputControlVis:timeout": 0,
  • "siren:globalSearchSimpleQuerySyntaxOptions": "string",
  • "siren:globalSearchQuerySyntax": "query_string",
  • "siren:globalSearchTimeout": 0,
  • "sentinl:experimental": true,
  • "siren:scripting:notify": true,
  • "siren:scripting:enabled": true,
  • "data-model:max_documents_for_reindex_operations": 0,
  • "ingest-xlsx:progress_updation_frequency": 0,
  • "ingest-xlsx:simultaneous_bulk_requests": 0,
  • "ingest-xlsx:displayed_rows": 0,
  • "ingest-xlsx:bulk_package_size": 0,
  • "graph-browser:shortestPathLogLevel": "Debug",
  • "siren:autoRelations:shardTimeout": 0,
  • "property1": null,
  • "property2": null
}

ObjectPayload_SavedConfigAttributesV100_

required
object (SavedConfigAttributesV100)
version
required
number <integer>
Value: 100

config object version

kibi:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

buildNum
number or null <integer>

Custom Setting Default: 12342

jira:csvExportSize
number or null <integer>

Max number of documents to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:showIntroVideos
boolean or null <boolean>

Enable introductory videos Default: false

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between documents that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

(boolean or null) or (string or null) <boolean>

The URL can sometimes grow to be too large for some browsers to handle. To counter-act this we are testing if storing parts of the URL in sessions storage could help. Please let us know how it goes! Default: true

Any of
boolean or null <boolean>

The URL can sometimes grow to be too large for some browsers to handle. To counter-act this we are testing if storing parts of the URL in sessions storage could help. Please let us know how it goes! Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to Infinity will disable. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to Infinity will disable. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to Infinity will disable. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to Infinity will disable. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile maps: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big documents. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our document when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight-type
string or null <keyword>
Enum: "unified" "plain"

Sets the default highlighter type for highlighted query matches. The two types of highlighter are 'unified' and 'plain'. For more information, see the Siren Investigate documentation. Default: unified

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns documents based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of documents allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of documents sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

siren:autoRelations:shardTimeout
number or null <integer>

Milliseconds reserved for computing a single Fingerprints/Relations Wizard request Default: 5000

property name*
additional property
any
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedConfigAttributesV101

version
required
number <integer>
Value: 101

config object version

kibi:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

buildNum
number or null <integer>

Custom Setting Default: 12342

jira:csvExportSize
number or null <integer>

Max number of documents to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:showIntroVideos
boolean or null <boolean>

Enable introductory videos Default: false

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between documents that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to Infinity will disable. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to Infinity will disable. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to Infinity will disable. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to Infinity will disable. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile maps: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big documents. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our document when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight-type
string or null <keyword>
Enum: "unified" "plain"

Sets the default highlighter type for highlighted query matches. The two types of highlighter are 'unified' and 'plain'. For more information, see the Siren Investigate documentation. Default: unified

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns documents based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of documents allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of documents sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
{
  • "version": 101,
  • "kibi:timeline:highlight:number_of_fragments": 0,
  • "siren:timeline:highlight:number_of_fragments": 0,
  • "buildNum": 0,
  • "jira:csvExportSize": 0,
  • "jira:fields": "string",
  • "timelion:min_interval": "string",
  • "timelion:default_rows": 0,
  • "timelion:default_columns": 0,
  • "timelion:max_buckets": 0,
  • "timelion:target_buckets": 0,
  • "timelion:es.default_index": "string",
  • "timelion:es.timefield": "string",
  • "timelion:showTutorial": true,
  • "siren:scoringSearchType": "query_then_fetch",
  • "siren:globalSearchDebugging": true,
  • "siren:elasticsearch:searchErrorTrace": true,
  • "siren:showIntroVideos": true,
  • "siren:defaultGraphVisualizerId": "string",
  • "siren:bufferAreaDefaultUnit": "Kilometers",
  • "siren:countFetchingStrategyRelationalFilters": "string",
  • "siren:countFetchingStrategyDashboards": "string",
  • "siren:graphStatesLimit": 0,
  • "siren:excludedIndices": "string",
  • "siren:defaultDashboardId": "string",
  • "siren:enableAllRelBtnCounts": true,
  • "siren:vertical_grid_resolution": 0,
  • "siren:panel_vertical_size": 0,
  • "siren:joinTaskTimeout": 0,
  • "siren:timePrecision": "y",
  • "siren:support-large-numbers": true,
  • "siren:dashboards360:showDashboardDataModelPopup": true,
  • "context:tieBreakerFields": [
    ],
  • "context:step": 0,
  • "context:defaultSize": 0,
  • "indexPattern:placeholder": "string",
  • "state:storeInSessionStorage": true,
  • "metrics:max_buckets": 0,
  • "notifications:lifetime:info": 0,
  • "notifications:lifetime:warning": 0,
  • "notifications:lifetime:error": 0,
  • "notifications:lifetime:banner": 0,
  • "notifications:banner": "string",
  • "filterEditor:suggestValues": true,
  • "filters:pinnedByDefault": true,
  • "dashboard:defaultDarkTheme": true,
  • "timepicker:autoRefreshAllDashboardCount": true,
  • "timepicker:refreshIntervalDefaults": "string",
  • "timepicker:timeDefaults": "string",
  • "savedObjects:listingLimit": 0,
  • "savedObjects:perPage": 0,
  • "format:currency:defaultPattern": "string",
  • "format:percent:defaultPattern": "string",
  • "format:bytes:defaultPattern": "string",
  • "format:number:defaultPattern": "string",
  • "format:defaultTypeMap": "string",
  • "truncate:maxHeight": 0,
  • "shortDots:enable": true,
  • "history:limit": 0,
  • "csv:quoteValues": true,
  • "csv:separator": "string",
  • "visualization:dimmingOpacity": 0.1,
  • "visualization:loadingDelay": "string",
  • "visualization:colorMapping": "string",
  • "visualization:regionmap:showWarnings": true,
  • "visualization:tileMap:WMSdefaults": "string",
  • "visualization:tileMap:maxPrecision": 0,
  • "histogram:maxBars": 0,
  • "histogram:barTarget": 0,
  • "fields:popularLimit": 0,
  • "courier:sequentialSearches": true,
  • "courier:batchSearches": true,
  • "courier:ignoreFilterIfFieldNotInIndex": true,
  • "courier:maxSegmentCount": 0,
  • "doc_table:highlight": true,
  • "discover:aggs:terms:size": 0,
  • "discover:sampleSize": 0,
  • "metaFields": [
    ],
  • "defaultColumns": [
    ],
  • "dateFormat:dow": "Monday",
  • "dateFormat:scaled": "string",
  • "dateFormat:tz": "string",
  • "dateFormat": "string",
  • "sort:options": "string",
  • "query:queryString:options": "string",
  • "default:highlight-type": "unified",
  • "inputControlVis:timeout": 0,
  • "siren:globalSearchSimpleQuerySyntaxOptions": "string",
  • "siren:globalSearchQuerySyntax": "query_string",
  • "siren:globalSearchTimeout": 0,
  • "sentinl:experimental": true,
  • "siren:scripting:notify": true,
  • "siren:scripting:enabled": true,
  • "data-model:max_documents_for_reindex_operations": 0,
  • "ingest-xlsx:progress_updation_frequency": 0,
  • "ingest-xlsx:simultaneous_bulk_requests": 0,
  • "ingest-xlsx:displayed_rows": 0,
  • "ingest-xlsx:bulk_package_size": 0,
  • "graph-browser:shortestPathLogLevel": "Debug",
  • "property1": null,
  • "property2": null
}

ObjectPayload_SavedConfigAttributesV101_

required
object (SavedConfigAttributesV101)
version
required
number <integer>
Value: 101

config object version

kibi:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

buildNum
number or null <integer>

Custom Setting Default: 12342

jira:csvExportSize
number or null <integer>

Max number of documents to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:showIntroVideos
boolean or null <boolean>

Enable introductory videos Default: false

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between documents that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to Infinity will disable. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to Infinity will disable. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to Infinity will disable. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to Infinity will disable. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile maps: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big documents. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our document when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight-type
string or null <keyword>
Enum: "unified" "plain"

Sets the default highlighter type for highlighted query matches. The two types of highlighter are 'unified' and 'plain'. For more information, see the Siren Investigate documentation. Default: unified

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns documents based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of documents allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of documents sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedConfigAttributesV102

version
required
number <integer>
Value: 102

config object version

title
string <text>

config object title

siren:globalSearchGlobalTimeIgnoreTimezone
boolean or null <boolean>

If enabled, date queries in the global search don't use the local time zone to convert to UTC. Default: false

kibi:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

buildNum
number or null <integer>

Custom Setting Default: 12342

jira:csvExportSize
number or null <integer>

Max number of documents to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:showIntroVideos
boolean or null <boolean>

Enable introductory videos Default: false

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between documents that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to Infinity will disable. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to Infinity will disable. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to Infinity will disable. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to Infinity will disable. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile maps: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big documents. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our document when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight-type
string or null <keyword>
Enum: "unified" "plain"

Sets the default highlighter type for highlighted query matches. The two types of highlighter are 'unified' and 'plain'. For more information, see the Siren Investigate documentation. Default: unified

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns documents based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of records allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of documents sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
{
  • "version": 102,
  • "title": "string",
  • "siren:globalSearchGlobalTimeIgnoreTimezone": true,
  • "kibi:timeline:highlight:number_of_fragments": 0,
  • "siren:timeline:highlight:number_of_fragments": 0,
  • "buildNum": 0,
  • "jira:csvExportSize": 0,
  • "jira:fields": "string",
  • "timelion:min_interval": "string",
  • "timelion:default_rows": 0,
  • "timelion:default_columns": 0,
  • "timelion:max_buckets": 0,
  • "timelion:target_buckets": 0,
  • "timelion:es.default_index": "string",
  • "timelion:es.timefield": "string",
  • "timelion:showTutorial": true,
  • "siren:scoringSearchType": "query_then_fetch",
  • "siren:globalSearchDebugging": true,
  • "siren:elasticsearch:searchErrorTrace": true,
  • "siren:showIntroVideos": true,
  • "siren:defaultGraphVisualizerId": "string",
  • "siren:bufferAreaDefaultUnit": "Kilometers",
  • "siren:countFetchingStrategyRelationalFilters": "string",
  • "siren:countFetchingStrategyDashboards": "string",
  • "siren:graphStatesLimit": 0,
  • "siren:excludedIndices": "string",
  • "siren:defaultDashboardId": "string",
  • "siren:enableAllRelBtnCounts": true,
  • "siren:vertical_grid_resolution": 0,
  • "siren:panel_vertical_size": 0,
  • "siren:joinTaskTimeout": 0,
  • "siren:timePrecision": "y",
  • "siren:support-large-numbers": true,
  • "siren:dashboards360:showDashboardDataModelPopup": true,
  • "context:tieBreakerFields": [
    ],
  • "context:step": 0,
  • "context:defaultSize": 0,
  • "indexPattern:placeholder": "string",
  • "state:storeInSessionStorage": true,
  • "metrics:max_buckets": 0,
  • "notifications:lifetime:info": 0,
  • "notifications:lifetime:warning": 0,
  • "notifications:lifetime:error": 0,
  • "notifications:lifetime:banner": 0,
  • "notifications:banner": "string",
  • "filterEditor:suggestValues": true,
  • "filters:pinnedByDefault": true,
  • "dashboard:defaultDarkTheme": true,
  • "timepicker:autoRefreshAllDashboardCount": true,
  • "timepicker:refreshIntervalDefaults": "string",
  • "timepicker:timeDefaults": "string",
  • "savedObjects:listingLimit": 0,
  • "savedObjects:perPage": 0,
  • "format:currency:defaultPattern": "string",
  • "format:percent:defaultPattern": "string",
  • "format:bytes:defaultPattern": "string",
  • "format:number:defaultPattern": "string",
  • "format:defaultTypeMap": "string",
  • "truncate:maxHeight": 0,
  • "shortDots:enable": true,
  • "history:limit": 0,
  • "csv:quoteValues": true,
  • "csv:separator": "string",
  • "visualization:dimmingOpacity": 0.1,
  • "visualization:loadingDelay": "string",
  • "visualization:colorMapping": "string",
  • "visualization:regionmap:showWarnings": true,
  • "visualization:tileMap:WMSdefaults": "string",
  • "visualization:tileMap:maxPrecision": 0,
  • "histogram:maxBars": 0,
  • "histogram:barTarget": 0,
  • "fields:popularLimit": 0,
  • "courier:sequentialSearches": true,
  • "courier:batchSearches": true,
  • "courier:ignoreFilterIfFieldNotInIndex": true,
  • "courier:maxSegmentCount": 0,
  • "doc_table:highlight": true,
  • "discover:aggs:terms:size": 0,
  • "discover:sampleSize": 0,
  • "metaFields": [
    ],
  • "defaultColumns": [
    ],
  • "dateFormat:dow": "Monday",
  • "dateFormat:scaled": "string",
  • "dateFormat:tz": "string",
  • "dateFormat": "string",
  • "sort:options": "string",
  • "query:queryString:options": "string",
  • "default:highlight-type": "unified",
  • "inputControlVis:timeout": 0,
  • "siren:globalSearchSimpleQuerySyntaxOptions": "string",
  • "siren:globalSearchQuerySyntax": "query_string",
  • "siren:globalSearchTimeout": 0,
  • "sentinl:experimental": true,
  • "siren:scripting:notify": true,
  • "siren:scripting:enabled": true,
  • "data-model:max_documents_for_reindex_operations": 0,
  • "ingest-xlsx:progress_updation_frequency": 0,
  • "ingest-xlsx:simultaneous_bulk_requests": 0,
  • "ingest-xlsx:displayed_rows": 0,
  • "ingest-xlsx:bulk_package_size": 0,
  • "graph-browser:shortestPathLogLevel": "Debug",
  • "property1": null,
  • "property2": null
}

ObjectPayload_SavedConfigAttributesV102_

required
object (SavedConfigAttributesV102)
version
required
number <integer>
Value: 102

config object version

title
string <text>

config object title

siren:globalSearchGlobalTimeIgnoreTimezone
boolean or null <boolean>

If enabled, date queries in the global search don't use the local time zone to convert to UTC. Default: false

kibi:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

buildNum
number or null <integer>

Custom Setting Default: 12342

jira:csvExportSize
number or null <integer>

Max number of documents to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:showIntroVideos
boolean or null <boolean>

Enable introductory videos Default: false

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between documents that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to Infinity will disable. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to Infinity will disable. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to Infinity will disable. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to Infinity will disable. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile maps: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big documents. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our document when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight-type
string or null <keyword>
Enum: "unified" "plain"

Sets the default highlighter type for highlighted query matches. The two types of highlighter are 'unified' and 'plain'. For more information, see the Siren Investigate documentation. Default: unified

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns documents based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of records allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of documents sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedConfigFavoriteIconV103

iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
{
  • "iconClass": "string",
  • "iconColor": "string",
  • "customName": "string"
}

SavedConfigAttributesV103

version
required
number <integer>
Value: 103

config object version

title
string <text>

config object title

siren:favoriteColors
Array of strings or null <keyword> (keyword) [ items <keyword > ]

List of favorite colors that will be visible by default in the color picker Default: ['#0A0E2B', '#09095C', '#003997', '#861AFF', '#0ABCF2', '#27E7D7', '#FFE232', '#FFFFFF', '#AA6556', '#E7664C']

Array of objects or null (SavedConfigFavoriteIconV103)

The list of favorite icons that are quickly accessible in the icon picker. Default: []

Array
iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
siren:entityResolutionTypes
Array of strings or null <keyword> (keyword) [ items <keyword > ]

Entity resolution types which can be applied to a saved relation Default: ['Company', 'Person']

siren:globalSearchGlobalTimeIgnoreTimezone
boolean or null <boolean>

If enabled, date queries in the global search don't use the local time zone to convert to UTC. Default: false

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

jira:csvExportSize
number or null <integer>

Max number of records to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:graph.defaultEnhancedMap
string or null <string>

Object Definition Id The default enhanced map visualizer Default: null

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between records that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map. The default map will be covered when a Vector Basemap Layers is set up. Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile map aggregation layers: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big records. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our record when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight-type
string or null <keyword>
Enum: "unified" "plain"

Sets the default highlighter type for highlighted query matches. The two types of highlighter are 'unified' and 'plain'. For more information, see the Siren Investigate documentation. Default: unified

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns records based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of records allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of records sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
{
  • "version": 103,
  • "title": "string",
  • "siren:favoriteColors": [
    ],
  • "siren:favoriteIcons": [
    ],
  • "siren:entityResolutionTypes": [
    ],
  • "siren:globalSearchGlobalTimeIgnoreTimezone": true,
  • "siren:timeline:highlight:number_of_fragments": 0,
  • "jira:csvExportSize": 0,
  • "jira:fields": "string",
  • "timelion:min_interval": "string",
  • "timelion:default_rows": 0,
  • "timelion:default_columns": 0,
  • "timelion:max_buckets": 0,
  • "timelion:target_buckets": 0,
  • "timelion:es.default_index": "string",
  • "timelion:es.timefield": "string",
  • "timelion:showTutorial": true,
  • "siren:scoringSearchType": "query_then_fetch",
  • "siren:globalSearchDebugging": true,
  • "siren:elasticsearch:searchErrorTrace": true,
  • "siren:graph.defaultEnhancedMap": "string",
  • "siren:defaultGraphVisualizerId": "string",
  • "siren:bufferAreaDefaultUnit": "Kilometers",
  • "siren:countFetchingStrategyRelationalFilters": "string",
  • "siren:countFetchingStrategyDashboards": "string",
  • "siren:graphStatesLimit": 0,
  • "siren:excludedIndices": "string",
  • "siren:defaultDashboardId": "string",
  • "siren:enableAllRelBtnCounts": true,
  • "siren:vertical_grid_resolution": 0,
  • "siren:panel_vertical_size": 0,
  • "siren:joinTaskTimeout": 0,
  • "siren:timePrecision": "y",
  • "siren:support-large-numbers": true,
  • "siren:dashboards360:showDashboardDataModelPopup": true,
  • "context:tieBreakerFields": [
    ],
  • "context:step": 0,
  • "context:defaultSize": 0,
  • "indexPattern:placeholder": "string",
  • "state:storeInSessionStorage": true,
  • "metrics:max_buckets": 0,
  • "notifications:lifetime:info": 0,
  • "notifications:lifetime:warning": 0,
  • "notifications:lifetime:error": 0,
  • "notifications:lifetime:banner": 0,
  • "notifications:banner": "string",
  • "filterEditor:suggestValues": true,
  • "filters:pinnedByDefault": true,
  • "dashboard:defaultDarkTheme": true,
  • "timepicker:autoRefreshAllDashboardCount": true,
  • "timepicker:refreshIntervalDefaults": "string",
  • "timepicker:timeDefaults": "string",
  • "savedObjects:listingLimit": 0,
  • "savedObjects:perPage": 0,
  • "format:currency:defaultPattern": "string",
  • "format:percent:defaultPattern": "string",
  • "format:bytes:defaultPattern": "string",
  • "format:number:defaultPattern": "string",
  • "format:defaultTypeMap": "string",
  • "truncate:maxHeight": 0,
  • "shortDots:enable": true,
  • "history:limit": 0,
  • "csv:quoteValues": true,
  • "csv:separator": "string",
  • "visualization:dimmingOpacity": 0.1,
  • "visualization:loadingDelay": "string",
  • "visualization:colorMapping": "string",
  • "visualization:regionmap:showWarnings": true,
  • "visualization:tileMap:WMSdefaults": "string",
  • "visualization:tileMap:maxPrecision": 0,
  • "histogram:maxBars": 0,
  • "histogram:barTarget": 0,
  • "fields:popularLimit": 0,
  • "courier:sequentialSearches": true,
  • "courier:batchSearches": true,
  • "courier:ignoreFilterIfFieldNotInIndex": true,
  • "courier:maxSegmentCount": 0,
  • "doc_table:highlight": true,
  • "discover:aggs:terms:size": 0,
  • "discover:sampleSize": 0,
  • "metaFields": [
    ],
  • "defaultColumns": [
    ],
  • "dateFormat:dow": "Monday",
  • "dateFormat:scaled": "string",
  • "dateFormat:tz": "string",
  • "dateFormat": "string",
  • "sort:options": "string",
  • "query:queryString:options": "string",
  • "default:highlight-type": "unified",
  • "inputControlVis:timeout": 0,
  • "siren:globalSearchSimpleQuerySyntaxOptions": "string",
  • "siren:globalSearchQuerySyntax": "query_string",
  • "siren:globalSearchTimeout": 0,
  • "sentinl:experimental": true,
  • "siren:scripting:notify": true,
  • "siren:scripting:enabled": true,
  • "data-model:max_documents_for_reindex_operations": 0,
  • "ingest-xlsx:progress_updation_frequency": 0,
  • "ingest-xlsx:simultaneous_bulk_requests": 0,
  • "ingest-xlsx:displayed_rows": 0,
  • "ingest-xlsx:bulk_package_size": 0,
  • "graph-browser:shortestPathLogLevel": "Debug",
  • "property1": null,
  • "property2": null
}

ObjectPayload_SavedConfigAttributesV103_

required
object (SavedConfigAttributesV103)
version
required
number <integer>
Value: 103

config object version

title
string <text>

config object title

siren:favoriteColors
Array of strings or null <keyword> (keyword) [ items <keyword > ]

List of favorite colors that will be visible by default in the color picker Default: ['#0A0E2B', '#09095C', '#003997', '#861AFF', '#0ABCF2', '#27E7D7', '#FFE232', '#FFFFFF', '#AA6556', '#E7664C']

Array of objects or null (SavedConfigFavoriteIconV103)

The list of favorite icons that are quickly accessible in the icon picker. Default: []

Array
iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
siren:entityResolutionTypes
Array of strings or null <keyword> (keyword) [ items <keyword > ]

Entity resolution types which can be applied to a saved relation Default: ['Company', 'Person']

siren:globalSearchGlobalTimeIgnoreTimezone
boolean or null <boolean>

If enabled, date queries in the global search don't use the local time zone to convert to UTC. Default: false

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

jira:csvExportSize
number or null <integer>

Max number of records to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:graph.defaultEnhancedMap
string or null <string>

Object Definition Id The default enhanced map visualizer Default: null

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between records that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map. The default map will be covered when a Vector Basemap Layers is set up. Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile map aggregation layers: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big records. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our record when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight-type
string or null <keyword>
Enum: "unified" "plain"

Sets the default highlighter type for highlighted query matches. The two types of highlighter are 'unified' and 'plain'. For more information, see the Siren Investigate documentation. Default: unified

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns records based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of records allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of records sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedConfigFavoriteIconV104

iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
{
  • "iconClass": "string",
  • "iconColor": "string",
  • "customName": "string"
}

SavedConfigAttributesV104

version
required
number <integer>
Value: 104

config object version

title
string <text>

config object title

siren:favoriteColors
Array of strings or null <keyword> (keyword) [ items <keyword > ]

List of favorite colors that will be visible by default in the color picker Default: ['#0A0E2B', '#09095C', '#003997', '#861AFF', '#0ABCF2', '#27E7D7', '#FFE232', '#FFFFFF', '#AA6556', '#E7664C']

Array of objects or null (SavedConfigFavoriteIconV104)

The list of favorite icons that are quickly accessible in the icon picker. Default: []

Array
iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
siren:entityResolutionTypes
Array of strings or null <keyword> (keyword) [ items <keyword > ]

Entity resolution types which can be applied to a saved relation Default: ['Company', 'Person']

siren:globalSearchGlobalTimeIgnoreTimezone
boolean or null <boolean>

If enabled, date queries in the global search don't use the local time zone to convert to UTC. Default: false

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

jira:csvExportSize
number or null <integer>

Max number of records to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:graph.defaultEnhancedMap
string or null <string>

Object Definition Id The default enhanced map visualizer Default: null

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between records that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:siren_map:region_layer:showWarnings
boolean or null <boolean>

Whether the region layer should show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:siren_map:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map. The default map will be covered when a Vector Basemap Layers is set up. Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:siren_map:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile map aggregation layers: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big records. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our record when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight-type
string or null <keyword>
Enum: "unified" "plain"

Sets the default highlighter type for highlighted query matches. The two types of highlighter are 'unified' and 'plain'. For more information, see the Siren Investigate documentation. Default: unified

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns records based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of records allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of records sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
{
  • "version": 104,
  • "title": "string",
  • "siren:favoriteColors": [
    ],
  • "siren:favoriteIcons": [
    ],
  • "siren:entityResolutionTypes": [
    ],
  • "siren:globalSearchGlobalTimeIgnoreTimezone": true,
  • "siren:timeline:highlight:number_of_fragments": 0,
  • "jira:csvExportSize": 0,
  • "jira:fields": "string",
  • "timelion:min_interval": "string",
  • "timelion:default_rows": 0,
  • "timelion:default_columns": 0,
  • "timelion:max_buckets": 0,
  • "timelion:target_buckets": 0,
  • "timelion:es.default_index": "string",
  • "timelion:es.timefield": "string",
  • "timelion:showTutorial": true,
  • "siren:scoringSearchType": "query_then_fetch",
  • "siren:globalSearchDebugging": true,
  • "siren:elasticsearch:searchErrorTrace": true,
  • "siren:graph.defaultEnhancedMap": "string",
  • "siren:defaultGraphVisualizerId": "string",
  • "siren:bufferAreaDefaultUnit": "Kilometers",
  • "siren:countFetchingStrategyRelationalFilters": "string",
  • "siren:countFetchingStrategyDashboards": "string",
  • "siren:graphStatesLimit": 0,
  • "siren:excludedIndices": "string",
  • "siren:defaultDashboardId": "string",
  • "siren:enableAllRelBtnCounts": true,
  • "siren:vertical_grid_resolution": 0,
  • "siren:panel_vertical_size": 0,
  • "siren:joinTaskTimeout": 0,
  • "siren:timePrecision": "y",
  • "siren:support-large-numbers": true,
  • "siren:dashboards360:showDashboardDataModelPopup": true,
  • "context:tieBreakerFields": [
    ],
  • "context:step": 0,
  • "context:defaultSize": 0,
  • "indexPattern:placeholder": "string",
  • "state:storeInSessionStorage": true,
  • "metrics:max_buckets": 0,
  • "notifications:lifetime:info": 0,
  • "notifications:lifetime:warning": 0,
  • "notifications:lifetime:error": 0,
  • "notifications:lifetime:banner": 0,
  • "notifications:banner": "string",
  • "filterEditor:suggestValues": true,
  • "filters:pinnedByDefault": true,
  • "dashboard:defaultDarkTheme": true,
  • "timepicker:autoRefreshAllDashboardCount": true,
  • "timepicker:refreshIntervalDefaults": "string",
  • "timepicker:timeDefaults": "string",
  • "savedObjects:listingLimit": 0,
  • "savedObjects:perPage": 0,
  • "format:currency:defaultPattern": "string",
  • "format:percent:defaultPattern": "string",
  • "format:bytes:defaultPattern": "string",
  • "format:number:defaultPattern": "string",
  • "format:defaultTypeMap": "string",
  • "truncate:maxHeight": 0,
  • "shortDots:enable": true,
  • "history:limit": 0,
  • "csv:quoteValues": true,
  • "csv:separator": "string",
  • "visualization:dimmingOpacity": 0.1,
  • "visualization:loadingDelay": "string",
  • "visualization:colorMapping": "string",
  • "visualization:siren_map:region_layer:showWarnings": true,
  • "visualization:siren_map:WMSdefaults": "string",
  • "visualization:siren_map:maxPrecision": 0,
  • "histogram:maxBars": 0,
  • "histogram:barTarget": 0,
  • "fields:popularLimit": 0,
  • "courier:sequentialSearches": true,
  • "courier:batchSearches": true,
  • "courier:ignoreFilterIfFieldNotInIndex": true,
  • "courier:maxSegmentCount": 0,
  • "doc_table:highlight": true,
  • "discover:aggs:terms:size": 0,
  • "discover:sampleSize": 0,
  • "metaFields": [
    ],
  • "defaultColumns": [
    ],
  • "dateFormat:dow": "Monday",
  • "dateFormat:scaled": "string",
  • "dateFormat:tz": "string",
  • "dateFormat": "string",
  • "sort:options": "string",
  • "query:queryString:options": "string",
  • "default:highlight-type": "unified",
  • "inputControlVis:timeout": 0,
  • "siren:globalSearchSimpleQuerySyntaxOptions": "string",
  • "siren:globalSearchQuerySyntax": "query_string",
  • "siren:globalSearchTimeout": 0,
  • "sentinl:experimental": true,
  • "siren:scripting:notify": true,
  • "siren:scripting:enabled": true,
  • "data-model:max_documents_for_reindex_operations": 0,
  • "ingest-xlsx:progress_updation_frequency": 0,
  • "ingest-xlsx:simultaneous_bulk_requests": 0,
  • "ingest-xlsx:displayed_rows": 0,
  • "ingest-xlsx:bulk_package_size": 0,
  • "graph-browser:shortestPathLogLevel": "Debug",
  • "property1": null,
  • "property2": null
}

ObjectPayload_SavedConfigAttributesV104_

required
object (SavedConfigAttributesV104)
version
required
number <integer>
Value: 104

config object version

title
string <text>

config object title

siren:favoriteColors
Array of strings or null <keyword> (keyword) [ items <keyword > ]

List of favorite colors that will be visible by default in the color picker Default: ['#0A0E2B', '#09095C', '#003997', '#861AFF', '#0ABCF2', '#27E7D7', '#FFE232', '#FFFFFF', '#AA6556', '#E7664C']

Array of objects or null (SavedConfigFavoriteIconV104)

The list of favorite icons that are quickly accessible in the icon picker. Default: []

Array
iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
siren:entityResolutionTypes
Array of strings or null <keyword> (keyword) [ items <keyword > ]

Entity resolution types which can be applied to a saved relation Default: ['Company', 'Person']

siren:globalSearchGlobalTimeIgnoreTimezone
boolean or null <boolean>

If enabled, date queries in the global search don't use the local time zone to convert to UTC. Default: false

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

jira:csvExportSize
number or null <integer>

Max number of records to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:graph.defaultEnhancedMap
string or null <string>

Object Definition Id The default enhanced map visualizer Default: null

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between records that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:siren_map:region_layer:showWarnings
boolean or null <boolean>

Whether the region layer should show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:siren_map:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map. The default map will be covered when a Vector Basemap Layers is set up. Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:siren_map:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile map aggregation layers: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big records. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our record when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight-type
string or null <keyword>
Enum: "unified" "plain"

Sets the default highlighter type for highlighted query matches. The two types of highlighter are 'unified' and 'plain'. For more information, see the Siren Investigate documentation. Default: unified

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns records based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of records allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of records sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedConfigFavoriteIconV105

iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
{
  • "iconClass": "string",
  • "iconColor": "string",
  • "customName": "string"
}

SavedConfigAttributesV105

version
required
number <integer>
Value: 105

config object version

title
string <text>

config object title

visualization:siren_map:region_layer:layersConfig
string or null <string>

Stringified JSON object Specifies additional vector layers for use in Siren Map visualizations. Default: {'fetchSirenTiles':true,'layers':[]}

siren:favoriteColors
Array of strings or null <keyword> (keyword) [ items <keyword > ]

List of favorite colors that will be visible by default in the color picker Default: ['#0A0E2B', '#09095C', '#003997', '#861AFF', '#0ABCF2', '#27E7D7', '#FFE232', '#FFFFFF', '#AA6556', '#E7664C']

Array of objects or null (SavedConfigFavoriteIconV105)

The list of favorite icons that are quickly accessible in the icon picker. Default: []

Array
iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
siren:entityResolutionTypes
Array of strings or null <keyword> (keyword) [ items <keyword > ]

Entity resolution types which can be applied to a saved relation Default: ['Company', 'Person']

siren:globalSearchGlobalTimeIgnoreTimezone
boolean or null <boolean>

If enabled, date queries in the global search don't use the local time zone to convert to UTC. Default: false

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

jira:csvExportSize
number or null <integer>

Max number of records to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:graph.defaultEnhancedMap
string or null <string>

Object Definition Id The default enhanced map visualizer Default: null

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between records that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map. The default map will be covered when a Vector Basemap Layers is set up. Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile map aggregation layers: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big records. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our record when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight-type
string or null <keyword>
Enum: "unified" "plain"

Sets the default highlighter type for highlighted query matches. The two types of highlighter are 'unified' and 'plain'. For more information, see the Siren Investigate documentation. Default: unified

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns records based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of records allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of records sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
{
  • "version": 105,
  • "title": "string",
  • "visualization:siren_map:region_layer:layersConfig": "string",
  • "siren:favoriteColors": [
    ],
  • "siren:favoriteIcons": [
    ],
  • "siren:entityResolutionTypes": [
    ],
  • "siren:globalSearchGlobalTimeIgnoreTimezone": true,
  • "siren:timeline:highlight:number_of_fragments": 0,
  • "jira:csvExportSize": 0,
  • "jira:fields": "string",
  • "timelion:min_interval": "string",
  • "timelion:default_rows": 0,
  • "timelion:default_columns": 0,
  • "timelion:max_buckets": 0,
  • "timelion:target_buckets": 0,
  • "timelion:es.default_index": "string",
  • "timelion:es.timefield": "string",
  • "timelion:showTutorial": true,
  • "siren:scoringSearchType": "query_then_fetch",
  • "siren:globalSearchDebugging": true,
  • "siren:elasticsearch:searchErrorTrace": true,
  • "siren:graph.defaultEnhancedMap": "string",
  • "siren:defaultGraphVisualizerId": "string",
  • "siren:bufferAreaDefaultUnit": "Kilometers",
  • "siren:countFetchingStrategyRelationalFilters": "string",
  • "siren:countFetchingStrategyDashboards": "string",
  • "siren:graphStatesLimit": 0,
  • "siren:excludedIndices": "string",
  • "siren:defaultDashboardId": "string",
  • "siren:enableAllRelBtnCounts": true,
  • "siren:vertical_grid_resolution": 0,
  • "siren:panel_vertical_size": 0,
  • "siren:joinTaskTimeout": 0,
  • "siren:timePrecision": "y",
  • "siren:support-large-numbers": true,
  • "siren:dashboards360:showDashboardDataModelPopup": true,
  • "context:tieBreakerFields": [
    ],
  • "context:step": 0,
  • "context:defaultSize": 0,
  • "indexPattern:placeholder": "string",
  • "state:storeInSessionStorage": true,
  • "metrics:max_buckets": 0,
  • "notifications:lifetime:info": 0,
  • "notifications:lifetime:warning": 0,
  • "notifications:lifetime:error": 0,
  • "notifications:lifetime:banner": 0,
  • "notifications:banner": "string",
  • "filterEditor:suggestValues": true,
  • "filters:pinnedByDefault": true,
  • "dashboard:defaultDarkTheme": true,
  • "timepicker:autoRefreshAllDashboardCount": true,
  • "timepicker:refreshIntervalDefaults": "string",
  • "timepicker:timeDefaults": "string",
  • "savedObjects:listingLimit": 0,
  • "savedObjects:perPage": 0,
  • "format:currency:defaultPattern": "string",
  • "format:percent:defaultPattern": "string",
  • "format:bytes:defaultPattern": "string",
  • "format:number:defaultPattern": "string",
  • "format:defaultTypeMap": "string",
  • "truncate:maxHeight": 0,
  • "shortDots:enable": true,
  • "history:limit": 0,
  • "csv:quoteValues": true,
  • "csv:separator": "string",
  • "visualization:dimmingOpacity": 0.1,
  • "visualization:loadingDelay": "string",
  • "visualization:colorMapping": "string",
  • "visualization:regionmap:showWarnings": true,
  • "visualization:tileMap:WMSdefaults": "string",
  • "visualization:tileMap:maxPrecision": 0,
  • "histogram:maxBars": 0,
  • "histogram:barTarget": 0,
  • "fields:popularLimit": 0,
  • "courier:sequentialSearches": true,
  • "courier:batchSearches": true,
  • "courier:ignoreFilterIfFieldNotInIndex": true,
  • "courier:maxSegmentCount": 0,
  • "doc_table:highlight": true,
  • "discover:aggs:terms:size": 0,
  • "discover:sampleSize": 0,
  • "metaFields": [
    ],
  • "defaultColumns": [
    ],
  • "dateFormat:dow": "Monday",
  • "dateFormat:scaled": "string",
  • "dateFormat:tz": "string",
  • "dateFormat": "string",
  • "sort:options": "string",
  • "query:queryString:options": "string",
  • "default:highlight-type": "unified",
  • "inputControlVis:timeout": 0,
  • "siren:globalSearchSimpleQuerySyntaxOptions": "string",
  • "siren:globalSearchQuerySyntax": "query_string",
  • "siren:globalSearchTimeout": 0,
  • "sentinl:experimental": true,
  • "siren:scripting:notify": true,
  • "siren:scripting:enabled": true,
  • "data-model:max_documents_for_reindex_operations": 0,
  • "ingest-xlsx:progress_updation_frequency": 0,
  • "ingest-xlsx:simultaneous_bulk_requests": 0,
  • "ingest-xlsx:displayed_rows": 0,
  • "ingest-xlsx:bulk_package_size": 0,
  • "graph-browser:shortestPathLogLevel": "Debug",
  • "property1": null,
  • "property2": null
}

ObjectPayload_SavedConfigAttributesV105_

required
object (SavedConfigAttributesV105)
version
required
number <integer>
Value: 105

config object version

title
string <text>

config object title

visualization:siren_map:region_layer:layersConfig
string or null <string>

Stringified JSON object Specifies additional vector layers for use in Siren Map visualizations. Default: {'fetchSirenTiles':true,'layers':[]}

siren:favoriteColors
Array of strings or null <keyword> (keyword) [ items <keyword > ]

List of favorite colors that will be visible by default in the color picker Default: ['#0A0E2B', '#09095C', '#003997', '#861AFF', '#0ABCF2', '#27E7D7', '#FFE232', '#FFFFFF', '#AA6556', '#E7664C']

Array of objects or null (SavedConfigFavoriteIconV105)

The list of favorite icons that are quickly accessible in the icon picker. Default: []

Array
iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
siren:entityResolutionTypes
Array of strings or null <keyword> (keyword) [ items <keyword > ]

Entity resolution types which can be applied to a saved relation Default: ['Company', 'Person']

siren:globalSearchGlobalTimeIgnoreTimezone
boolean or null <boolean>

If enabled, date queries in the global search don't use the local time zone to convert to UTC. Default: false

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

jira:csvExportSize
number or null <integer>

Max number of records to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:graph.defaultEnhancedMap
string or null <string>

Object Definition Id The default enhanced map visualizer Default: null

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between records that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map. The default map will be covered when a Vector Basemap Layers is set up. Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile map aggregation layers: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big records. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our record when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight-type
string or null <keyword>
Enum: "unified" "plain"

Sets the default highlighter type for highlighted query matches. The two types of highlighter are 'unified' and 'plain'. For more information, see the Siren Investigate documentation. Default: unified

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns records based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of records allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of records sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedConfigFavoriteIconV106

iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
{
  • "iconClass": "string",
  • "iconColor": "string",
  • "customName": "string"
}

SavedConfigAttributesV106

version
required
number <integer>
Value: 106

config object version

title
string <text>

config object title

visualization:siren_map:region_layer:layersConfig
string or null <string>

Stringified JSON object Specifies additional vector layers for use in Siren Map visualizations. Default: {'fetchSirenTiles':true,'layers':[]}

siren:favoriteColors
Array of strings or null <keyword> (keyword) [ items <keyword > ]

List of favorite colors that will be visible by default in the color picker Default: ['#0A0E2B', '#09095C', '#003997', '#861AFF', '#0ABCF2', '#27E7D7', '#FFE232', '#FFFFFF', '#AA6556', '#E7664C']

Array of objects or null (SavedConfigFavoriteIconV106)

The list of favorite icons that are quickly accessible in the icon picker. Default: []

Array
iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
siren:entityResolutionTypes
Array of strings or null <keyword> (keyword) [ items <keyword > ]

Entity resolution types which can be applied to a saved relation Default: ['Company', 'Person']

siren:globalSearchGlobalTimeIgnoreTimezone
boolean or null <boolean>

If enabled, date queries in the global search don't use the local time zone to convert to UTC. Default: false

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

jira:csvExportSize
number or null <integer>

Max number of records to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:graph.defaultEnhancedMap
string or null <string>

Object Definition Id The default enhanced map visualizer Default: null

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between records that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map. The default map will be covered when a Vector Basemap Layers is set up. Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile map aggregation layers: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big records. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our record when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight
string or null <string>

Sets the default highlight configuration as a JSON object.

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns records based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of records allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of records sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
{
  • "version": 106,
  • "title": "string",
  • "visualization:siren_map:region_layer:layersConfig": "string",
  • "siren:favoriteColors": [
    ],
  • "siren:favoriteIcons": [
    ],
  • "siren:entityResolutionTypes": [
    ],
  • "siren:globalSearchGlobalTimeIgnoreTimezone": true,
  • "siren:timeline:highlight:number_of_fragments": 0,
  • "jira:csvExportSize": 0,
  • "jira:fields": "string",
  • "timelion:min_interval": "string",
  • "timelion:default_rows": 0,
  • "timelion:default_columns": 0,
  • "timelion:max_buckets": 0,
  • "timelion:target_buckets": 0,
  • "timelion:es.default_index": "string",
  • "timelion:es.timefield": "string",
  • "timelion:showTutorial": true,
  • "siren:scoringSearchType": "query_then_fetch",
  • "siren:globalSearchDebugging": true,
  • "siren:elasticsearch:searchErrorTrace": true,
  • "siren:graph.defaultEnhancedMap": "string",
  • "siren:defaultGraphVisualizerId": "string",
  • "siren:bufferAreaDefaultUnit": "Kilometers",
  • "siren:countFetchingStrategyRelationalFilters": "string",
  • "siren:countFetchingStrategyDashboards": "string",
  • "siren:graphStatesLimit": 0,
  • "siren:excludedIndices": "string",
  • "siren:defaultDashboardId": "string",
  • "siren:enableAllRelBtnCounts": true,
  • "siren:vertical_grid_resolution": 0,
  • "siren:panel_vertical_size": 0,
  • "siren:joinTaskTimeout": 0,
  • "siren:timePrecision": "y",
  • "siren:support-large-numbers": true,
  • "siren:dashboards360:showDashboardDataModelPopup": true,
  • "context:tieBreakerFields": [
    ],
  • "context:step": 0,
  • "context:defaultSize": 0,
  • "indexPattern:placeholder": "string",
  • "state:storeInSessionStorage": true,
  • "metrics:max_buckets": 0,
  • "notifications:lifetime:info": 0,
  • "notifications:lifetime:warning": 0,
  • "notifications:lifetime:error": 0,
  • "notifications:lifetime:banner": 0,
  • "notifications:banner": "string",
  • "filterEditor:suggestValues": true,
  • "filters:pinnedByDefault": true,
  • "dashboard:defaultDarkTheme": true,
  • "timepicker:autoRefreshAllDashboardCount": true,
  • "timepicker:refreshIntervalDefaults": "string",
  • "timepicker:timeDefaults": "string",
  • "savedObjects:listingLimit": 0,
  • "savedObjects:perPage": 0,
  • "format:currency:defaultPattern": "string",
  • "format:percent:defaultPattern": "string",
  • "format:bytes:defaultPattern": "string",
  • "format:number:defaultPattern": "string",
  • "format:defaultTypeMap": "string",
  • "truncate:maxHeight": 0,
  • "shortDots:enable": true,
  • "history:limit": 0,
  • "csv:quoteValues": true,
  • "csv:separator": "string",
  • "visualization:dimmingOpacity": 0.1,
  • "visualization:loadingDelay": "string",
  • "visualization:colorMapping": "string",
  • "visualization:regionmap:showWarnings": true,
  • "visualization:tileMap:WMSdefaults": "string",
  • "visualization:tileMap:maxPrecision": 0,
  • "histogram:maxBars": 0,
  • "histogram:barTarget": 0,
  • "fields:popularLimit": 0,
  • "courier:sequentialSearches": true,
  • "courier:batchSearches": true,
  • "courier:ignoreFilterIfFieldNotInIndex": true,
  • "courier:maxSegmentCount": 0,
  • "doc_table:highlight": true,
  • "discover:aggs:terms:size": 0,
  • "discover:sampleSize": 0,
  • "metaFields": [
    ],
  • "defaultColumns": [
    ],
  • "dateFormat:dow": "Monday",
  • "dateFormat:scaled": "string",
  • "dateFormat:tz": "string",
  • "dateFormat": "string",
  • "sort:options": "string",
  • "query:queryString:options": "string",
  • "default:highlight": "string",
  • "inputControlVis:timeout": 0,
  • "siren:globalSearchSimpleQuerySyntaxOptions": "string",
  • "siren:globalSearchQuerySyntax": "query_string",
  • "siren:globalSearchTimeout": 0,
  • "sentinl:experimental": true,
  • "siren:scripting:notify": true,
  • "siren:scripting:enabled": true,
  • "data-model:max_documents_for_reindex_operations": 0,
  • "ingest-xlsx:progress_updation_frequency": 0,
  • "ingest-xlsx:simultaneous_bulk_requests": 0,
  • "ingest-xlsx:displayed_rows": 0,
  • "ingest-xlsx:bulk_package_size": 0,
  • "graph-browser:shortestPathLogLevel": "Debug",
  • "property1": null,
  • "property2": null
}

ObjectPayload_SavedConfigAttributesV106_

required
object (SavedConfigAttributesV106)
version
required
number <integer>
Value: 106

config object version

title
string <text>

config object title

visualization:siren_map:region_layer:layersConfig
string or null <string>

Stringified JSON object Specifies additional vector layers for use in Siren Map visualizations. Default: {'fetchSirenTiles':true,'layers':[]}

siren:favoriteColors
Array of strings or null <keyword> (keyword) [ items <keyword > ]

List of favorite colors that will be visible by default in the color picker Default: ['#0A0E2B', '#09095C', '#003997', '#861AFF', '#0ABCF2', '#27E7D7', '#FFE232', '#FFFFFF', '#AA6556', '#E7664C']

Array of objects or null (SavedConfigFavoriteIconV106)

The list of favorite icons that are quickly accessible in the icon picker. Default: []

Array
iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
siren:entityResolutionTypes
Array of strings or null <keyword> (keyword) [ items <keyword > ]

Entity resolution types which can be applied to a saved relation Default: ['Company', 'Person']

siren:globalSearchGlobalTimeIgnoreTimezone
boolean or null <boolean>

If enabled, date queries in the global search don't use the local time zone to convert to UTC. Default: false

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

jira:csvExportSize
number or null <integer>

Max number of records to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:graph.defaultEnhancedMap
string or null <string>

Object Definition Id The default enhanced map visualizer Default: null

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between records that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map. The default map will be covered when a Vector Basemap Layers is set up. Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile map aggregation layers: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big records. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our record when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight
string or null <string>

Sets the default highlight configuration as a JSON object.

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns records based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of records allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of records sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedDashboardAttributesV100

version
required
number <integer>
Value: 100

Dashboard object version

uiStateJSON
string <string>

UI State used by Dashboard

title
required
string <string>

Title of Dashboard

object
section
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

value
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

pause
boolean
display
string
timeFrom
string <string>

Time period e.g start period

timeTo
string <string>

Time period e.g end period

timeMode
string <string>

Time mode for the Dashboard e.g absolute, relative

timeRestore
required
boolean <boolean>

If time is stored on the dashboard

scriptIds
required
Array of strings

Ids of sripts on a Dashboard

flexLayoutJSON
string <string>

Structure describing flex layout

panelsJSON
string <string>

Dashboard panels

optionsJSON
string <string>

Dashboard options

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
required
string <string>

Description of a Dashboard

coatJSON
string <string>

A tree structure describing a datamodel

{
  • "version": 100,
  • "uiStateJSON": "string",
  • "title": "string",
  • "refreshInterval": {
    },
  • "timeFrom": "string",
  • "timeTo": "string",
  • "timeMode": "string",
  • "timeRestore": true,
  • "scriptIds": [
    ],
  • "flexLayoutJSON": "string",
  • "panelsJSON": "string",
  • "optionsJSON": "string",
  • "kibanaSavedObjectMeta": {
    },
  • "hits": 0,
  • "description": "string",
  • "coatJSON": "string"
}

ObjectPayload_SavedDashboardAttributesV100_

required
object (SavedDashboardAttributesV100)
version
required
number <integer>
Value: 100

Dashboard object version

uiStateJSON
string <string>

UI State used by Dashboard

title
required
string <string>

Title of Dashboard

object
section
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

value
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

pause
boolean
display
string
timeFrom
string <string>

Time period e.g start period

timeTo
string <string>

Time period e.g end period

timeMode
string <string>

Time mode for the Dashboard e.g absolute, relative

timeRestore
required
boolean <boolean>

If time is stored on the dashboard

scriptIds
required
Array of strings

Ids of sripts on a Dashboard

flexLayoutJSON
string <string>

Structure describing flex layout

panelsJSON
string <string>

Dashboard panels

optionsJSON
string <string>

Dashboard options

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
required
string <string>

Description of a Dashboard

coatJSON
string <string>

A tree structure describing a datamodel

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedDashboardAttributesV101

version
required
number <integer>
Value: 101

Dashboard object version

uiStateJSON
string <string>

UI State used by Dashboard

title
required
string <string>

Title of Dashboard

object
section
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

value
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

pause
boolean
display
string
timeFrom
string <string>

Time period e.g start period

timeTo
string <string>

Time period e.g end period

timeMode
string <string>

Time mode for the Dashboard e.g absolute, relative

timeRestore
required
boolean <boolean>

If time is stored on the dashboard

scriptIds
required
Array of strings

Ids of sripts on a Dashboard

flexLayoutJSON
string <string>

Structure describing flex layout

panelsJSON
string <string>

Dashboard panels

optionsJSON
string <string>

Dashboard options

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
required
string <string>

Description of a Dashboard

coatJSON
string <string>

A tree structure describing a datamodel

{
  • "version": 101,
  • "uiStateJSON": "string",
  • "title": "string",
  • "refreshInterval": {
    },
  • "timeFrom": "string",
  • "timeTo": "string",
  • "timeMode": "string",
  • "timeRestore": true,
  • "scriptIds": [
    ],
  • "flexLayoutJSON": "string",
  • "panelsJSON": "string",
  • "optionsJSON": "string",
  • "kibanaSavedObjectMeta": {
    },
  • "hits": 0,
  • "description": "string",
  • "coatJSON": "string"
}

ObjectPayload_SavedDashboardAttributesV101_

required
object (SavedDashboardAttributesV101)
version
required
number <integer>
Value: 101

Dashboard object version

uiStateJSON
string <string>

UI State used by Dashboard

title
required
string <string>

Title of Dashboard

object
section
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

value
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

pause
boolean
display
string
timeFrom
string <string>

Time period e.g start period

timeTo
string <string>

Time period e.g end period

timeMode
string <string>

Time mode for the Dashboard e.g absolute, relative

timeRestore
required
boolean <boolean>

If time is stored on the dashboard

scriptIds
required
Array of strings

Ids of sripts on a Dashboard

flexLayoutJSON
string <string>

Structure describing flex layout

panelsJSON
string <string>

Dashboard panels

optionsJSON
string <string>

Dashboard options

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
required
string <string>

Description of a Dashboard

coatJSON
string <string>

A tree structure describing a datamodel

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

DataImportSearchConfigV100

indexPattern
required
string
color
required
string
icon
required
string
title
required
string
id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "indexPattern": "string",
  • "color": "string",
  • "icon": "string",
  • "title": "string",
  • "id": "string"
}

DataImportDataspaceConfigV100

title
required
string
shortCode
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "title": "string",
  • "shortCode": "string"
}

DataImportReadonlyConfigV100

required
object (DataImportDataspaceConfigV100)
title
required
string
shortCode
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object (DataImportSearchConfigV100)
indexPattern
required
string
color
required
string
icon
required
string
title
required
string
id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

recordsCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

projectId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "dataspace": {
    },
  • "search": {
    },
  • "recordsCount": 0,
  • "projectId": "string"
}

SavedDataImportAttributesV100

version
required
number <integer>
Value: 100

Import object version

required
object (DataImportReadonlyConfigV100)
required
object (DataImportDataspaceConfigV100)
title
required
string
shortCode
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object (DataImportSearchConfigV100)
indexPattern
required
string
color
required
string
icon
required
string
title
required
string
id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

recordsCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

projectId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

title
required
string <string>

Title for import

{
  • "version": 100,
  • "readonly": {
    },
  • "title": "string"
}

ObjectPayload_SavedDataImportAttributesV100_

required
object (SavedDataImportAttributesV100)
version
required
number <integer>
Value: 100

Import object version

required
object (DataImportReadonlyConfigV100)
required
object (DataImportDataspaceConfigV100)
title
required
string
shortCode
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object (DataImportSearchConfigV100)
indexPattern
required
string
color
required
string
icon
required
string
title
required
string
id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

recordsCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

projectId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

title
required
string <string>

Title for import

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedDataProjectAttributesV100

version
required
number <integer>
Value: 100

Project object version

title
required
string <string>

Title for project

{
  • "version": 100,
  • "title": "string"
}

ObjectPayload_SavedDataProjectAttributesV100_

required
object (SavedDataProjectAttributesV100)
version
required
number <integer>
Value: 100

Project object version

title
required
string <string>

Title for project

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

DynamicFilterAttributesV100

version
required
number <integer>
Value: 100

DynamicFilter object version

required
object
useRange
required
boolean <boolean>

Whether to display a range or single input box. Search a value within a range instead of exact value

showExactMatchOption
required
boolean <boolean>

Whether to show the option that allows a user to indicate that matching should be strict or fuzzy/tokenized

options
required
string <string>

Additional options on dynamic filters, e.g filter by number ranges

histogram
required
boolean <boolean>

Whether to show the counts and bar charts for the categories

multiselect
required
boolean <boolean>

Whether the user should be able to select more than a single category (ORed together). If true, the categories become checkboxes instead of radio buttons

searchable
required
boolean <boolean>

Whether the categories can be filtered using a text field. This is useful if there are hundreds of categories available to choose from

sorting
required
string <string>
Enum: "fixed" "alphabetic" "hits"

How categories are sorted when the dynamic filter is rendered

visibleOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

type
required
string <keyword>
Enum: "manual" "automatic" "none"

How categories (i.e. options) shall be determined. These categories represent values for the mapped fields and are used to filter the data

type
required
string <keyword>
Enum: "text" "keyword" "number" "date" "age"

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

{
  • "version": 100,
  • "categories": {
    },
  • "type": "text",
  • "title": "string"
}

ObjectPayload_DynamicFilterAttributesV100_

required
object (DynamicFilterAttributesV100)
version
required
number <integer>
Value: 100

DynamicFilter object version

required
object
useRange
required
boolean <boolean>

Whether to display a range or single input box. Search a value within a range instead of exact value

showExactMatchOption
required
boolean <boolean>

Whether to show the option that allows a user to indicate that matching should be strict or fuzzy/tokenized

options
required
string <string>

Additional options on dynamic filters, e.g filter by number ranges

histogram
required
boolean <boolean>

Whether to show the counts and bar charts for the categories

multiselect
required
boolean <boolean>

Whether the user should be able to select more than a single category (ORed together). If true, the categories become checkboxes instead of radio buttons

searchable
required
boolean <boolean>

Whether the categories can be filtered using a text field. This is useful if there are hundreds of categories available to choose from

sorting
required
string <string>
Enum: "fixed" "alphabetic" "hits"

How categories are sorted when the dynamic filter is rendered

visibleOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

type
required
string <keyword>
Enum: "manual" "automatic" "none"

How categories (i.e. options) shall be determined. These categories represent values for the mapped fields and are used to filter the data

type
required
string <keyword>
Enum: "text" "keyword" "number" "date" "age"

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

ObjectPayload_DynamicFilterAttributesV101_

required
object (DynamicFilterAttributesV101)
version
required
number <integer>
Value: 101

DynamicFilter object version

required
object
inputMask
required
string <string>

Input mask value to apply to input

useRange
required
boolean <boolean>

Whether to display a range or single input box. Search a value within a range instead of exact value

showExactMatchOption
required
boolean <boolean>

Whether to show the option that allows a user to indicate that matching should be strict or fuzzy/tokenized

options
required
string <string>

Additional options on dynamic filters, e.g filter by number ranges

histogram
required
boolean <boolean>

Whether to show the counts and bar charts for the categories

multiselect
required
boolean <boolean>

Whether the user should be able to select more than a single category (ORed together). If true, the categories become checkboxes instead of radio buttons

searchable
required
boolean <boolean>

Whether the categories can be filtered using a text field. This is useful if there are hundreds of categories available to choose from

sorting
required
string <string>
Enum: "fixed" "alphabetic" "hits"

How categories are sorted when the dynamic filter is rendered

visibleOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

type
required
string <keyword>
Enum: "manual" "automatic" "none"

How categories (i.e. options) shall be determined. These categories represent values for the mapped fields and are used to filter the data

type
required
string <keyword>
Enum: "text" "keyword" "number" "date" "age"

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

ObjectPayload_DynamicFilterAttributesV102_

required
object (DynamicFilterAttributesV102)
version
required
number <integer>
Value: 102

DynamicFilter object version

required
object
ignoreTimezone
boolean <boolean>

Don't use local time zone to convert Date queries to UTC

includeTime
required
boolean <boolean>

Include/Exclude time

inputMask
required
string <string>

Input mask value to apply to input

useRange
required
boolean <boolean>

Whether to display a range or single input box. Search a value within a range instead of exact value

showExactMatchOption
required
boolean <boolean>

Whether to show the option that allows a user to indicate that matching should be strict or fuzzy/tokenized

options
required
string <string>

Additional options on dynamic filters, e.g filter by number ranges

histogram
required
boolean <boolean>

Whether to show the counts and bar charts for the categories

multiselect
required
boolean <boolean>

Whether the user should be able to select more than a single category (ORed together). If true, the categories become checkboxes instead of radio buttons

searchable
required
boolean <boolean>

Whether the categories can be filtered using a text field. This is useful if there are hundreds of categories available to choose from

sorting
required
string <string>
Enum: "fixed" "alphabetic" "hits"

How categories are sorted when the dynamic filter is rendered

visibleOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxOptions
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

type
required
string <keyword>
Enum: "manual" "automatic" "none"

How categories (i.e. options) shall be determined. These categories represent values for the mapped fields and are used to filter the data

required
string or string <keyword>

The type of field the dynamic filter will be mapped to

Any of
string <keyword>

The type of field the dynamic filter will be mapped to

title
required
string <string>

Title for Dynamic filter

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedEidAttributesV100

version
required
number <integer>
Value: 100

EID object version

required
object
required
object
shortDescription
required
string <string>

Short description

color
required
string <string>

EID icon color

icon
required
string <string>

EID icon to display

title
required
string <string>

Title for EID

{
  • "version": 100,
  • "siren": {
    },
  • "title": "string"
}

ObjectPayload_SavedEidAttributesV100_

required
object (SavedEidAttributesV100)
version
required
number <integer>
Value: 100

EID object version

required
object
required
object
shortDescription
required
string <string>

Short description

color
required
string <string>

EID icon color

icon
required
string <string>

EID icon to display

title
required
string <string>

Title for EID

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

ObjectDefinitionError

type
required
string <string>

Saved object type

reason
required
string <string>

Cause of error

status
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

found
required
boolean <boolean>

Found true/false

{
  • "type": "string",
  • "reason": "string",
  • "status": 0,
  • "found": true
}

IndexPatternAttributesV108

error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

{
  • "error": null,
  • "fieldFormatMap": "string",
  • "excludeIndices": true,
  • "sourceFilters": "string",
  • "fields": "string",
  • "intervalName": "string",
  • "timeFieldName": "string",
  • "pattern": "string"
}

IndexingScopeStringV108

string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
"G:S"

EditableFieldsModeV108

string (EditableFieldsModeV108)
Enum: "whitelist" "blacklist"
"whitelist"

RevisionSettingsV108

copyToFields
object
indexingScope
required
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV108)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "copyToFields": {
    },
  • "indexingScope": "G:S",
  • "editableFieldsExceptions": [
    ],
  • "editableFieldsMode": "whitelist",
  • "primaryKey": "string",
  • "isEditable": true,
  • "index": "string"
}

GlobalSearchSettingsV108

selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

Array
boost
required
number <double>
required
object
count
required
number <double>
unit
required
string
Enum: "y" "M" "w" "d" "h" "m" "s"
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

{
  • "selectedByDefault": true,
  • "forceSearchedOnTimeFilter": true,
  • "recencyBoost": [
    ],
  • "boost": 0.1,
  • "enabled": true
}

PerspectiveTypesV103

string (PerspectiveTypesV103)
Enum: "view" "binary"
"view"

PerspectiveInfoV103

type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "type": "view",
  • "perspective": "string",
  • "scriptId": "string"
}

DynamicFilterMappingV108

filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "filterId": "string",
  • "field": "string"
}

EntityResolutionV108

enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

{
  • "enabled": true
}

ImportSettingsV108

allowedFields
Array of strings <keyword> (keyword) [ items <keyword > ]

An optional list of fields that imported data can be mapped to. Defaults to all fields.

targetIndex
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

projectImportsEnabled
boolean

Whether the Entity Table is a possible upload target in the Upload center. Defaults to false.

{
  • "allowedFields": [
    ],
  • "targetIndex": "string",
  • "projectImportsEnabled": true
}

ComputedFieldV108

type
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

label
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

name
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "type": "string",
  • "label": "string",
  • "name": "string"
}

ComputedFieldsScriptV108

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "id": "string"
}

ComputedFieldsScriptsV108

required
Array of objects (ComputedFieldsScriptV108)
Array
id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (ComputedFieldV108)
Array
type
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

label
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

name
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "scripts": [
    ],
  • "fields": [
    ]
}

SavedSearchAttributes

version
required
number <integer>
Value: 108

Search object version

compositePrimaryKeyFields
required
Array of strings <keyword> (keyword) [ items <keyword > ]

Array of fields used to construct the key for reconciliation.

required
object
object (ComputedFieldsScriptsV108)
required
Array of objects (ComputedFieldsScriptV108)
Array
id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (ComputedFieldV108)
Array
type
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

label
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

name
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (ImportSettingsV108)
allowedFields
Array of strings <keyword> (keyword) [ items <keyword > ]

An optional list of fields that imported data can be mapped to. Defaults to all fields.

targetIndex
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

projectImportsEnabled
boolean

Whether the Entity Table is a possible upload target in the Upload center. Defaults to false.

object (EntityResolutionV108)
enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

required
Array of objects (DynamicFilterMappingV108)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

Array
type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

Array
type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object (GlobalSearchSettingsV108)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

Array
boost
required
number <double>
required
object
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV108)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV108)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV108)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

{
  • "version": 108,
  • "compositePrimaryKeyFields": [
    ],
  • "siren": {
    },
  • "indexPattern": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "sort": [
    ],
  • "columns": [
    ],
  • "hits": 0,
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedSearchAttributes_

required
object (SavedSearchAttributes)
version
required
number <integer>
Value: 108

Search object version

compositePrimaryKeyFields
required
Array of strings <keyword> (keyword) [ items <keyword > ]

Array of fields used to construct the key for reconciliation.

required
object
object (ComputedFieldsScriptsV108)
required
Array of objects (ComputedFieldsScriptV108)
required
Array of objects (ComputedFieldV108)
object (ImportSettingsV108)
allowedFields
Array of strings <keyword> (keyword) [ items <keyword > ]

An optional list of fields that imported data can be mapped to. Defaults to all fields.

targetIndex
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

projectImportsEnabled
boolean

Whether the Entity Table is a possible upload target in the Upload center. Defaults to false.

object (EntityResolutionV108)
enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

required
Array of objects (DynamicFilterMappingV108)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

required
object (GlobalSearchSettingsV108)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV108)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV108)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV108)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSearchPayload

required
object (SavedSearchAttributes)
version
required
number <integer>
Value: 108

Search object version

compositePrimaryKeyFields
required
Array of strings <keyword> (keyword) [ items <keyword > ]

Array of fields used to construct the key for reconciliation.

required
object
object (ComputedFieldsScriptsV108)
required
Array of objects (ComputedFieldsScriptV108)
required
Array of objects (ComputedFieldV108)
object (ImportSettingsV108)
allowedFields
Array of strings <keyword> (keyword) [ items <keyword > ]

An optional list of fields that imported data can be mapped to. Defaults to all fields.

targetIndex
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

projectImportsEnabled
boolean

Whether the Entity Table is a possible upload target in the Upload center. Defaults to false.

object (EntityResolutionV108)
enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

required
Array of objects (DynamicFilterMappingV108)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

required
object (GlobalSearchSettingsV108)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV108)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV108)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV108)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedEidAttributes

version
required
number <integer>
Value: 100

EID object version

required
object
required
object
shortDescription
required
string <string>

Short description

color
required
string <string>

EID icon color

icon
required
string <string>

EID icon to display

title
required
string <string>

Title for EID

{
  • "version": 100,
  • "siren": {
    },
  • "title": "string"
}

ObjectPayload_SavedEidAttributes_

required
object (SavedEidAttributes)
version
required
number <integer>
Value: 100

EID object version

required
object
required
object
shortDescription
required
string <string>

Short description

color
required
string <string>

EID icon color

icon
required
string <string>

EID icon to display

title
required
string <string>

Title for EID

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedEidPayload

required
object (SavedEidAttributes)
version
required
number <integer>
Value: 100

EID object version

required
object
required
object
shortDescription
required
string <string>

Short description

color
required
string <string>

EID icon color

icon
required
string <string>

EID icon to display

title
required
string <string>

Title for EID

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

RelationOperatorV103

string (RelationOperatorV103)
Enum: "eq" "lt" "gt" "lte" "gte" "within" "intersects" "contains"
"eq"

RelationAllowMissingBoundV103

string (RelationAllowMissingBoundV103)
Enum: "left" "right" "both" "none"
"left"

RelationConditionV103

allowMissingBound
string (RelationAllowMissingBoundV103)
Enum: "left" "right" "both" "none"
operator
required
string (RelationOperatorV103)
Enum: "eq" "lt" "gt" "lte" "gte" "within" "intersects" "contains"
rangeField
string <keyword>

Range field set for relation

domainField
string <keyword>

Domain field set for relation

clause
required
string
Value: "must"
{
  • "allowMissingBound": "left",
  • "operator": "eq",
  • "rangeField": "string",
  • "domainField": "string",
  • "clause": "must"
}

PreferredDirectionV103

string (PreferredDirectionV103)
Enum: "direct" "inverse"
"direct"

SavedRelationAttributes

entityResolutionTypes
Array of strings <keyword> (keyword) [ items <keyword > ]

Entity resolution types

preferredDirection
string (PreferredDirectionV103)
Enum: "direct" "inverse"
version
required
number <integer>
Value: 103

Relation object version

hidden
required
boolean <boolean>

Describes if the relation should be hidden

countEnabled
required
boolean <boolean>

Enables counts on relational button

undirected
required
boolean <boolean>

Describes if the directional relationship of the relation

timeout
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

joinType
required
string <string>

Join algorithm provided by Siren Federate

rangeField
string <string>

Range field set for relation

rangeId
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.

domainField
string <string>

Domain field set for relation

domainId
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.

inverseLabel
required
string <string>

Inverse Relational label for relation

inverseOf
required
string <string>

Relation will be the inverse of another

title
required
string <string>

Title for Relation

directLabel
required
string <string>

Direct label set for relation

required
Array of objects (RelationConditionV103)

Array with relation must conditions

Array
allowMissingBound
string (RelationAllowMissingBoundV103)
Enum: "left" "right" "both" "none"
operator
required
string (RelationOperatorV103)
Enum: "eq" "lt" "gt" "lte" "gte" "within" "intersects" "contains"
rangeField
string <keyword>

Range field set for relation

domainField
string <keyword>

Domain field set for relation

clause
required
string
Value: "must"
{
  • "entityResolutionTypes": [
    ],
  • "preferredDirection": "direct",
  • "version": 103,
  • "hidden": true,
  • "countEnabled": true,
  • "undirected": true,
  • "timeout": 0,
  • "joinType": "string",
  • "rangeField": "string",
  • "rangeId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "domainField": "string",
  • "domainId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "inverseLabel": "string",
  • "inverseOf": "string",
  • "title": "string",
  • "directLabel": "string",
  • "conditions": [
    ]
}

ObjectPayload_SavedRelationAttributes_

required
object (SavedRelationAttributes)
entityResolutionTypes
Array of strings <keyword> (keyword) [ items <keyword > ]

Entity resolution types

preferredDirection
string (PreferredDirectionV103)
Enum: "direct" "inverse"
version
required
number <integer>
Value: 103

Relation object version

hidden
required
boolean <boolean>

Describes if the relation should be hidden

countEnabled
required
boolean <boolean>

Enables counts on relational button

undirected
required
boolean <boolean>

Describes if the directional relationship of the relation

timeout
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

joinType
required
string <string>

Join algorithm provided by Siren Federate

rangeField
string <string>

Range field set for relation

rangeId
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.

domainField
string <string>

Domain field set for relation

domainId
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.

inverseLabel
required
string <string>

Inverse Relational label for relation

inverseOf
required
string <string>

Relation will be the inverse of another

title
required
string <string>

Title for Relation

directLabel
required
string <string>

Direct label set for relation

required
Array of objects (RelationConditionV103)

Array with relation must conditions

Array
allowMissingBound
string (RelationAllowMissingBoundV103)
Enum: "left" "right" "both" "none"
operator
required
string (RelationOperatorV103)
Enum: "eq" "lt" "gt" "lte" "gte" "within" "intersects" "contains"
rangeField
string <keyword>

Range field set for relation

domainField
string <keyword>

Domain field set for relation

clause
required
string
Value: "must"
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedRelationPayload

required
object (SavedRelationAttributes)
entityResolutionTypes
Array of strings <keyword> (keyword) [ items <keyword > ]

Entity resolution types

preferredDirection
string (PreferredDirectionV103)
Enum: "direct" "inverse"
version
required
number <integer>
Value: 103

Relation object version

hidden
required
boolean <boolean>

Describes if the relation should be hidden

countEnabled
required
boolean <boolean>

Enables counts on relational button

undirected
required
boolean <boolean>

Describes if the directional relationship of the relation

timeout
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

joinType
required
string <string>

Join algorithm provided by Siren Federate

rangeField
string <string>

Range field set for relation

rangeId
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.

domainField
string <string>

Domain field set for relation

domainId
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.

inverseLabel
required
string <string>

Inverse Relational label for relation

inverseOf
required
string <string>

Relation will be the inverse of another

title
required
string <string>

Title for Relation

directLabel
required
string <string>

Direct label set for relation

required
Array of objects (RelationConditionV103)

Array with relation must conditions

Array
allowMissingBound
string (RelationAllowMissingBoundV103)
Enum: "left" "right" "both" "none"
operator
required
string (RelationOperatorV103)
Enum: "eq" "lt" "gt" "lte" "gte" "within" "intersects" "contains"
rangeField
string <keyword>

Range field set for relation

domainField
string <keyword>

Domain field set for relation

clause
required
string
Value: "must"
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedDashboardAttributes

version
required
number <integer>
Value: 101

Dashboard object version

uiStateJSON
string <string>

UI State used by Dashboard

title
required
string <string>

Title of Dashboard

object
section
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

value
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

pause
boolean
display
string
timeFrom
string <string>

Time period e.g start period

timeTo
string <string>

Time period e.g end period

timeMode
string <string>

Time mode for the Dashboard e.g absolute, relative

timeRestore
required
boolean <boolean>

If time is stored on the dashboard

scriptIds
required
Array of strings

Ids of sripts on a Dashboard

flexLayoutJSON
string <string>

Structure describing flex layout

panelsJSON
string <string>

Dashboard panels

optionsJSON
string <string>

Dashboard options

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
required
string <string>

Description of a Dashboard

coatJSON
string <string>

A tree structure describing a datamodel

{
  • "version": 101,
  • "uiStateJSON": "string",
  • "title": "string",
  • "refreshInterval": {
    },
  • "timeFrom": "string",
  • "timeTo": "string",
  • "timeMode": "string",
  • "timeRestore": true,
  • "scriptIds": [
    ],
  • "flexLayoutJSON": "string",
  • "panelsJSON": "string",
  • "optionsJSON": "string",
  • "kibanaSavedObjectMeta": {
    },
  • "hits": 0,
  • "description": "string",
  • "coatJSON": "string"
}

ObjectPayload_SavedDashboardAttributes_

required
object (SavedDashboardAttributes)
version
required
number <integer>
Value: 101

Dashboard object version

uiStateJSON
string <string>

UI State used by Dashboard

title
required
string <string>

Title of Dashboard

object
section
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

value
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

pause
boolean
display
string
timeFrom
string <string>

Time period e.g start period

timeTo
string <string>

Time period e.g end period

timeMode
string <string>

Time mode for the Dashboard e.g absolute, relative

timeRestore
required
boolean <boolean>

If time is stored on the dashboard

scriptIds
required
Array of strings

Ids of sripts on a Dashboard

flexLayoutJSON
string <string>

Structure describing flex layout

panelsJSON
string <string>

Dashboard panels

optionsJSON
string <string>

Dashboard options

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
required
string <string>

Description of a Dashboard

coatJSON
string <string>

A tree structure describing a datamodel

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedDashboardPayload

required
object (SavedDashboardAttributes)
version
required
number <integer>
Value: 101

Dashboard object version

uiStateJSON
string <string>

UI State used by Dashboard

title
required
string <string>

Title of Dashboard

object
section
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

value
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

pause
boolean
display
string
timeFrom
string <string>

Time period e.g start period

timeTo
string <string>

Time period e.g end period

timeMode
string <string>

Time mode for the Dashboard e.g absolute, relative

timeRestore
required
boolean <boolean>

If time is stored on the dashboard

scriptIds
required
Array of strings

Ids of sripts on a Dashboard

flexLayoutJSON
string <string>

Structure describing flex layout

panelsJSON
string <string>

Dashboard panels

optionsJSON
string <string>

Dashboard options

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
required
string <string>

Description of a Dashboard

coatJSON
string <string>

A tree structure describing a datamodel

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedScriptAttributes

version
required
number <integer>
Value: 100

Script object version

object
searchSourceJSON
required
string <string>

Stringified JSON object

scriptSource
required
string <string>

Script type

type
required
string <string>

Script type

description
string <string>

An optional description for script

title
required
string <string>

Title for script

{
  • "version": 100,
  • "kibanaSavedObjectMeta": {
    },
  • "scriptSource": "string",
  • "type": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedScriptAttributes_

required
object (SavedScriptAttributes)
version
required
number <integer>
Value: 100

Script object version

object
searchSourceJSON
required
string <string>

Stringified JSON object

scriptSource
required
string <string>

Script type

type
required
string <string>

Script type

description
string <string>

An optional description for script

title
required
string <string>

Title for script

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedScriptPayload

required
object (SavedScriptAttributes)
version
required
number <integer>
Value: 100

Script object version

object
searchSourceJSON
required
string <string>

Stringified JSON object

scriptSource
required
string <string>

Script type

type
required
string <string>

Script type

description
string <string>

An optional description for script

title
required
string <string>

Title for script

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSirenApiScriptAttributes

object
searchSourceJSON
required
string <string>

Stringified JSON object

apiVersion
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

version
required
number <integer>
Value: 100

Script object version

scriptTypeVersion
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

scriptSource
required
string <string>

Script type

type
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

description
required
string <string>

An optional description for script

title
required
string <string>

Title for script

{
  • "kibanaSavedObjectMeta": {
    },
  • "apiVersion": 0,
  • "version": 100,
  • "scriptTypeVersion": 0,
  • "scriptSource": "string",
  • "type": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedSirenApiScriptAttributes_

required
object (SavedSirenApiScriptAttributes)
object
searchSourceJSON
required
string <string>

Stringified JSON object

apiVersion
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

version
required
number <integer>
Value: 100

Script object version

scriptTypeVersion
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

scriptSource
required
string <string>

Script type

type
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

description
required
string <string>

An optional description for script

title
required
string <string>

Title for script

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSirenApiScriptPayload

required
object (SavedSirenApiScriptAttributes)
object
searchSourceJSON
required
string <string>

Stringified JSON object

apiVersion
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

version
required
number <integer>
Value: 100

Script object version

scriptTypeVersion
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

scriptSource
required
string <string>

Script type

type
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

description
required
string <string>

An optional description for script

title
required
string <string>

Title for script

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributes

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 114

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 114,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributes_

required
object (SavedVisualizationAttributes)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 114

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationPayload

required
object (SavedVisualizationAttributes)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 114

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

WebServiceConfigTypesV100

string (WebServiceConfigTypesV100)
Enum: "service-configuration" "profile"
"service-configuration"

SavedWebServiceConfigAttributes

version
required
number <integer>
Value: 100

Web service config object version

data
required
string <string>

Web service config data json value

type
required
string (WebServiceConfigTypesV100)
Enum: "service-configuration" "profile"
title
required
string <string>

Title for Web service config

{
  • "version": 100,
  • "data": "string",
  • "type": "service-configuration",
  • "title": "string"
}

ObjectPayload_SavedWebServiceConfigAttributes_

required
object (SavedWebServiceConfigAttributes)
version
required
number <integer>
Value: 100

Web service config object version

data
required
string <string>

Web service config data json value

type
required
string (WebServiceConfigTypesV100)
Enum: "service-configuration" "profile"
title
required
string <string>

Title for Web service config

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedWebServiceConfigPayload

required
object (SavedWebServiceConfigAttributes)
version
required
number <integer>
Value: 100

Web service config object version

data
required
string <string>

Web service config data json value

type
required
string (WebServiceConfigTypesV100)
Enum: "service-configuration" "profile"
title
required
string <string>

Title for Web service config

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

dateString

string <date> (dateString)

Format YYYY-MM-DD

"2019-08-24"

SavedUrlAttributes

version
required
number <integer>
Value: 101

Url object version

sirenSession
any <any>

Siren session

url
required
string <string>

Url string

string or dateString (string) <date>

Create date of url

Any of
string <date>

Create date of url

string or dateString (string) <date>

Access date of url, if not passed will take the current date

Any of
string <date>

Access date of url, if not passed will take the current date

accessCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

{
  • "version": 101,
  • "sirenSession": null,
  • "url": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "accessDate": "2019-08-24T14:15:22Z",
  • "accessCount": 0
}

ObjectPayload_SavedUrlAttributes_

required
object (SavedUrlAttributes)
version
required
number <integer>
Value: 101

Url object version

sirenSession
any <any>

Siren session

url
required
string <string>

Url string

string or dateString (string) <date>

Create date of url

Any of
string <date>

Create date of url

string or dateString (string) <date>

Access date of url, if not passed will take the current date

Any of
string <date>

Access date of url, if not passed will take the current date

accessCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedUrlPayload

required
object (SavedUrlAttributes)
version
required
number <integer>
Value: 101

Url object version

sirenSession
any <any>

Siren session

url
required
string <string>

Url string

string or dateString (string) <date>

Create date of url

Any of
string <date>

Create date of url

string or dateString (string) <date>

Access date of url, if not passed will take the current date

Any of
string <date>

Access date of url, if not passed will take the current date

accessCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedTransformerAttributes

version
required
number <integer>
Value: 101

Transformer object version

userPipeline
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

fieldScripts
required
string

Transformer script used to transform fields (json value)

searchId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

description
required
string

A description for the transformer

title
required
string

Title of the transformer

{
  • "version": 101,
  • "userPipeline": "string",
  • "fieldScripts": "string",
  • "searchId": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedTransformerAttributes_

required
object (SavedTransformerAttributes)
version
required
number <integer>
Value: 101

Transformer object version

userPipeline
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

fieldScripts
required
string

Transformer script used to transform fields (json value)

searchId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

description
required
string

A description for the transformer

title
required
string

Title of the transformer

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedTransformerPayload

required
object (SavedTransformerAttributes)
version
required
number <integer>
Value: 101

Transformer object version

userPipeline
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

fieldScripts
required
string

Transformer script used to transform fields (json value)

searchId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

description
required
string

A description for the transformer

title
required
string

Title of the transformer

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSentinlWatcherAttributes

version
required
number <integer>
Value: 100

SentinlWatcher object version

(string or null) or (Array of strings or null) <string>

Roles for SentinlWatcher

Any of
string or null <string>

Roles for SentinlWatcher

custom
string <string>

Custom for SentinlWatcher

dashboard_link
string <string>

Dashboard link for SentinlWatcher

wizard
string <string>

Wizard for SentinlWatcher

trigger
required
string <string>

Trigger for SentinlWatcher

spy
required
boolean <boolean>

Is spy

save_payload
required
boolean <boolean>

Is payload to be saved

priority
string <string>

Priority of SentinlWatcher

input
required
string <string>

Input for SentinlWatcher

is_private
boolean <boolean>

Is private

impersonate
required
boolean <boolean>

Does impersonate

disable
required
boolean <boolean>

Is disabled

string or any <string>

Creator of SentinlWatcher

Any of
string <string>

Creator of SentinlWatcher

transform
string <string>

Transform for sentinlWatcher

condition
required
string <string>

Condition for sentinlWatcher

actions
required
string <string>

Action for sentinlWatcher

report
required
boolean <string>

Report on for sentinlWatcher

username
string <string>

Username for sentinlWatcher

title
required
string <string>

Title for sentinlWatcher

{
  • "version": 100,
  • "roles": "string",
  • "custom": "string",
  • "dashboard_link": "string",
  • "wizard": "string",
  • "trigger": "string",
  • "spy": true,
  • "save_payload": true,
  • "priority": "string",
  • "input": "string",
  • "is_private": true,
  • "impersonate": true,
  • "disable": true,
  • "created_by": "string",
  • "transform": "string",
  • "condition": "string",
  • "actions": "string",
  • "report": true,
  • "username": "string",
  • "title": "string"
}

ObjectPayload_SavedSentinlWatcherAttributes_

required
object (SavedSentinlWatcherAttributes)
version
required
number <integer>
Value: 100

SentinlWatcher object version

(string or null) or (Array of strings or null) <string>

Roles for SentinlWatcher

Any of
string or null <string>

Roles for SentinlWatcher

custom
string <string>

Custom for SentinlWatcher

dashboard_link
string <string>

Dashboard link for SentinlWatcher

wizard
string <string>

Wizard for SentinlWatcher

trigger
required
string <string>

Trigger for SentinlWatcher

spy
required
boolean <boolean>

Is spy

save_payload
required
boolean <boolean>

Is payload to be saved

priority
string <string>

Priority of SentinlWatcher

input
required
string <string>

Input for SentinlWatcher

is_private
boolean <boolean>

Is private

impersonate
required
boolean <boolean>

Does impersonate

disable
required
boolean <boolean>

Is disabled

string or any <string>

Creator of SentinlWatcher

Any of
string <string>

Creator of SentinlWatcher

transform
string <string>

Transform for sentinlWatcher

condition
required
string <string>

Condition for sentinlWatcher

actions
required
string <string>

Action for sentinlWatcher

report
required
boolean <string>

Report on for sentinlWatcher

username
string <string>

Username for sentinlWatcher

title
required
string <string>

Title for sentinlWatcher

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSentinlWatcherPayload

required
object (SavedSentinlWatcherAttributes)
version
required
number <integer>
Value: 100

SentinlWatcher object version

(string or null) or (Array of strings or null) <string>

Roles for SentinlWatcher

Any of
string or null <string>

Roles for SentinlWatcher

custom
string <string>

Custom for SentinlWatcher

dashboard_link
string <string>

Dashboard link for SentinlWatcher

wizard
string <string>

Wizard for SentinlWatcher

trigger
required
string <string>

Trigger for SentinlWatcher

spy
required
boolean <boolean>

Is spy

save_payload
required
boolean <boolean>

Is payload to be saved

priority
string <string>

Priority of SentinlWatcher

input
required
string <string>

Input for SentinlWatcher

is_private
boolean <boolean>

Is private

impersonate
required
boolean <boolean>

Does impersonate

disable
required
boolean <boolean>

Is disabled

string or any <string>

Creator of SentinlWatcher

Any of
string <string>

Creator of SentinlWatcher

transform
string <string>

Transform for sentinlWatcher

condition
required
string <string>

Condition for sentinlWatcher

actions
required
string <string>

Action for sentinlWatcher

report
required
boolean <string>

Report on for sentinlWatcher

username
string <string>

Username for sentinlWatcher

title
required
string <string>

Title for sentinlWatcher

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SystemGroupConfigV104

title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

{
  • "title": "string",
  • "iconCss": "string"
}

SystemGroupsV104

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

{
  • "sharedWithMe": {
    },
  • "myObjects": {
    },
  • "shared": {
    },
  • "private": {
    }
}

AnyObjectEsType_SystemGroupsV104_

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

{
  • "sharedWithMe": {
    },
  • "myObjects": {
    },
  • "shared": {
    },
  • "private": {
    }
}

SavedSidebarOptionsAttributes

_skip_id_validation
boolean

Temporary property to indicate that strict id validation should be skipped for this object This property will be removed in the future

version
required
number <integer>
Value: 104

Sidebar options object version

required
object (AnyObjectEsType_SystemGroupsV104_)
required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

order
required
string <string>

Sidebar options display order

title
required
string <keyword>

Title for sidebar options

{
  • "_skip_id_validation": true,
  • "version": 104,
  • "systemGroups": {
    },
  • "order": "string",
  • "title": "string"
}

ObjectPayload_SavedSidebarOptionsAttributes_

required
object (SavedSidebarOptionsAttributes)
_skip_id_validation
boolean

Temporary property to indicate that strict id validation should be skipped for this object This property will be removed in the future

version
required
number <integer>
Value: 104

Sidebar options object version

required
object (AnyObjectEsType_SystemGroupsV104_)
required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

order
required
string <string>

Sidebar options display order

title
required
string <keyword>

Title for sidebar options

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSidebarOptionsPayload

required
object (SavedSidebarOptionsAttributes)
_skip_id_validation
boolean

Temporary property to indicate that strict id validation should be skipped for this object This property will be removed in the future

version
required
number <integer>
Value: 104

Sidebar options object version

required
object (AnyObjectEsType_SystemGroupsV104_)
required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

order
required
string <string>

Sidebar options display order

title
required
string <keyword>

Title for sidebar options

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedI2ExportConfigAttributes

version
required
number <integer>
Value: 100

I2 export config object version

json
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 100,
  • "json": "string"
}

ObjectPayload_SavedI2ExportConfigAttributes_

required
object (SavedI2ExportConfigAttributes)
version
required
number <integer>
Value: 100

I2 export config object version

json
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedI2ExportConfigPayload

required
object (SavedI2ExportConfigAttributes)
version
required
number <integer>
Value: 100

I2 export config object version

json
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

Base64

string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

"string"

SavedIconpackAttributes

version
required
number <integer>
Value: 100

Iconpack object version

prefix
required
string <string>

A unique value per icon pack which is used on CSS classes to display icon.

woff2
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

woff
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

ttf
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

svg
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

eot
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

icon_names
required
Array of strings

A list of icons presented on the icon pack

unicodes
string <string>

Icons' unicodes stored as a string which are used on graph browser in JSON format

font_family
string <string>

Name of font family for icon pack

css
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

name
required
string <string>

Name of iconpack

{
  • "version": 100,
  • "prefix": "string",
  • "woff2": "string",
  • "woff": "string",
  • "ttf": "string",
  • "svg": "string",
  • "eot": "string",
  • "icon_names": [
    ],
  • "unicodes": "string",
  • "font_family": "string",
  • "css": "string",
  • "name": "string"
}

ObjectPayload_SavedIconpackAttributes_

required
object (SavedIconpackAttributes)
version
required
number <integer>
Value: 100

Iconpack object version

prefix
required
string <string>

A unique value per icon pack which is used on CSS classes to display icon.

woff2
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

woff
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

ttf
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

svg
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

eot
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

icon_names
required
Array of strings

A list of icons presented on the icon pack

unicodes
string <string>

Icons' unicodes stored as a string which are used on graph browser in JSON format

font_family
string <string>

Name of font family for icon pack

css
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

name
required
string <string>

Name of iconpack

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedIconpackPayload

required
object (SavedIconpackAttributes)
version
required
number <integer>
Value: 100

Iconpack object version

prefix
required
string <string>

A unique value per icon pack which is used on CSS classes to display icon.

woff2
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

woff
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

ttf
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

svg
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

eot
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

icon_names
required
Array of strings

A list of icons presented on the icon pack

unicodes
string <string>

Icons' unicodes stored as a string which are used on graph browser in JSON format

font_family
string <string>

Name of font family for icon pack

css
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

name
required
string <string>

Name of iconpack

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

AccessLevel

object (AccessLevel)
{ }

AccessLevelV100

string (AccessLevelV100)
Enum: "readOnly" "privateCreator" "sharedCreator" "contentManager" "dataModelManager" "dataspaceManager"
"readOnly"

ShareDataspaceObjectV100

required
AccessLevelV100 (string) or string <keyword>

Access level associated to the role.

readOnly - Read only access to all objects in the dataspace.

privateCreator - Read only access to everything. Can create private dashboards, graphs and bookmarked searches.

sharedCreator - Read only access to everything. Can create and share dashboards, graphs and bookmarked searches.

contentManager - Read only access to everything. Can create, share, change and delete dashboards, graphs and bookmarked searches.

dataModelManager - Read/write/delete access to all objects in the dataspace.

dataspaceManager - Read/write/delete access to all objects in the dataspace and can change and delete the dataspace itself.

R - (deprecated) Same as readOnly

RW- (deprecated) Read/Write access

RWD - (deprecated) Same as dataspaceManager

Any of
string <keyword> (AccessLevelV100)
Enum: "readOnly" "privateCreator" "sharedCreator" "contentManager" "dataModelManager" "dataspaceManager"

Access level associated to the role.

readOnly - Read only access to all objects in the dataspace.

privateCreator - Read only access to everything. Can create private dashboards, graphs and bookmarked searches.

sharedCreator - Read only access to everything. Can create and share dashboards, graphs and bookmarked searches.

contentManager - Read only access to everything. Can create, share, change and delete dashboards, graphs and bookmarked searches.

dataModelManager - Read/write/delete access to all objects in the dataspace.

dataspaceManager - Read/write/delete access to all objects in the dataspace and can change and delete the dataspace itself.

R - (deprecated) Same as readOnly

RW- (deprecated) Read/Write access

RWD - (deprecated) Same as dataspaceManager

roleName
required
string <string>

Role name

{
  • "accessLevel": "readOnly",
  • "roleName": "string"
}

SavedDataspaceAttributes

version
required
number <integer>
Value: 100

Dataspace object version

Array of objects (ShareDataspaceObjectV100)

An array of roles this dataspace is accessible to

Array
required
AccessLevelV100 (string) or string <keyword>

Access level associated to the role.

readOnly - Read only access to all objects in the dataspace.

privateCreator - Read only access to everything. Can create private dashboards, graphs and bookmarked searches.

sharedCreator - Read only access to everything. Can create and share dashboards, graphs and bookmarked searches.

contentManager - Read only access to everything. Can create, share, change and delete dashboards, graphs and bookmarked searches.

dataModelManager - Read/write/delete access to all objects in the dataspace.

dataspaceManager - Read/write/delete access to all objects in the dataspace and can change and delete the dataspace itself.

R - (deprecated) Same as readOnly

RW- (deprecated) Read/Write access

RWD - (deprecated) Same as dataspaceManager

Any of
string <keyword> (AccessLevelV100)
Enum: "readOnly" "privateCreator" "sharedCreator" "contentManager" "dataModelManager" "dataspaceManager"

Access level associated to the role.

readOnly - Read only access to all objects in the dataspace.

privateCreator - Read only access to everything. Can create private dashboards, graphs and bookmarked searches.

sharedCreator - Read only access to everything. Can create and share dashboards, graphs and bookmarked searches.

contentManager - Read only access to everything. Can create, share, change and delete dashboards, graphs and bookmarked searches.

dataModelManager - Read/write/delete access to all objects in the dataspace.

dataspaceManager - Read/write/delete access to all objects in the dataspace and can change and delete the dataspace itself.

R - (deprecated) Same as readOnly

RW- (deprecated) Read/Write access

RWD - (deprecated) Same as dataspaceManager

roleName
required
string <string>

Role name

icon
required
string <string>

Icon for Dataspace

colorCode
required
string <string>

Color code

description
string <string>

Description for Dataspace

title
required
string <string>

Title for Dataspace

shortCode
required
string <string> ^[a-z0-9\-_]+$

Alphanumeric string used to uniquely identify each dataspace

accessLevel
object (AccessLevel)
object
delete
required
boolean
change
required
boolean
ownerId
string or null
creationDate
number <double>
lastAccessedDate
number <double>
lastUpdatedDate
number <double>
{
  • "version": 100,
  • "sharedWith": [
    ],
  • "icon": "string",
  • "colorCode": "string",
  • "description": "string",
  • "title": "string",
  • "shortCode": "string",
  • "accessLevel": { },
  • "permissions": {
    },
  • "ownerId": "string",
  • "creationDate": 0.1,
  • "lastAccessedDate": 0.1,
  • "lastUpdatedDate": 0.1
}

ObjectPayload_SavedDataspaceAttributes_

required
object (SavedDataspaceAttributes)
version
required
number <integer>
Value: 100

Dataspace object version

Array of objects (ShareDataspaceObjectV100)

An array of roles this dataspace is accessible to

Array
required
AccessLevelV100 (string) or string <keyword>

Access level associated to the role.

readOnly - Read only access to all objects in the dataspace.

privateCreator - Read only access to everything. Can create private dashboards, graphs and bookmarked searches.

sharedCreator - Read only access to everything. Can create and share dashboards, graphs and bookmarked searches.

contentManager - Read only access to everything. Can create, share, change and delete dashboards, graphs and bookmarked searches.

dataModelManager - Read/write/delete access to all objects in the dataspace.

dataspaceManager - Read/write/delete access to all objects in the dataspace and can change and delete the dataspace itself.

R - (deprecated) Same as readOnly

RW- (deprecated) Read/Write access

RWD - (deprecated) Same as dataspaceManager

roleName
required
string <string>

Role name

icon
required
string <string>

Icon for Dataspace

colorCode
required
string <string>

Color code

description
string <string>

Description for Dataspace

title
required
string <string>

Title for Dataspace

shortCode
required
string <string> ^[a-z0-9\-_]+$

Alphanumeric string used to uniquely identify each dataspace

accessLevel
object (AccessLevel)
object
delete
required
boolean
change
required
boolean
ownerId
string or null
creationDate
number <double>
lastAccessedDate
number <double>
lastUpdatedDate
number <double>
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

object
excludeTypes
Array of strings

Option for which object types not to clone, only applies when create is true

includeTypes
Array of strings

Option for which object types to clone - clone all if undefined, only applies when create is true

create
required
boolean

Option whether to update or create a dataspace. Note - must be set to true if creating and false if updating

copyFrom
required
Array of strings

A stringified array of existing dataspace shortCodes, only applies when create is true

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string",
  • "options": {
    }
}

SavedDataspacePayload

required
object (SavedDataspaceAttributes)
version
required
number <integer>
Value: 100

Dataspace object version

Array of objects (ShareDataspaceObjectV100)

An array of roles this dataspace is accessible to

Array
required
AccessLevelV100 (string) or string <keyword>

Access level associated to the role.

readOnly - Read only access to all objects in the dataspace.

privateCreator - Read only access to everything. Can create private dashboards, graphs and bookmarked searches.

sharedCreator - Read only access to everything. Can create and share dashboards, graphs and bookmarked searches.

contentManager - Read only access to everything. Can create, share, change and delete dashboards, graphs and bookmarked searches.

dataModelManager - Read/write/delete access to all objects in the dataspace.

dataspaceManager - Read/write/delete access to all objects in the dataspace and can change and delete the dataspace itself.

R - (deprecated) Same as readOnly

RW- (deprecated) Read/Write access

RWD - (deprecated) Same as dataspaceManager

roleName
required
string <string>

Role name

icon
required
string <string>

Icon for Dataspace

colorCode
required
string <string>

Color code

description
string <string>

Description for Dataspace

title
required
string <string>

Title for Dataspace

shortCode
required
string <string> ^[a-z0-9\-_]+$

Alphanumeric string used to uniquely identify each dataspace

accessLevel
object (AccessLevel)
object
delete
required
boolean
change
required
boolean
ownerId
string or null
creationDate
number <double>
lastAccessedDate
number <double>
lastUpdatedDate
number <double>
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

object
excludeTypes
Array of strings

Option for which object types not to clone, only applies when create is true

includeTypes
Array of strings

Option for which object types to clone - clone all if undefined, only applies when create is true

create
required
boolean

Option whether to update or create a dataspace. Note - must be set to true if creating and false if updating

copyFrom
required
Array of strings

A stringified array of existing dataspace shortCodes, only applies when create is true

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string",
  • "options": {
    }
}

TimelionExpression

string <keyword> (TimelionExpression)

A timelion expression mapped as keyword.

"string"

SavedTimelionSheetAttributes

version
required
number <integer>
Value: 100

TimelionSheet object version

timelion_rows
required
number <double> \b([1-9]|1[0-2])\b

Number of rows for timelion

timelion_columns
required
number <double> \b([1-9]|1[0-2])\b

Number of columns for timelion

timelion_interval
required
string <string>

Interval used for filtering data by time

timelion_sheet
required
Array of strings <keyword> (TimelionExpression) [ items <keyword > ]

Array of queries used for each panel

description
required
string <string>

Description

hits
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

title
required
string <string>

Title

{
  • "version": 100,
  • "timelion_rows": 0.1,
  • "timelion_columns": 0.1,
  • "timelion_interval": "string",
  • "timelion_sheet": [
    ],
  • "description": "string",
  • "hits": 0,
  • "title": "string"
}

ObjectPayload_SavedTimelionSheetAttributes_

required
object (SavedTimelionSheetAttributes)
version
required
number <integer>
Value: 100

TimelionSheet object version

timelion_rows
required
number <double> \b([1-9]|1[0-2])\b

Number of rows for timelion

timelion_columns
required
number <double> \b([1-9]|1[0-2])\b

Number of columns for timelion

timelion_interval
required
string <string>

Interval used for filtering data by time

timelion_sheet
required
Array of strings <keyword> (TimelionExpression) [ items <keyword > ]

Array of queries used for each panel

description
required
string <string>

Description

hits
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

title
required
string <string>

Title

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedTimelionSheetPayload

required
object (SavedTimelionSheetAttributes)
version
required
number <integer>
Value: 100

TimelionSheet object version

timelion_rows
required
number <double> \b([1-9]|1[0-2])\b

Number of rows for timelion

timelion_columns
required
number <double> \b([1-9]|1[0-2])\b

Number of columns for timelion

timelion_interval
required
string <string>

Interval used for filtering data by time

timelion_sheet
required
Array of strings <keyword> (TimelionExpression) [ items <keyword > ]

Array of queries used for each panel

description
required
string <string>

Description

hits
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

title
required
string <string>

Title

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

BinaryBase64

string (BinaryBase64)
"string"

SelectionColumnsV126

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV126_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

dateEpochMillis

number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

0
0

ExpansionLayoutModesV126

string (ExpansionLayoutModesV126)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV126_

string (AnyObjectEsType_ExpansionLayoutModesV126_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

SelectionSettingsV126

string (SelectionSettingsV126)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

AnyObjectEsType_SelectionSettingsV126_

string (AnyObjectEsType_SelectionSettingsV126_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

MapNodeVisibilityModesV126

string (MapNodeVisibilityModesV126)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

AnyObjectEsType_MapNodeVisibilityModesV126_

string (AnyObjectEsType_MapNodeVisibilityModesV126_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

PersistedLayerTypeV126

string (PersistedLayerTypeV126)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
"wfs"

MapLayerV126

type
required
string (PersistedLayerTypeV126)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "type": "wfs",
  • "enabled": true,
  • "id": "string"
}

TimebarNodeVisibilityModesV126

string (TimebarNodeVisibilityModesV126)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV126_

string (AnyObjectEsType_TimebarNodeVisibilityModesV126_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

TimebarRenderingModeV126

string (TimebarRenderingModeV126)
Enum: "histogram" "saturn"
"histogram"

AnyObjectEsType_TimebarRenderingModeV126_

string (AnyObjectEsType_TimebarRenderingModeV126_)
Enum: "histogram" "saturn"
"histogram"

TimebarTargetHeightV126

string (TimebarTargetHeightV126)
Enum: "default" "tall"
"default"

AnyObjectEsType_TimebarTargetHeightV126_

string (AnyObjectEsType_TimebarTargetHeightV126_)
Enum: "default" "tall"
"default"

ItemsHighlightModesV126

string (ItemsHighlightModesV126)
Enum: "no" "selected" "selectedAndConnected"
"no"

AnyObjectEsType_ItemsHighlightModesV126_

string (AnyObjectEsType_ItemsHighlightModesV126_)
Enum: "no" "selected" "selectedAndConnected"
"no"

EdgeGroupingModesV126

string (EdgeGroupingModesV126)
Enum: "singleEdge" "perDirection" "off"
"singleEdge"

AnyObjectEsType_EdgeGroupingModesV126_

string (AnyObjectEsType_EdgeGroupingModesV126_)
Enum: "singleEdge" "perDirection" "off"
"singleEdge"

NodeCountModesV126

string (NodeCountModesV126)
Enum: "connectedNodes" "connectedEdges" "off"
"connectedNodes"

AnyObjectEsType_NodeCountModesV126_

string (AnyObjectEsType_NodeCountModesV126_)
Enum: "connectedNodes" "connectedEdges" "off"
"connectedNodes"

ToolbarSettingsTypeV126

required
object
nodeCount
required
string (AnyObjectEsType_NodeCountModesV126_)
Enum: "connectedNodes" "connectedEdges" "off"
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV126_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV126_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV126_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV126_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV126_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV126)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV126)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV126_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV126_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV126_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timebar": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV126_

required
object
nodeCount
required
string (AnyObjectEsType_NodeCountModesV126_)
Enum: "connectedNodes" "connectedEdges" "off"
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV126_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV126_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV126_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV126_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV126_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV126)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV126)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV126_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV126_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV126_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timebar": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributes

version
required
number <integer>
Value: 126

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV126. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV126_)
required
object
nodeCount
required
string (AnyObjectEsType_NodeCountModesV126_)
Enum: "connectedNodes" "connectedEdges" "off"
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV126_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV126_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV126_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV126_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV126_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV126)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV126)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV126_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV126_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV126_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
required
object
searchSourceJSON
required
string <string>

Stringified JSON object

vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV126_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 126,
  • "visualizerHash": "string",
  • "toolbarSettings": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "nodesCount": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributes_

required
object (SavedGraphAttributes)
version
required
number <integer>
Value: 126

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV126. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV126_)
required
object
nodeCount
required
string (AnyObjectEsType_NodeCountModesV126_)
Enum: "connectedNodes" "connectedEdges" "off"
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV126_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV126_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV126_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV126_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV126_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV126)

map overlays and base layers

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV126_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV126_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV126_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
required
object
searchSourceJSON
required
string <string>

Stringified JSON object

vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV126_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedGraphPayload

required
object (SavedGraphAttributes)
version
required
number <integer>
Value: 126

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV126. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV126_)
required
object
nodeCount
required
string (AnyObjectEsType_NodeCountModesV126_)
Enum: "connectedNodes" "connectedEdges" "off"
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV126_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV126_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV126_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV126_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV126_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV126)

map overlays and base layers

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV126_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV126_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV126_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
required
object
searchSourceJSON
required
string <string>

Stringified JSON object

vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV126_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedConfigAttributes

version
required
number <integer>
Value: 106

config object version

title
string <text>

config object title

visualization:siren_map:region_layer:layersConfig
string or null <string>

Stringified JSON object Specifies additional vector layers for use in Siren Map visualizations. Default: {'fetchSirenTiles':true,'layers':[]}

siren:favoriteColors
Array of strings or null <keyword> (keyword) [ items <keyword > ]

List of favorite colors that will be visible by default in the color picker Default: ['#0A0E2B', '#09095C', '#003997', '#861AFF', '#0ABCF2', '#27E7D7', '#FFE232', '#FFFFFF', '#AA6556', '#E7664C']

Array of objects or null (SavedConfigFavoriteIconV106)

The list of favorite icons that are quickly accessible in the icon picker. Default: []

Array
iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
siren:entityResolutionTypes
Array of strings or null <keyword> (keyword) [ items <keyword > ]

Entity resolution types which can be applied to a saved relation Default: ['Company', 'Person']

siren:globalSearchGlobalTimeIgnoreTimezone
boolean or null <boolean>

If enabled, date queries in the global search don't use the local time zone to convert to UTC. Default: false

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

jira:csvExportSize
number or null <integer>

Max number of records to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:graph.defaultEnhancedMap
string or null <string>

Object Definition Id The default enhanced map visualizer Default: null

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between records that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map. The default map will be covered when a Vector Basemap Layers is set up. Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile map aggregation layers: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big records. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our record when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight
string or null <string>

Sets the default highlight configuration as a JSON object.

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns records based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of records allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of records sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
{
  • "version": 106,
  • "title": "string",
  • "visualization:siren_map:region_layer:layersConfig": "string",
  • "siren:favoriteColors": [
    ],
  • "siren:favoriteIcons": [
    ],
  • "siren:entityResolutionTypes": [
    ],
  • "siren:globalSearchGlobalTimeIgnoreTimezone": true,
  • "siren:timeline:highlight:number_of_fragments": 0,
  • "jira:csvExportSize": 0,
  • "jira:fields": "string",
  • "timelion:min_interval": "string",
  • "timelion:default_rows": 0,
  • "timelion:default_columns": 0,
  • "timelion:max_buckets": 0,
  • "timelion:target_buckets": 0,
  • "timelion:es.default_index": "string",
  • "timelion:es.timefield": "string",
  • "timelion:showTutorial": true,
  • "siren:scoringSearchType": "query_then_fetch",
  • "siren:globalSearchDebugging": true,
  • "siren:elasticsearch:searchErrorTrace": true,
  • "siren:graph.defaultEnhancedMap": "string",
  • "siren:defaultGraphVisualizerId": "string",
  • "siren:bufferAreaDefaultUnit": "Kilometers",
  • "siren:countFetchingStrategyRelationalFilters": "string",
  • "siren:countFetchingStrategyDashboards": "string",
  • "siren:graphStatesLimit": 0,
  • "siren:excludedIndices": "string",
  • "siren:defaultDashboardId": "string",
  • "siren:enableAllRelBtnCounts": true,
  • "siren:vertical_grid_resolution": 0,
  • "siren:panel_vertical_size": 0,
  • "siren:joinTaskTimeout": 0,
  • "siren:timePrecision": "y",
  • "siren:support-large-numbers": true,
  • "siren:dashboards360:showDashboardDataModelPopup": true,
  • "context:tieBreakerFields": [
    ],
  • "context:step": 0,
  • "context:defaultSize": 0,
  • "indexPattern:placeholder": "string",
  • "state:storeInSessionStorage": true,
  • "metrics:max_buckets": 0,
  • "notifications:lifetime:info": 0,
  • "notifications:lifetime:warning": 0,
  • "notifications:lifetime:error": 0,
  • "notifications:lifetime:banner": 0,
  • "notifications:banner": "string",
  • "filterEditor:suggestValues": true,
  • "filters:pinnedByDefault": true,
  • "dashboard:defaultDarkTheme": true,
  • "timepicker:autoRefreshAllDashboardCount": true,
  • "timepicker:refreshIntervalDefaults": "string",
  • "timepicker:timeDefaults": "string",
  • "savedObjects:listingLimit": 0,
  • "savedObjects:perPage": 0,
  • "format:currency:defaultPattern": "string",
  • "format:percent:defaultPattern": "string",
  • "format:bytes:defaultPattern": "string",
  • "format:number:defaultPattern": "string",
  • "format:defaultTypeMap": "string",
  • "truncate:maxHeight": 0,
  • "shortDots:enable": true,
  • "history:limit": 0,
  • "csv:quoteValues": true,
  • "csv:separator": "string",
  • "visualization:dimmingOpacity": 0.1,
  • "visualization:loadingDelay": "string",
  • "visualization:colorMapping": "string",
  • "visualization:regionmap:showWarnings": true,
  • "visualization:tileMap:WMSdefaults": "string",
  • "visualization:tileMap:maxPrecision": 0,
  • "histogram:maxBars": 0,
  • "histogram:barTarget": 0,
  • "fields:popularLimit": 0,
  • "courier:sequentialSearches": true,
  • "courier:batchSearches": true,
  • "courier:ignoreFilterIfFieldNotInIndex": true,
  • "courier:maxSegmentCount": 0,
  • "doc_table:highlight": true,
  • "discover:aggs:terms:size": 0,
  • "discover:sampleSize": 0,
  • "metaFields": [
    ],
  • "defaultColumns": [
    ],
  • "dateFormat:dow": "Monday",
  • "dateFormat:scaled": "string",
  • "dateFormat:tz": "string",
  • "dateFormat": "string",
  • "sort:options": "string",
  • "query:queryString:options": "string",
  • "default:highlight": "string",
  • "inputControlVis:timeout": 0,
  • "siren:globalSearchSimpleQuerySyntaxOptions": "string",
  • "siren:globalSearchQuerySyntax": "query_string",
  • "siren:globalSearchTimeout": 0,
  • "sentinl:experimental": true,
  • "siren:scripting:notify": true,
  • "siren:scripting:enabled": true,
  • "data-model:max_documents_for_reindex_operations": 0,
  • "ingest-xlsx:progress_updation_frequency": 0,
  • "ingest-xlsx:simultaneous_bulk_requests": 0,
  • "ingest-xlsx:displayed_rows": 0,
  • "ingest-xlsx:bulk_package_size": 0,
  • "graph-browser:shortestPathLogLevel": "Debug",
  • "property1": null,
  • "property2": null
}

ObjectPayload_SavedConfigAttributes_

required
object (SavedConfigAttributes)
version
required
number <integer>
Value: 106

config object version

title
string <text>

config object title

visualization:siren_map:region_layer:layersConfig
string or null <string>

Stringified JSON object Specifies additional vector layers for use in Siren Map visualizations. Default: {'fetchSirenTiles':true,'layers':[]}

siren:favoriteColors
Array of strings or null <keyword> (keyword) [ items <keyword > ]

List of favorite colors that will be visible by default in the color picker Default: ['#0A0E2B', '#09095C', '#003997', '#861AFF', '#0ABCF2', '#27E7D7', '#FFE232', '#FFFFFF', '#AA6556', '#E7664C']

Array of objects or null (SavedConfigFavoriteIconV106)

The list of favorite icons that are quickly accessible in the icon picker. Default: []

Array
iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
siren:entityResolutionTypes
Array of strings or null <keyword> (keyword) [ items <keyword > ]

Entity resolution types which can be applied to a saved relation Default: ['Company', 'Person']

siren:globalSearchGlobalTimeIgnoreTimezone
boolean or null <boolean>

If enabled, date queries in the global search don't use the local time zone to convert to UTC. Default: false

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

jira:csvExportSize
number or null <integer>

Max number of records to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:graph.defaultEnhancedMap
string or null <string>

Object Definition Id The default enhanced map visualizer Default: null

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between records that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map. The default map will be covered when a Vector Basemap Layers is set up. Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile map aggregation layers: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big records. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our record when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight
string or null <string>

Sets the default highlight configuration as a JSON object.

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns records based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of records allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of records sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedConfigPayload

required
object (SavedConfigAttributes)
version
required
number <integer>
Value: 106

config object version

title
string <text>

config object title

visualization:siren_map:region_layer:layersConfig
string or null <string>

Stringified JSON object Specifies additional vector layers for use in Siren Map visualizations. Default: {'fetchSirenTiles':true,'layers':[]}

siren:favoriteColors
Array of strings or null <keyword> (keyword) [ items <keyword > ]

List of favorite colors that will be visible by default in the color picker Default: ['#0A0E2B', '#09095C', '#003997', '#861AFF', '#0ABCF2', '#27E7D7', '#FFE232', '#FFFFFF', '#AA6556', '#E7664C']

Array of objects or null (SavedConfigFavoriteIconV106)

The list of favorite icons that are quickly accessible in the icon picker. Default: []

Array
iconClass
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

iconColor
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

customName
string
siren:entityResolutionTypes
Array of strings or null <keyword> (keyword) [ items <keyword > ]

Entity resolution types which can be applied to a saved relation Default: ['Company', 'Person']

siren:globalSearchGlobalTimeIgnoreTimezone
boolean or null <boolean>

If enabled, date queries in the global search don't use the local time zone to convert to UTC. Default: false

siren:timeline:highlight:number_of_fragments
number or null <integer>

Custom Setting Default: 25

jira:csvExportSize
number or null <integer>

Max number of records to include in the export Default: 3000

jira:fields
string or null <string>

Jira ticket fields to show in the assigned tickets table Default: Summary

timelion:min_interval
string or null <string>

The smallest interval that will be calculated when using 'auto' Default: 1ms

timelion:default_rows
number or null <integer>

Number of rows on a timelion sheet by default Default: 2

timelion:default_columns
number or null <integer>

Number of columns on a timelion sheet by default Default: 2

timelion:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

timelion:target_buckets
number or null <integer>

The number of buckets to shoot for when using auto intervals Default: 200

timelion:es.default_index
string or null <string>

Default elasticsearch index to search with .es() Default: _all

timelion:es.timefield
string or null <string>

Default field containing a timestamp when using .es() Default: '@timestamp'

timelion:showTutorial
boolean or null <boolean>

Should I show the tutorial by default when entering the timelion app? Default: false

siren:scoringSearchType
string or null <keyword>
Enum: "query_then_fetch" "dfs_query_then_fetch" "dfs_query_then_fetch_if_necessary"

Specifies the search type to be used for searching. Note: Works only with Elasticsearch version 7.13.0 and later query_then_fetch - is the fastest option, but generates inaccurate scoring for shards with few records. dfs_query_then_fetch - is slower, but is accurate - regardless of the record count per shard dfs_query_then_fetch_if_necessary - applies accurate scoring only when revision indices are involved Default: dfs_query_then_fetch_if_necessary

siren:globalSearchDebugging
boolean or null <boolean>

When enabled, a button to download Global Search queries as a .json file will show in Global Search Default: false

siren:elasticsearch:searchErrorTrace
boolean or null <boolean>

Return stack_trace in search or msearch error responses if true Default: true

siren:graph.defaultEnhancedMap
string or null <string>

Object Definition Id The default enhanced map visualizer Default: null

siren:defaultGraphVisualizerId
string or null <string>

Object Definition Id The default visualizer Default: null

siren:bufferAreaDefaultUnit
string or null <keyword>
Enum: "Kilometers" "Meters" "Miles" "Yards" "Feet"

Default unit used by Buffer Area filter on Graphs, possible values are Kilometers, Meters, Miles, Yards, Feet. Default: Kilometers

siren:countFetchingStrategyRelationalFilters
string or null <string>

Stringified JSON object Strategy used to fetch the counts for relational filters Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:countFetchingStrategyDashboards
string or null <string>

Stringified JSON object Strategy used to fetch the counts for dashboards Default: { 'name': 'default', 'batchSize': 2, 'retryOnError': 1, 'parallelRequests': 1 }

siren:graphStatesLimit
number or null <integer>

Set how many undo/redo steps you want to maintain in memory Default: 5

siren:excludedIndices
string or null <string>

A comma separated list of indices / patterns to exclude when performing searches against wildcard patterns. Default: .kibi*,.siren*,.searchguard,searchguard,.security,.monitoring*,watcher_alarms-*

siren:defaultDashboardId
string or null <string>

The dashboard that is displayed when clicking on the Dashboard tab for the first time. Default: null

siren:enableAllRelBtnCounts
boolean or null <boolean>

Enable counts on all relational buttons. Default: true

siren:vertical_grid_resolution
number or null <integer>

Set to change vertical grid resolution. Default: 100

siren:panel_vertical_size
number or null <integer>

Set to change the default vertical panel size. Default: 3

siren:joinTaskTimeout
number or null <integer>

Default timeout for join task in milliseconds. Join tasks will return the results gathered at that point when the timeout expires. Set to 0 to disable the global timeout. Can be overwritten per relation in each relation's advanced options in the relational panel. Default: 0

siren:timePrecision
string or null <keyword>
Enum: "y" "M" "w" "d" "h" "m" "s" "ms"

Set to generate time filters with certain precision; possible values are y,M,w,d,h,m,s,ms. It is set to m (minute) by default, to make the best use of Federate cache on time-based data. However, if the data is updated live and better precision is needed, it can be set to s (second) or ms (millisecond). Default: m

siren:support-large-numbers
boolean or null <boolean>

Set to parse BigInt values using json-bigint. This may add performance overhead. Note:

  • Hard reset browser to clear cache after toggling.
  • Any formatter set on a field containing BigInt will be ignored. Default: false
siren:dashboards360:showDashboardDataModelPopup
boolean or null <boolean>

If set to false, this setting disables a Dashboard 360 Data Model pop-up when you hover the cursor over the visualization panel and dashboard icon. Default: true

context:tieBreakerFields
Array of strings or null

A comma-separated list of fields to use for tiebreaking between records that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used. Default: [_doc]

context:step
number or null <integer>

The step size to increment or decrement the context size by Default: 5

context:defaultSize
number or null <integer>

The number of surrounding entries to show in the context view Default: 5

indexPattern:placeholder
string or null <string>

The placeholder for the field 'Index name or pattern' in the 'Settings > Indices' tab. Default: logstash-*

state:storeInSessionStorage
boolean or null <boolean>

Storing of state in url parameters (_a, _k, _g) in session storage. When enabled these parameters hold pointers to the state stored in the session storage. When disabled these parameters store the actual state encoded in rison format. Should be always enabled in a production environment to prevent long URL issues. Default: true

metrics:max_buckets
number or null <integer>

The maximum number of buckets a single datasource can return Default: 2000

notifications:lifetime:info
number or null <integer>

The time in milliseconds which an information notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 5000

notifications:lifetime:warning
number or null <integer>

The time in milliseconds which a warning notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:error
number or null <integer>

The time in milliseconds which an error notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 10000

notifications:lifetime:banner
number or null <integer>

The time in milliseconds which a banner notification will be displayed on-screen for. Setting to 0 will disable the auto-closing. Default: 3000000

notifications:banner
string or null <string>

A custom banner intended for temporary notices to all users. Markdown supported. Default: ''

filterEditor:suggestValues
boolean or null <boolean>

A custom banner intended for temporary notices to all users. Markdown supported. Default: false

filters:pinnedByDefault
boolean or null <boolean>

Whether the filters should have a global state (be pinned) by default Default: false

dashboard:defaultDarkTheme
boolean or null <boolean>

New dashboards use dark theme by default Default: false

timepicker:autoRefreshAllDashboardCount
boolean or null <boolean>

Set to true to auto-refresh the count on all visible dashboards in the Dashboard menu. Default: false

timepicker:refreshIntervalDefaults
string or null <string>

Stringified JSON object The timefilter's default refresh interval Default: { 'display': 'Off', 'pause': false, 'value': 0 }

timepicker:timeDefaults
string or null <string>

Stringified JSON object The timefilter selection to use when Kibana is started without one Default: { 'from': 'now-15m', 'to': 'now', 'mode': 'quick' }

savedObjects:listingLimit
number or null <integer>

Number of objects to fetch for the listing pages Default: 1000

savedObjects:perPage
number or null <integer>

Number of objects to show per page in the load dialog Default: 5

format:currency:defaultPattern
string or null <string>

Default numeral format for the 'currency' format Default: ($0,0.[00])

format:percent:defaultPattern
string or null <string>

Default numeral format for the 'percent' format Default: 0,0.[000]%

format:bytes:defaultPattern
string or null <string>

Default numeral format for the 'bytes' format Default: 0,0.[000]b

format:number:defaultPattern
string or null <string>

Default numeral format for the 'number' format Default: 0,0.[000]

format:defaultTypeMap
string or null <string>

Stringified JSON object Map of the format name to use by default for each field type. 'default' is used if the field type is not mentioned explicitly Default: { 'ip': { 'id': 'ip', 'params': {} }, 'date': { 'id': 'date', 'params': {} }, 'number': { 'id': 'number', 'params': {} }, 'boolean': { 'id': 'boolean', 'params': {} }, '_source': { 'id': '_source', 'params': {} }, 'default': { 'id': 'string', 'params': {} } }

truncate:maxHeight
number or null <integer>

The maximum height that a cell in a table should occupy. Set to 0 to disable truncation Default: 115

shortDots:enable
boolean or null <boolean>

Shorten long fields, for example, instead of foo.bar.baz, show f.b.baz Default: false

history:limit
number or null <integer>

In fields that have history (e.g. query inputs), show this many recent values Default: 10

csv:quoteValues
boolean or null <boolean>

Should values be quoted in csv exports? Default: true

csv:separator
string or null <string>

Separate exported values with this string Default: ,

visualization:dimmingOpacity
number or null <double>

The opacity of the chart items that are dimmed when highlighting another element of the chart. The lower this number, the more the highlighted element will stand out.This must be a number between 0 and 1. Default: 0.5

visualization:loadingDelay
string or null <string>

Time to wait before dimming visualizations during query Default: 2s

visualization:colorMapping
string or null <string>

Stringified JSON object Maps values to specified colors within visualizations Default: {'Count':'#6eadc1'}

visualization:regionmap:showWarnings
boolean or null <boolean>

Whether the region map show a warning when terms cannot be joined to a shape on the map. Default: true

visualization:tileMap:WMSdefaults
string or null <string>

Stringified JSON object Default properties for the WMS map server support in the enhanced coordinate map. The default map will be covered when a Vector Basemap Layers is set up. Default: { 'enabled': false, 'url': 'https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer', 'options': { 'version': '1.3.0', 'layers': '0', 'format': 'image/png', 'transparent': true, 'attribution': 'Maps provided by USGS', 'styles': '' } }

visualization:tileMap:maxPrecision
number or null <integer>

The maximum geoHash precision displayed on tile map aggregation layers: 7 is high, 10 is very high, 12 is the max. Default: 8

histogram:maxBars
number or null <integer>

Never show more than this many bars in date histograms, scale values if needed Default: 100

histogram:barTarget
number or null <integer>

Attempt to generate around this many bars when using 'auto' interval in date histograms Default: 50

fields:popularLimit
number or null <integer>

The top N most popular fields to show Default: 10

courier:sequentialSearches
boolean or null <boolean>

If the batching of search requests is disabled in the courier:batchSearches setting, setting this courier:sequentialSearches option to true ensures that search requests are sent sequentially to reduce the load on a busy cluster. A subsequent search request can start only after the previous one is completed. This can improve overall loading times in Dashboard 360, as subsequent requests take advantage of the Siren Federate cache, but it also dictates that when one request takes a long time to process, the next one is pending until it completes. Default: false

courier:batchSearches
boolean or null <boolean>

This setting batches multiple concurrent search requests into a single request, which can improve overall loading times for dashboards. On the dashboard, the updated visualizations do not appear until the full request is returned. To disable the batching of searches and to send requests individually,set this value to false. Default: true

courier:ignoreFilterIfFieldNotInIndex
boolean or null <boolean>

This configuration enhances support for dashboards containing visualizations accessing dissimilar indexes. When set to false, all filters are applied to all visualizations. When set to true, filter(s) will be ignored for a visualization when the visualization's index does not contain the filtering field. Default: false

courier:maxSegmentCount
number or null <integer>

Requests in discover are split into segments to prevent massive requests from being sent to elasticsearch. This setting attempts to prevent the list of segments from getting too long, which might cause requests to take much longer to process Default: 30

doc_table:highlight
boolean or null <boolean>

Highlight results in Discover and Saved Searches Dashboard.Highlighting makes requests slow when working on big records. Default: true

discover:aggs:terms:size
number or null <integer>

Determines how many terms will be visualized when clicking the 'visualize' button, in the field drop downs, in the discover sidebar. Default: 20

discover:sampleSize
number or null <integer>

The number of rows to show in the Discover page and table Default: 50

metaFields
Array of strings or null

Fields that exist outside of _source to merge into our record when displaying it Default: [_source, _id, _type, _index, _score]

defaultColumns
Array of strings or null

Columns displayed by default in the Discovery tab Default: [_source]

dateFormat:dow
string or null <keyword>
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

What day should weeks start on? Default: Sunday

dateFormat:scaled
string or null <string>

Stringified array - Values that define the format used in situations where timebased data is rendered in order, and formatted timestamps should adapt to the interval between measurements. Keys are ISO8601 intervals. Default: [['', 'HH:mm:ss.SSS'], ['PT1S', 'HH:mm:ss'], ['PT1M', 'HH:mm'], ['PT1H', 'YYYY-MM-DD HH:mm'], ['P1DT', 'YYYY-MM-DD'], ['P1YT', 'YYYY']]

dateFormat:tz
string or null <string>

Which timezone should be used. 'Browser' will use the timezone detected by your browser. Default: Browser

dateFormat
string or null <string>

String for date format Default: MMMM Do YYYY, HH:mm:ss.SSS

sort:options
string or null <string>

Stringified JSON object Options for the Elasticsearch sort parameter Default: { 'unmapped_type': 'boolean' }

query:queryString:options
string or null <string>

Stringified JSON object Options for the lucene query string parser Default: { 'analyze_wildcard': true }

default:highlight
string or null <string>

Sets the default highlight configuration as a JSON object.

inputControlVis:timeout
number or null <integer>

Timeout time for input control visualization query in seconds Default: 5

siren:globalSearchSimpleQuerySyntaxOptions
string or null <string>

Stringified JSON object You can use this setting only when the 'siren:globalSearchQuerySyntax' parameter is set to 'simple_query_string'. For more information about the 'fuzziness' setting, see the Elasticsearch documentation. The accepted formats are 'AUTO:[low],[high]' or the numbers 0, 1 or 2. The 'suffixWildcard' is a boolean setting that determines whether to allow an asterisk '*' at the end of the query when a user enters a search Default: {'fuzziness':'AUTO','suffixWildcard': true}

siren:globalSearchQuerySyntax
string or null <keyword>
Enum: "query_string" "simple_query_string"

This setting dictates the query rules that are used in the global search field. simple_query_string - uses a simple, lenient syntax to parse and split the provided query string into terms based on special operators. It does not trigger errors when there is a problem with the syntax query_string - returns records based on a provided query string, using a parser with a strict syntax. If the syntax is incorrect, a bad request error is triggered Default: simple_query_string

siren:globalSearchTimeout
number or null <integer>

Timeout time for global search query in seconds Default: 30

sentinl:experimental
boolean or null <boolean>

Enable Experimental features in SENTINL Default: false

siren:scripting:notify
boolean or null <boolean>

When enabled errors from scripts are shown on top of the script Default: true

siren:scripting:enabled
boolean or null <boolean>

Enable scripting api Default: false

data-model:max_documents_for_reindex_operations
number or null <integer>

The maximum number of records allowed in reindex based operations. Default: 10000

ingest-xlsx:progress_updation_frequency
number or null <integer>

How often you wish to see the progress bar updated (0 => everytime, 5 => after every 5 requests), frequent updating may reduce the ingestion rate. Default: 5

ingest-xlsx:simultaneous_bulk_requests
number or null <integer>

Tune how many simultaneous bulk requests you wish to send. Default: 1

ingest-xlsx:displayed_rows
number or null <integer>

Number of rows displayed in the preview. Default: 5

ingest-xlsx:bulk_package_size
number or null <integer>

The number of records sent per bulk request. Default: 1000

graph-browser:shortestPathLogLevel
string or null <keyword>
Enum: "Debug" "Info"

The log detail when running Shortest Path / Common Communicator scripts in the Graph Browser. 'Debug' 'Info' Default: Info

property name*
additional property
any
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSidebarGroupAttributes

version
required
number <integer>
Value: 100

SidebarGroups object version

hide
required
boolean <boolean>

Is the sidebar group hidden

iconCss
required
string <string>

Icon of the sidebar group

description
required
string <string>

Description for Sidebar Group

title
required
string <string>

Title for Sidebar Group

{
  • "version": 100,
  • "hide": true,
  • "iconCss": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedSidebarGroupAttributes_

required
object (SavedSidebarGroupAttributes)
version
required
number <integer>
Value: 100

SidebarGroups object version

hide
required
boolean <boolean>

Is the sidebar group hidden

iconCss
required
string <string>

Icon of the sidebar group

description
required
string <string>

Description for Sidebar Group

title
required
string <string>

Title for Sidebar Group

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSidebarGroupPayload

required
object (SavedSidebarGroupAttributes)
version
required
number <integer>
Value: 100

SidebarGroups object version

hide
required
boolean <boolean>

Is the sidebar group hidden

iconCss
required
string <string>

Icon of the sidebar group

description
required
string <string>

Description for Sidebar Group

title
required
string <string>

Title for Sidebar Group

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedRelationalGraphAttributes

version
required
number <integer>
Value: 100

Graph object version

model
required
string <string>

Graph model - Stringified object containing the positions of nodes and the zoom and center position of the graph viewport

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 100,
  • "model": "string",
  • "title": "string"
}

ObjectPayload_SavedRelationalGraphAttributes_

required
object (SavedRelationalGraphAttributes)
version
required
number <integer>
Value: 100

Graph object version

model
required
string <string>

Graph model - Stringified object containing the positions of nodes and the zoom and center position of the graph viewport

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedRelationalGraphPayload

required
object (SavedRelationalGraphAttributes)
version
required
number <integer>
Value: 100

Graph object version

model
required
string <string>

Graph model - Stringified object containing the positions of nodes and the zoom and center position of the graph viewport

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SearchAppScriptsConfigurationV101

required
object
icon
required
string <string>

Icon to display

scriptId
required
string <keyword>

ScriptId

{
  • "ui": {
    },
  • "scriptId": "string"
}

SearchAppColumnEntityConfigurationV101

string or PerspectiveInfoV103 (object)

Cell information of column rendering to use on mobile devices.

Any of
string

Cell information of column rendering to use on mobile devices.

required
string or PerspectiveInfoV103 (object)

Cell information of main column rendering.

Any of
string

Cell information of main column rendering.

searchId
required
string

Id of linked search.

{
  • "mobile": "string",
  • "main": "string",
  • "searchId": "string"
}

SearchAppColumnConfigurationV101

required
Array of objects (SearchAppColumnEntityConfigurationV101)

Column configurations per entity.

Array
string or PerspectiveInfoV103 (object)

Cell information of column rendering to use on mobile devices.

Any of
string

Cell information of column rendering to use on mobile devices.

required
string or PerspectiveInfoV103 (object)

Cell information of main column rendering.

Any of
string

Cell information of main column rendering.

searchId
required
string

Id of linked search.

title
required
string

Column title.

id
required
string

Column id. Must be unique.

{
  • "entities": [
    ],
  • "title": "string",
  • "id": "string"
}

SearchAppConfigurationV101

required
Array of objects (SearchAppColumnConfigurationV101)
Array
required
Array of objects (SearchAppColumnEntityConfigurationV101)

Column configurations per entity.

Array
string or PerspectiveInfoV103 (object)

Cell information of column rendering to use on mobile devices.

required
string or PerspectiveInfoV103 (object)

Cell information of main column rendering.

searchId
required
string

Id of linked search.

title
required
string

Column title.

id
required
string

Column id. Must be unique.

Array of objects (SearchAppScriptsConfigurationV101)
Array
required
object
icon
required
string <string>

Icon to display

scriptId
required
string <keyword>

ScriptId

object

Search preference configurations

showEquivalentResultsByDefault
required
boolean

Show equivalents results by default.

showSearchHighlightsOnMobile
required
boolean

Search highlights column visibility in the mobile mode.

showSearchHighlightsOnDesktop
required
boolean

Search highlights column visibility in the desktop mode.

{
  • "columns": [
    ],
  • "scripts": [
    ],
  • "preferences": {
    },
  • "showSearchHighlightsOnMobile": true,
  • "showSearchHighlightsOnDesktop": true
}

AnyObjectEsType_SearchAppConfigurationV101_

required
Array of objects (SearchAppColumnConfigurationV101)
Array
required
Array of objects (SearchAppColumnEntityConfigurationV101)

Column configurations per entity.

Array
string or PerspectiveInfoV103 (object)

Cell information of column rendering to use on mobile devices.

required
string or PerspectiveInfoV103 (object)

Cell information of main column rendering.

searchId
required
string

Id of linked search.

title
required
string

Column title.

id
required
string

Column id. Must be unique.

Array of objects (SearchAppScriptsConfigurationV101)
Array
required
object
icon
required
string <string>

Icon to display

scriptId
required
string <keyword>

ScriptId

object

Search preference configurations

showEquivalentResultsByDefault
required
boolean

Show equivalents results by default.

showSearchHighlightsOnMobile
required
boolean

Search highlights column visibility in the mobile mode.

showSearchHighlightsOnDesktop
required
boolean

Search highlights column visibility in the desktop mode.

{
  • "columns": [
    ],
  • "scripts": [
    ],
  • "preferences": {
    },
  • "showSearchHighlightsOnMobile": true,
  • "showSearchHighlightsOnDesktop": true
}

SavedSearchAppConfigurationAttributes

version
required
number <integer>
Value: 101

Search app configuration object version.

required
object (AnyObjectEsType_SearchAppConfigurationV101_)
required
Array of objects (SearchAppColumnConfigurationV101)
Array
required
Array of objects (SearchAppColumnEntityConfigurationV101)

Column configurations per entity.

title
required
string

Column title.

id
required
string

Column id. Must be unique.

Array of objects (SearchAppScriptsConfigurationV101)
Array
required
object
scriptId
required
string <keyword>

ScriptId

object

Search preference configurations

showEquivalentResultsByDefault
required
boolean

Show equivalents results by default.

showSearchHighlightsOnMobile
required
boolean

Search highlights column visibility in the mobile mode.

showSearchHighlightsOnDesktop
required
boolean

Search highlights column visibility in the desktop mode.

title
required
string

Title for search app configuration.

{
  • "version": 101,
  • "configuration": {
    },
  • "title": "string"
}

ObjectPayload_SavedSearchAppConfigurationAttributes_

required
object (SavedSearchAppConfigurationAttributes)
version
required
number <integer>
Value: 101

Search app configuration object version.

required
object (AnyObjectEsType_SearchAppConfigurationV101_)
required
Array of objects (SearchAppColumnConfigurationV101)
Array
required
Array of objects (SearchAppColumnEntityConfigurationV101)

Column configurations per entity.

title
required
string

Column title.

id
required
string

Column id. Must be unique.

Array of objects (SearchAppScriptsConfigurationV101)
Array
required
object
scriptId
required
string <keyword>

ScriptId

object

Search preference configurations

showEquivalentResultsByDefault
required
boolean

Show equivalents results by default.

showSearchHighlightsOnMobile
required
boolean

Search highlights column visibility in the mobile mode.

showSearchHighlightsOnDesktop
required
boolean

Search highlights column visibility in the desktop mode.

title
required
string

Title for search app configuration.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSearchAppConfigurationPayload

required
object (SavedSearchAppConfigurationAttributes)
version
required
number <integer>
Value: 101

Search app configuration object version.

required
object (AnyObjectEsType_SearchAppConfigurationV101_)
required
Array of objects (SearchAppColumnConfigurationV101)
Array
required
Array of objects (SearchAppColumnEntityConfigurationV101)

Column configurations per entity.

title
required
string

Column title.

id
required
string

Column id. Must be unique.

Array of objects (SearchAppScriptsConfigurationV101)
Array
required
object
scriptId
required
string <keyword>

ScriptId

object

Search preference configurations

showEquivalentResultsByDefault
required
boolean

Show equivalents results by default.

showSearchHighlightsOnMobile
required
boolean

Search highlights column visibility in the mobile mode.

showSearchHighlightsOnDesktop
required
boolean

Search highlights column visibility in the desktop mode.

title
required
string

Title for search app configuration.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedBookmarkedSearchAttributes

version
required
number <integer>
Value: 102

Bookmarked search object version.

updatedAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

createdAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

Array of objects

List of records filtered by selection in the search the last time it was saved. An empty array means no filtering.

Array
searchId
required
string
_index
required
string
_id
required
string
required
object (AnyObjectEsType_BookmarkedSearchFilterValuesV102_)
entityIds
required
Array of strings

List of entity table ids used in the search.

object (BookmarkedSearchStringRangeV102)
from
string

The start of the range. Dates should use the ISO 8601 format.

to
string

The start of the range. Dates should use the ISO 8601 format.

boostRecent
boolean

Apply boosting of recent documents based on the recencyBoost configuration for Entity tables.

dynamicFilters
object

Filter values associated to specific dynamic filters.

object

Search options.

showEquivalentResults
required
boolean <boolean>

Should equivalent results be shown

inputString
required
string

Search string from the search bar.

required
object (AnyObjectEsType_BookmarkedSearchDefinitionsV102_)
kibiVersion
required
string

Investigate version.

config
required
object

Configuration object.

required
Array of objects (BookmarkedSearchSavedSearchDefinitionV102)

Saved search objects.

Array
id
required
string
required
object (GlobalSearchSettings)
fields
required
object
timeFieldName
string
required
Array of objects (DynamicFilterMapping)
required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV102)

Dynamic filter objects

Array
id
required
string
required
object (DynamicFilterAttributes)
title
required
string

Title for bookmarked search

{
  • "version": 102,
  • "updatedAt": 0,
  • "createdAt": 0,
  • "selectedDMRecordIds": [
    ],
  • "filterValues": {
    },
  • "options": {
    },
  • "inputString": "string",
  • "definitions": {
    },
  • "title": "string"
}

ObjectPayload_SavedBookmarkedSearchAttributes_

required
object (SavedBookmarkedSearchAttributes)
version
required
number <integer>
Value: 102

Bookmarked search object version.

updatedAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

createdAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

Array of objects

List of records filtered by selection in the search the last time it was saved. An empty array means no filtering.

Array
searchId
required
string
_index
required
string
_id
required
string
required
object (AnyObjectEsType_BookmarkedSearchFilterValuesV102_)
entityIds
required
Array of strings

List of entity table ids used in the search.

object (BookmarkedSearchStringRangeV102)
from
string

The start of the range. Dates should use the ISO 8601 format.

to
string

The start of the range. Dates should use the ISO 8601 format.

boostRecent
boolean

Apply boosting of recent documents based on the recencyBoost configuration for Entity tables.

dynamicFilters
object

Filter values associated to specific dynamic filters.

object

Search options.

showEquivalentResults
required
boolean <boolean>

Should equivalent results be shown

inputString
required
string

Search string from the search bar.

required
object (AnyObjectEsType_BookmarkedSearchDefinitionsV102_)
kibiVersion
required
string

Investigate version.

config
required
object

Configuration object.

required
Array of objects (BookmarkedSearchSavedSearchDefinitionV102)

Saved search objects.

Array
id
required
string
required
object (GlobalSearchSettings)
fields
required
object
timeFieldName
string
required
Array of objects (DynamicFilterMapping)
required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV102)

Dynamic filter objects

Array
id
required
string
required
object (DynamicFilterAttributes)
title
required
string

Title for bookmarked search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedBookmarkedSearchPayload

required
object (SavedBookmarkedSearchAttributes)
version
required
number <integer>
Value: 102

Bookmarked search object version.

updatedAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

createdAt
required
number <long> (long)

A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1.

Array of objects

List of records filtered by selection in the search the last time it was saved. An empty array means no filtering.

Array
searchId
required
string
_index
required
string
_id
required
string
required
object (AnyObjectEsType_BookmarkedSearchFilterValuesV102_)
entityIds
required
Array of strings

List of entity table ids used in the search.

object (BookmarkedSearchStringRangeV102)
from
string

The start of the range. Dates should use the ISO 8601 format.

to
string

The start of the range. Dates should use the ISO 8601 format.

boostRecent
boolean

Apply boosting of recent documents based on the recencyBoost configuration for Entity tables.

dynamicFilters
object

Filter values associated to specific dynamic filters.

object

Search options.

showEquivalentResults
required
boolean <boolean>

Should equivalent results be shown

inputString
required
string

Search string from the search bar.

required
object (AnyObjectEsType_BookmarkedSearchDefinitionsV102_)
kibiVersion
required
string

Investigate version.

config
required
object

Configuration object.

required
Array of objects (BookmarkedSearchSavedSearchDefinitionV102)

Saved search objects.

Array
id
required
string
required
object (GlobalSearchSettings)
fields
required
object
timeFieldName
string
required
Array of objects (DynamicFilterMapping)
required
Array of objects (BookmarkedSearchDynamicFilterDefinitionV102)

Dynamic filter objects

Array
id
required
string
required
object (DynamicFilterAttributes)
title
required
string

Title for bookmarked search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

RelationLabelTypeV100

string (RelationLabelTypeV100)
Enum: "label" "field"
"label"

RelationLabelV100

value
required
string <string>

Describes either the label of the relation or the field that represents the label

type
required
string (RelationLabelTypeV100)
Enum: "label" "field"
{
  • "value": "string",
  • "type": "label"
}

PreferredDirectionV100

string (PreferredDirectionV100)
Enum: "direct" "inverse"
"direct"

SavedRecordAsRelationAttributes

version
required
number <integer>
Value: 100

Record as relation object version

preferredDirection
string (PreferredDirectionV100)
Enum: "direct" "inverse"
undirected
required
boolean <boolean>

Disables directional relationship of the record as relation

edgeLabelFromEntity
boolean <boolean>

Enables the default label of entity table to be used as edge label on a graph

required
object (RelationLabelV100)
value
required
string <string>

Describes either the label of the relation or the field that represents the label

type
required
string (RelationLabelTypeV100)
Enum: "label" "field"
required
object (RelationLabelV100)
value
required
string <string>

Describes either the label of the relation or the field that represents the label

type
required
string (RelationLabelTypeV100)
Enum: "label" "field"
outgoingRelationIds
required
Array of strings

Array of relation ids

incomingRelationIds
required
Array of strings

Array of relation ids

inverseOf
required
string <string>

Id of the inverse virtual record as relation

entityId
required
string <string>

Describes the id of the middle entity represented by the record as relation

title
required
string <string>

Title for Relation

{
  • "version": 100,
  • "preferredDirection": "direct",
  • "undirected": true,
  • "edgeLabelFromEntity": true,
  • "inverseLabel": {
    },
  • "directLabel": {
    },
  • "outgoingRelationIds": [
    ],
  • "incomingRelationIds": [
    ],
  • "inverseOf": "string",
  • "entityId": "string",
  • "title": "string"
}

ObjectPayload_SavedRecordAsRelationAttributes_

required
object (SavedRecordAsRelationAttributes)
version
required
number <integer>
Value: 100

Record as relation object version

preferredDirection
string (PreferredDirectionV100)
Enum: "direct" "inverse"
undirected
required
boolean <boolean>

Disables directional relationship of the record as relation

edgeLabelFromEntity
boolean <boolean>

Enables the default label of entity table to be used as edge label on a graph

required
object (RelationLabelV100)
value
required
string <string>

Describes either the label of the relation or the field that represents the label

type
required
string (RelationLabelTypeV100)
Enum: "label" "field"
required
object (RelationLabelV100)
value
required
string <string>

Describes either the label of the relation or the field that represents the label

type
required
string (RelationLabelTypeV100)
Enum: "label" "field"
outgoingRelationIds
required
Array of strings

Array of relation ids

incomingRelationIds
required
Array of strings

Array of relation ids

inverseOf
required
string <string>

Id of the inverse virtual record as relation

entityId
required
string <string>

Describes the id of the middle entity represented by the record as relation

title
required
string <string>

Title for Relation

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedRecordAsRelationPayload

required
object (SavedRecordAsRelationAttributes)
version
required
number <integer>
Value: 100

Record as relation object version

preferredDirection
string (PreferredDirectionV100)
Enum: "direct" "inverse"
undirected
required
boolean <boolean>

Disables directional relationship of the record as relation

edgeLabelFromEntity
boolean <boolean>

Enables the default label of entity table to be used as edge label on a graph

required
object (RelationLabelV100)
value
required
string <string>

Describes either the label of the relation or the field that represents the label

type
required
string (RelationLabelTypeV100)
Enum: "label" "field"
required
object (RelationLabelV100)
value
required
string <string>

Describes either the label of the relation or the field that represents the label

type
required
string (RelationLabelTypeV100)
Enum: "label" "field"
outgoingRelationIds
required
Array of strings

Array of relation ids

incomingRelationIds
required
Array of strings

Array of relation ids

inverseOf
required
string <string>

Id of the inverse virtual record as relation

entityId
required
string <string>

Describes the id of the middle entity represented by the record as relation

title
required
string <string>

Title for Relation

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

AnyPayload

version
string <string>

Version of document stored in Elasticsearch document meta

isGlobal
boolean <boolean>

Is global true/false

options
any
attributes
required
any
{
  • "version": "string",
  • "isGlobal": true,
  • "options": null,
  • "attributes": null
}

ObjectDefinitionPayload

Any of
required
object (SavedSearchAttributes)
version
required
number <integer>
Value: 108

Search object version

compositePrimaryKeyFields
required
Array of strings <keyword> (keyword) [ items <keyword > ]

Array of fields used to construct the key for reconciliation.

required
object
object (ComputedFieldsScriptsV108)
required
Array of objects (ComputedFieldsScriptV108)
required
Array of objects (ComputedFieldV108)
object (ImportSettingsV108)
allowedFields
Array of strings <keyword> (keyword) [ items <keyword > ]

An optional list of fields that imported data can be mapped to. Defaults to all fields.

targetIndex
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

projectImportsEnabled
boolean

Whether the Entity Table is a possible upload target in the Upload center. Defaults to false.

object (EntityResolutionV108)
enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

required
Array of objects (DynamicFilterMappingV108)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

required
object (GlobalSearchSettingsV108)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV108)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV108)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV108)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

Example
{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

ObjectDefinitionType

string (ObjectDefinitionType)
Enum: "search" "eid" "relation" "sirenapiscript" "iconpack" "dataspace"
"search"

deleteResponse

deletedIds
required
Array of strings
acknowledged
required
boolean
{
  • "deletedIds": [
    ],
  • "acknowledged": true
}

ObjectDefinitionType.Config

string (ObjectDefinitionType.Config)
Value: "config"
"config"

dateTimeString

string <date> (dateTimeString)

Format YYYY-MM-DDTHH:mm:ss.SSSZ

"2019-08-24"

SavedGraphAttributesV100

version
required
number <integer>
Value: 100

Graph object version

required
string or dateTimeString (string) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of enity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selection
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 100,
  • "lastSaveTime": "2019-08-24T14:15:22Z",
  • "count": 0,
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV100_

required
object (SavedGraphAttributesV100)
version
required
number <integer>
Value: 100

Graph object version

required
string or dateTimeString (string) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of enity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selection
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedGraphAttributesV101

version
required
number <integer>
Value: 101

Graph object version

required
string or dateTimeString (string) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of enity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selection
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 101,
  • "lastSaveTime": "2019-08-24T14:15:22Z",
  • "count": 0,
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV101_

required
object (SavedGraphAttributesV101)
version
required
number <integer>
Value: 101

Graph object version

required
string or dateTimeString (string) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of enity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selection
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedGraphAttributesV102

version
required
number <integer>
Value: 102

Graph object version

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of enity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selection
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 102,
  • "lastSaveTime": "2019-08-24T14:15:22Z",
  • "count": 0,
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV102_

required
object (SavedGraphAttributesV102)
version
required
number <integer>
Value: 102

Graph object version

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of enity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selection
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedGraphAttributesV103

version
required
number <integer>
Value: 103

Graph object version

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of enity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selection
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 103,
  • "lastSaveTime": "2019-08-24T14:15:22Z",
  • "count": 0,
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV103_

required
object (SavedGraphAttributesV103)
version
required
number <integer>
Value: 103

Graph object version

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of enity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selection
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumns

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumns_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

SavedGraphAttributesV104

version
required
number <integer>
Value: 104

Graph object version

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of enity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumns_)
selection
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 104,
  • "lastSaveTime": 0,
  • "count": 0,
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV104_

required
object (SavedGraphAttributesV104)
version
required
number <integer>
Value: 104

Graph object version

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of enity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumns_)
selection
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedGraphAttributesV105

version
required
number <integer>
Value: 105

Graph object version

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumns_)
selection
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 105,
  • "lastSaveTime": "2019-08-24T14:15:22Z",
  • "count": 0,
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV105_

required
object (SavedGraphAttributesV105)
version
required
number <integer>
Value: 105

Graph object version

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumns_)
selection
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedGraphAttributesV106

version
required
number <integer>
Value: 106

Graph object version

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumns_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 106,
  • "lastSaveTime": "2019-08-24T14:15:22Z",
  • "count": 0,
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV106_

required
object (SavedGraphAttributesV106)
version
required
number <integer>
Value: 106

Graph object version

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumns_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedGraphAttributesV107

version
required
number <integer>
Value: 107

Graph object version

vedgeStyles
required
string <string>

Stringified map containing the styles for the vedges

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumns_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 107,
  • "vedgeStyles": "string",
  • "lastSaveTime": "2019-08-24T14:15:22Z",
  • "count": 0,
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV107_

required
object (SavedGraphAttributesV107)
version
required
number <integer>
Value: 107

Graph object version

vedgeStyles
required
string <string>

Stringified map containing the styles for the vedges

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumns_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV108

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV108_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV108

string (ExpansionLayoutModesV108)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV108_

string (AnyObjectEsType_ExpansionLayoutModesV108_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

TimebarNodeVisibilityModesV108

string (TimebarNodeVisibilityModesV108)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV108_

string (AnyObjectEsType_TimebarNodeVisibilityModesV108_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ToolbarSettingsTypeV108

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV108_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV108_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV108_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV108_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV108_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV108

version
required
number <integer>
Value: 108

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV108_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV108_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV108_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV108_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 108,
  • "toolbarSettings": {
    },
  • "vedgeStyles": "string",
  • "lastSaveTime": "2019-08-24T14:15:22Z",
  • "count": 0,
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV108_

required
object (SavedGraphAttributesV108)
version
required
number <integer>
Value: 108

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV108_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV108_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV108_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV108_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV109

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV109_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV109

string (ExpansionLayoutModesV109)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV109_

string (AnyObjectEsType_ExpansionLayoutModesV109_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

TimebarNodeVisibilityModesV109

string (TimebarNodeVisibilityModesV109)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV109_

string (AnyObjectEsType_TimebarNodeVisibilityModesV109_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ToolbarSettingsTypeV109

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV109_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV109_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV109_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV109_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV109_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV109

version
required
number <integer>
Value: 109

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV109_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV109_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV109_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV109_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 109,
  • "toolbarSettings": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": "2019-08-24T14:15:22Z",
  • "count": 0,
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV109_

required
object (SavedGraphAttributesV109)
version
required
number <integer>
Value: 109

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV109_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV109_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV109_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV109_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV110

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV110_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV110

string (ExpansionLayoutModesV110)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV110_

string (AnyObjectEsType_ExpansionLayoutModesV110_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

TimebarNodeVisibilityModesV110

string (TimebarNodeVisibilityModesV110)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV110_

string (AnyObjectEsType_TimebarNodeVisibilityModesV110_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ToolbarSettingsTypeV110

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV110_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV110_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV110_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV110_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV110_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV110

version
required
number <integer>
Value: 110

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV110_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV110_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV110_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV110_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 110,
  • "toolbarSettings": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": "2019-08-24T14:15:22Z",
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV110_

required
object (SavedGraphAttributesV110)
version
required
number <integer>
Value: 110

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV110_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV110_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV110_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
string or integer (number) <date>

Create date of url

Any of
string <date>

Create date of url

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV110_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV111

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV111_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV111

string (ExpansionLayoutModesV111)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV111_

string (AnyObjectEsType_ExpansionLayoutModesV111_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

TimebarNodeVisibilityModesV111

string (TimebarNodeVisibilityModesV111)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV111_

string (AnyObjectEsType_TimebarNodeVisibilityModesV111_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ToolbarSettingsTypeV111

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV111_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV111_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV111_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV111_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV111_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV111

version
required
number <integer>
Value: 111

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV111_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV111_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV111_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV111_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 111,
  • "toolbarSettings": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV111_

required
object (SavedGraphAttributesV111)
version
required
number <integer>
Value: 111

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV111_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV111_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV111_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV111_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV112

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV112_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV112

string (ExpansionLayoutModesV112)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV112_

string (AnyObjectEsType_ExpansionLayoutModesV112_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

TimebarNodeVisibilityModesV112

string (TimebarNodeVisibilityModesV112)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV112_

string (AnyObjectEsType_TimebarNodeVisibilityModesV112_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ToolbarSettingsTypeV112

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV112_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV112_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV112_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV112_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV112_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV112

version
required
number <integer>
Value: 112

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV112_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV112_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV112_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV112_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 112,
  • "toolbarSettings": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV112_

required
object (SavedGraphAttributesV112)
version
required
number <integer>
Value: 112

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV112_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlightConnectedNodes
required
boolean <boolean>

highlight connected nodes on graph visualize

required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV112_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV112_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV112_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV113

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV113_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV113

string (ExpansionLayoutModesV113)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV113_

string (AnyObjectEsType_ExpansionLayoutModesV113_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

TimebarNodeVisibilityModesV113

string (TimebarNodeVisibilityModesV113)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV113_

string (AnyObjectEsType_TimebarNodeVisibilityModesV113_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ItemsHighlightModesV113

string (ItemsHighlightModesV113)
Enum: "no" "selected" "selectedAndConnected"
"no"

AnyObjectEsType_ItemsHighlightModesV113_

string (AnyObjectEsType_ItemsHighlightModesV113_)
Enum: "no" "selected" "selectedAndConnected"
"no"

ToolbarSettingsTypeV113

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV113_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV113_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV113_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV113_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV113_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV113_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV113_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV113

version
required
number <integer>
Value: 113

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV113_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV113_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV113_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV113_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV113_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 113,
  • "toolbarSettings": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV113_

required
object (SavedGraphAttributesV113)
version
required
number <integer>
Value: 113

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV113_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV113_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV113_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV113_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV113_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV114

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV114_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV114

string (ExpansionLayoutModesV114)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV114_

string (AnyObjectEsType_ExpansionLayoutModesV114_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

MapNodeVisibilityModesV114

string (MapNodeVisibilityModesV114)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

AnyObjectEsType_MapNodeVisibilityModesV114_

string (AnyObjectEsType_MapNodeVisibilityModesV114_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

TimebarNodeVisibilityModesV114

string (TimebarNodeVisibilityModesV114)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV114_

string (AnyObjectEsType_TimebarNodeVisibilityModesV114_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ItemsHighlightModesV114

string (ItemsHighlightModesV114)
Enum: "no" "selected" "selectedAndConnected"
"no"

AnyObjectEsType_ItemsHighlightModesV114_

string (AnyObjectEsType_ItemsHighlightModesV114_)
Enum: "no" "selected" "selectedAndConnected"
"no"

ToolbarSettingsTypeV114

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV114_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV114_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV114_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV114_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV114_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV114_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV114_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV114_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV114_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV114

version
required
number <integer>
Value: 114

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV114_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV114_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV114_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV114_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV114_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV114_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 114,
  • "toolbarSettings": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV114_

required
object (SavedGraphAttributesV114)
version
required
number <integer>
Value: 114

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV114_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV114_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV114_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV114_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV114_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV114_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV115

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV115_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV115

string (ExpansionLayoutModesV115)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV115_

string (AnyObjectEsType_ExpansionLayoutModesV115_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

SelectionSettingsV115

string (SelectionSettingsV115)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

AnyObjectEsType_SelectionSettingsV115_

string (AnyObjectEsType_SelectionSettingsV115_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

MapNodeVisibilityModesV115

string (MapNodeVisibilityModesV115)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

AnyObjectEsType_MapNodeVisibilityModesV115_

string (AnyObjectEsType_MapNodeVisibilityModesV115_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

TimebarNodeVisibilityModesV115

string (TimebarNodeVisibilityModesV115)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV115_

string (AnyObjectEsType_TimebarNodeVisibilityModesV115_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ItemsHighlightModesV115

string (ItemsHighlightModesV115)
Enum: "no" "selected" "selectedAndConnected"
"no"

AnyObjectEsType_ItemsHighlightModesV115_

string (AnyObjectEsType_ItemsHighlightModesV115_)
Enum: "no" "selected" "selectedAndConnected"
"no"

ToolbarSettingsTypeV115

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV115_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV115_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV115_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV115_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV115_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV115_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV115_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV115_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV115_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV115_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV115_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV115

version
required
number <integer>
Value: 115

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV115_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV115_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV115_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV115_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV115_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV115_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV115_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 115,
  • "toolbarSettings": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV115_

required
object (SavedGraphAttributesV115)
version
required
number <integer>
Value: 115

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV115_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV115_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV115_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV115_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV115_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV115_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV115_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string <string>

Stringified Map of the graph's nodes, edges and combos

description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV116

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV116_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV116

string (ExpansionLayoutModesV116)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV116_

string (AnyObjectEsType_ExpansionLayoutModesV116_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

SelectionSettingsV116

string (SelectionSettingsV116)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

AnyObjectEsType_SelectionSettingsV116_

string (AnyObjectEsType_SelectionSettingsV116_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

MapNodeVisibilityModesV116

string (MapNodeVisibilityModesV116)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

AnyObjectEsType_MapNodeVisibilityModesV116_

string (AnyObjectEsType_MapNodeVisibilityModesV116_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

TimebarNodeVisibilityModesV116

string (TimebarNodeVisibilityModesV116)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV116_

string (AnyObjectEsType_TimebarNodeVisibilityModesV116_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ItemsHighlightModesV116

string (ItemsHighlightModesV116)
Enum: "no" "selected" "selectedAndConnected"
"no"

AnyObjectEsType_ItemsHighlightModesV116_

string (AnyObjectEsType_ItemsHighlightModesV116_)
Enum: "no" "selected" "selectedAndConnected"
"no"

ToolbarSettingsTypeV116

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV116_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV116_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV116_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV116_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV116_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV116_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV116_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV116_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV116_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV116_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV116_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV116

version
required
number <integer>
Value: 116

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV116_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV116_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV116_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV116_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV116_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV116_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV116_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 116,
  • "toolbarSettings": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV116_

required
object (SavedGraphAttributesV116)
version
required
number <integer>
Value: 116

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV116_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV116_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV116_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV116_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV116_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV116_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV116_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV117

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV117_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV117

string (ExpansionLayoutModesV117)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV117_

string (AnyObjectEsType_ExpansionLayoutModesV117_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

SelectionSettingsV117

string (SelectionSettingsV117)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

AnyObjectEsType_SelectionSettingsV117_

string (AnyObjectEsType_SelectionSettingsV117_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

MapNodeVisibilityModesV117

string (MapNodeVisibilityModesV117)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

AnyObjectEsType_MapNodeVisibilityModesV117_

string (AnyObjectEsType_MapNodeVisibilityModesV117_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

TimebarNodeVisibilityModesV117

string (TimebarNodeVisibilityModesV117)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV117_

string (AnyObjectEsType_TimebarNodeVisibilityModesV117_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ItemsHighlightModesV117

string (ItemsHighlightModesV117)
Enum: "no" "selected" "selectedAndConnected"
"no"

AnyObjectEsType_ItemsHighlightModesV117_

string (AnyObjectEsType_ItemsHighlightModesV117_)
Enum: "no" "selected" "selectedAndConnected"
"no"

ToolbarSettingsTypeV117

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV117_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV117_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV117_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV117_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV117_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV117_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV117_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV117_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV117_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV117_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV117_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV117

version
required
number <integer>
Value: 117

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV117_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV117_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV117_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV117_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV117_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV117_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV117_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 117,
  • "toolbarSettings": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV117_

required
object (SavedGraphAttributesV117)
version
required
number <integer>
Value: 117

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV117_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV117_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV117_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV117_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV117_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV117_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV117_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV118

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV118_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV118

string (ExpansionLayoutModesV118)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV118_

string (AnyObjectEsType_ExpansionLayoutModesV118_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

SelectionSettingsV118

string (SelectionSettingsV118)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

AnyObjectEsType_SelectionSettingsV118_

string (AnyObjectEsType_SelectionSettingsV118_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

MapNodeVisibilityModesV118

string (MapNodeVisibilityModesV118)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

AnyObjectEsType_MapNodeVisibilityModesV118_

string (AnyObjectEsType_MapNodeVisibilityModesV118_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

TimebarNodeVisibilityModesV118

string (TimebarNodeVisibilityModesV118)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV118_

string (AnyObjectEsType_TimebarNodeVisibilityModesV118_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ItemsHighlightModesV118

string (ItemsHighlightModesV118)
Enum: "no" "selected" "selectedAndConnected"
"no"

AnyObjectEsType_ItemsHighlightModesV118_

string (AnyObjectEsType_ItemsHighlightModesV118_)
Enum: "no" "selected" "selectedAndConnected"
"no"

ToolbarSettingsTypeV118

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV118_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV118_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV118_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV118_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV118_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV118_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV118_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV118_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV118_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV118_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV118_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV118

version
required
number <integer>
Value: 118

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV118_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV118_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV118_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV118_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV118_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV118_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV118_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 118,
  • "toolbarSettings": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV118_

required
object (SavedGraphAttributesV118)
version
required
number <integer>
Value: 118

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV118_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV118_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV118_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV118_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV118_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV118_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV118_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV119

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV119_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV119

string (ExpansionLayoutModesV119)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV119_

string (AnyObjectEsType_ExpansionLayoutModesV119_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

SelectionSettingsV119

string (SelectionSettingsV119)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

AnyObjectEsType_SelectionSettingsV119_

string (AnyObjectEsType_SelectionSettingsV119_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

MapNodeVisibilityModesV119

string (MapNodeVisibilityModesV119)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

AnyObjectEsType_MapNodeVisibilityModesV119_

string (AnyObjectEsType_MapNodeVisibilityModesV119_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

TimebarNodeVisibilityModesV119

string (TimebarNodeVisibilityModesV119)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV119_

string (AnyObjectEsType_TimebarNodeVisibilityModesV119_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ItemsHighlightModesV119

string (ItemsHighlightModesV119)
Enum: "no" "selected" "selectedAndConnected"
"no"

AnyObjectEsType_ItemsHighlightModesV119_

string (AnyObjectEsType_ItemsHighlightModesV119_)
Enum: "no" "selected" "selectedAndConnected"
"no"

ToolbarSettingsTypeV119

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV119_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV119_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV119_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV119_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV119_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV119_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV119_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV119_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV119_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV119_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV119_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV119

version
required
number <integer>
Value: 119

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV119_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV119_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV119_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV119_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV119_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV119_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV119_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 119,
  • "toolbarSettings": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "nodesCount": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV119_

required
object (SavedGraphAttributesV119)
version
required
number <integer>
Value: 119

Graph object version

required
object (AnyObjectEsType_ToolbarSettingsTypeV119_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV119_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV119_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV119_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV119_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV119_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV119_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV120

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV120_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV120

string (ExpansionLayoutModesV120)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV120_

string (AnyObjectEsType_ExpansionLayoutModesV120_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

SelectionSettingsV120

string (SelectionSettingsV120)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

AnyObjectEsType_SelectionSettingsV120_

string (AnyObjectEsType_SelectionSettingsV120_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

MapNodeVisibilityModesV120

string (MapNodeVisibilityModesV120)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

AnyObjectEsType_MapNodeVisibilityModesV120_

string (AnyObjectEsType_MapNodeVisibilityModesV120_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

TimebarNodeVisibilityModesV120

string (TimebarNodeVisibilityModesV120)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV120_

string (AnyObjectEsType_TimebarNodeVisibilityModesV120_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ItemsHighlightModesV120

string (ItemsHighlightModesV120)
Enum: "no" "selected" "selectedAndConnected"
"no"

AnyObjectEsType_ItemsHighlightModesV120_

string (AnyObjectEsType_ItemsHighlightModesV120_)
Enum: "no" "selected" "selectedAndConnected"
"no"

ToolbarSettingsTypeV120

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV120_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV120_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV120_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV120_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV120_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV120_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV120_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV120_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV120_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV120_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV120_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV120

version
required
number <integer>
Value: 120

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV120. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV120_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV120_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV120_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV120_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV120_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV120_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV120_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 120,
  • "visualizerHash": "string",
  • "toolbarSettings": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "nodesCount": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV120_

required
object (SavedGraphAttributesV120)
version
required
number <integer>
Value: 120

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV120. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV120_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV120_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV120_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV120_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV120_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV120_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV120_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV122

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV122_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV122

string (ExpansionLayoutModesV122)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV122_

string (AnyObjectEsType_ExpansionLayoutModesV122_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

SelectionSettingsV122

string (SelectionSettingsV122)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

AnyObjectEsType_SelectionSettingsV122_

string (AnyObjectEsType_SelectionSettingsV122_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

MapNodeVisibilityModesV122

string (MapNodeVisibilityModesV122)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

AnyObjectEsType_MapNodeVisibilityModesV122_

string (AnyObjectEsType_MapNodeVisibilityModesV122_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

PersistedLayerTypeV122

string (PersistedLayerTypeV122)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
"wfs"

MapLayerV122

type
required
string (PersistedLayerTypeV122)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "type": "wfs",
  • "enabled": true,
  • "id": "string"
}

TimebarNodeVisibilityModesV122

string (TimebarNodeVisibilityModesV122)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV122_

string (AnyObjectEsType_TimebarNodeVisibilityModesV122_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ItemsHighlightModesV122

string (ItemsHighlightModesV122)
Enum: "no" "selected" "selectedAndConnected"
"no"

AnyObjectEsType_ItemsHighlightModesV122_

string (AnyObjectEsType_ItemsHighlightModesV122_)
Enum: "no" "selected" "selectedAndConnected"
"no"

ToolbarSettingsTypeV122

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV122_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV122_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV122)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV122)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV122_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV122_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV122_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV122_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV122_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV122_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV122)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV122)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV122_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV122_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV122_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV122

version
required
number <integer>
Value: 122

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV122. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV122_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV122_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV122_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV122)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV122)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV122_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV122_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV122_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
required
object
searchSourceJSON
required
string <string>

Stringified JSON object

vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV122_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 122,
  • "visualizerHash": "string",
  • "toolbarSettings": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "nodesCount": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV122_

required
object (SavedGraphAttributesV122)
version
required
number <integer>
Value: 122

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV122. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV122_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV122_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV122_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV122)

map overlays and base layers

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV122_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV122_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV122_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
required
object
searchSourceJSON
required
string <string>

Stringified JSON object

vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV122_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedI2ExportConfigAttributesV100

version
required
number <integer>
Value: 100

I2 export config object version

json
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 100,
  • "json": "string"
}

ObjectPayload_SavedI2ExportConfigAttributesV100_

required
object (SavedI2ExportConfigAttributesV100)
version
required
number <integer>
Value: 100

I2 export config object version

json
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedIconpackAttributesV100

version
required
number <integer>
Value: 100

Iconpack object version

prefix
required
string <string>

A unique value per icon pack which is used on CSS classes to display icon.

woff2
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

woff
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

ttf
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

svg
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

eot
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

icon_names
required
Array of strings

A list of icons presented on the icon pack

unicodes
string <string>

Icons' unicodes stored as a string which are used on graph browser in JSON format

font_family
string <string>

Name of font family for icon pack

css
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

name
required
string <string>

Name of iconpack

{
  • "version": 100,
  • "prefix": "string",
  • "woff2": "string",
  • "woff": "string",
  • "ttf": "string",
  • "svg": "string",
  • "eot": "string",
  • "icon_names": [
    ],
  • "unicodes": "string",
  • "font_family": "string",
  • "css": "string",
  • "name": "string"
}

ObjectPayload_SavedIconpackAttributesV100_

required
object (SavedIconpackAttributesV100)
version
required
number <integer>
Value: 100

Iconpack object version

prefix
required
string <string>

A unique value per icon pack which is used on CSS classes to display icon.

woff2
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

woff
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

ttf
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

svg
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

eot
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

icon_names
required
Array of strings

A list of icons presented on the icon pack

unicodes
string <string>

Icons' unicodes stored as a string which are used on graph browser in JSON format

font_family
string <string>

Name of font family for icon pack

css
required
string <Base64> (Base64)

A binary-to-text encoding schema that represents binary data in an ASCII string format.

name
required
string <string>

Name of iconpack

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedRecordAsRelationAttributesV100

version
required
number <integer>
Value: 100

Record as relation object version

preferredDirection
string (PreferredDirectionV100)
Enum: "direct" "inverse"
undirected
required
boolean <boolean>

Disables directional relationship of the record as relation

edgeLabelFromEntity
boolean <boolean>

Enables the default label of entity table to be used as edge label on a graph

required
object (RelationLabelV100)
value
required
string <string>

Describes either the label of the relation or the field that represents the label

type
required
string (RelationLabelTypeV100)
Enum: "label" "field"
required
object (RelationLabelV100)
value
required
string <string>

Describes either the label of the relation or the field that represents the label

type
required
string (RelationLabelTypeV100)
Enum: "label" "field"
outgoingRelationIds
required
Array of strings

Array of relation ids

incomingRelationIds
required
Array of strings

Array of relation ids

inverseOf
required
string <string>

Id of the inverse virtual record as relation

entityId
required
string <string>

Describes the id of the middle entity represented by the record as relation

title
required
string <string>

Title for Relation

{
  • "version": 100,
  • "preferredDirection": "direct",
  • "undirected": true,
  • "edgeLabelFromEntity": true,
  • "inverseLabel": {
    },
  • "directLabel": {
    },
  • "outgoingRelationIds": [
    ],
  • "incomingRelationIds": [
    ],
  • "inverseOf": "string",
  • "entityId": "string",
  • "title": "string"
}

ObjectPayload_SavedRecordAsRelationAttributesV100_

required
object (SavedRecordAsRelationAttributesV100)
version
required
number <integer>
Value: 100

Record as relation object version

preferredDirection
string (PreferredDirectionV100)
Enum: "direct" "inverse"
undirected
required
boolean <boolean>

Disables directional relationship of the record as relation

edgeLabelFromEntity
boolean <boolean>

Enables the default label of entity table to be used as edge label on a graph

required
object (RelationLabelV100)
value
required
string <string>

Describes either the label of the relation or the field that represents the label

type
required
string (RelationLabelTypeV100)
Enum: "label" "field"
required
object (RelationLabelV100)
value
required
string <string>

Describes either the label of the relation or the field that represents the label

type
required
string (RelationLabelTypeV100)
Enum: "label" "field"
outgoingRelationIds
required
Array of strings

Array of relation ids

incomingRelationIds
required
Array of strings

Array of relation ids

inverseOf
required
string <string>

Id of the inverse virtual record as relation

entityId
required
string <string>

Describes the id of the middle entity represented by the record as relation

title
required
string <string>

Title for Relation

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedRelationAttributesV100

preferredDirection
string (PreferredDirectionV100)
Enum: "direct" "inverse"
version
required
number <integer>
Value: 100

Relation object version

countEnabled
required
boolean <boolean>

Enables counts on relational button

undirected
required
boolean <boolean>

Describes if the directional relationship of the relation

timeout
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

joinType
required
string <string>

Join algorithm provided by Siren Federate

rangeField
string <string>

Range field set for relation

rangeId
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.

domainField
string <string>

Domain field set for relation

domainId
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.

inverseLabel
required
string <string>

Inverse Relational label for relation

inverseOf
required
string <string>

Relation will be the inverse of another

title
required
string <string>

Title for Relation

directLabel
required
string <string>

Direct label set for relation

{
  • "preferredDirection": "direct",
  • "version": 100,
  • "countEnabled": true,
  • "undirected": true,
  • "timeout": 0,
  • "joinType": "string",
  • "rangeField": "string",
  • "rangeId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "domainField": "string",
  • "domainId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "inverseLabel": "string",
  • "inverseOf": "string",
  • "title": "string",
  • "directLabel": "string"
}

ObjectPayload_SavedRelationAttributesV100_

required
object (SavedRelationAttributesV100)
preferredDirection
string (PreferredDirectionV100)
Enum: "direct" "inverse"
version
required
number <integer>
Value: 100

Relation object version

countEnabled
required
boolean <boolean>

Enables counts on relational button

undirected
required
boolean <boolean>

Describes if the directional relationship of the relation

timeout
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

joinType
required
string <string>

Join algorithm provided by Siren Federate

rangeField
string <string>

Range field set for relation

rangeId
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.

domainField
string <string>

Domain field set for relation

domainId
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.

inverseLabel
required
string <string>

Inverse Relational label for relation

inverseOf
required
string <string>

Relation will be the inverse of another

title
required
string <string>

Title for Relation

directLabel
required
string <string>

Direct label set for relation

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

RelationConditionV101

operator
required
string
Enum: "eq" "lt" "gt" "lte" "gte" "within" "intersects" "contains"

Join condition operator

rangeField
string <string>

Range field set for relation

domainField
string <string>

Domain field set for relation

clause
required
string
Value: "must"
{
  • "operator": "eq",
  • "rangeField": "string",
  • "domainField": "string",
  • "clause": "must"
}

PreferredDirectionV101

string (PreferredDirectionV101)
Enum: "direct" "inverse"
"direct"

SavedRelationAttributesV101

preferredDirection
string (PreferredDirectionV101)
Enum: "direct" "inverse"
version
required
number <integer>
Value: 101

Relation object version

countEnabled
required
boolean <boolean>

Enables counts on relational button

undirected
required
boolean <boolean>

Describes if the directional relationship of the relation

timeout
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

joinType
required
string <string>

Join algorithm provided by Siren Federate

rangeField
string <string>

Range field set for relation

rangeId
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.

domainField
string <string>

Domain field set for relation

domainId
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.

inverseLabel
required
string <string>

Inverse Relational label for relation

inverseOf
required
string <string>

Relation will be the inverse of another

title
required
string <string>

Title for Relation

directLabel
required
string <string>

Direct label set for relation

required
Array of objects (RelationConditionV101)

Array with relation must conditions

Array
operator
required
string
Enum: "eq" "lt" "gt" "lte" "gte" "within" "intersects" "contains"

Join condition operator

rangeField
string <string>

Range field set for relation

domainField
string <string>

Domain field set for relation

clause
required
string
Value: "must"
{
  • "preferredDirection": "direct",
  • "version": 101,
  • "countEnabled": true,
  • "undirected": true,
  • "timeout": 0,
  • "joinType": "string",
  • "rangeField": "string",
  • "rangeId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "domainField": "string",
  • "domainId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "inverseLabel": "string",
  • "inverseOf": "string",
  • "title": "string",
  • "directLabel": "string",
  • "conditions": [
    ]
}

ObjectPayload_SavedRelationAttributesV101_

required
object (SavedRelationAttributesV101)
preferredDirection
string (PreferredDirectionV101)
Enum: "direct" "inverse"
version
required
number <integer>
Value: 101

Relation object version

countEnabled
required
boolean <boolean>

Enables counts on relational button

undirected
required
boolean <boolean>

Describes if the directional relationship of the relation

timeout
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

joinType
required
string <string>

Join algorithm provided by Siren Federate

rangeField
string <string>

Range field set for relation

rangeId
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.

domainField
string <string>

Domain field set for relation

domainId
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.

inverseLabel
required
string <string>

Inverse Relational label for relation

inverseOf
required
string <string>

Relation will be the inverse of another

title
required
string <string>

Title for Relation

directLabel
required
string <string>

Direct label set for relation

required
Array of objects (RelationConditionV101)

Array with relation must conditions

Array
operator
required
string
Enum: "eq" "lt" "gt" "lte" "gte" "within" "intersects" "contains"

Join condition operator

rangeField
string <string>

Range field set for relation

domainField
string <string>

Domain field set for relation

clause
required
string
Value: "must"
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

RelationConditionV102

operator
required
string
Enum: "eq" "lt" "gt" "lte" "gte" "within" "intersects" "contains"

Join condition operator

rangeField
string <string>

Range field set for relation

domainField
string <string>

Domain field set for relation

clause
required
string
Value: "must"
{
  • "operator": "eq",
  • "rangeField": "string",
  • "domainField": "string",
  • "clause": "must"
}

PreferredDirectionV102

string (PreferredDirectionV102)
Enum: "direct" "inverse"
"direct"

SavedRelationAttributesV102

preferredDirection
string (PreferredDirectionV102)
Enum: "direct" "inverse"
version
required
number <integer>
Value: 102

Relation object version

hidden
required
boolean <boolean>

Describes if the relation should be hidden

countEnabled
required
boolean <boolean>

Enables counts on relational button

undirected
required
boolean <boolean>

Describes if the directional relationship of the relation

timeout
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

joinType
required
string <string>

Join algorithm provided by Siren Federate

rangeField
string <string>

Range field set for relation

rangeId
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.

domainField
string <string>

Domain field set for relation

domainId
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.

inverseLabel
required
string <string>

Inverse Relational label for relation

inverseOf
required
string <string>

Relation will be the inverse of another

title
required
string <string>

Title for Relation

directLabel
required
string <string>

Direct label set for relation

required
Array of objects (RelationConditionV102)

Array with relation must conditions

Array
operator
required
string
Enum: "eq" "lt" "gt" "lte" "gte" "within" "intersects" "contains"

Join condition operator

rangeField
string <string>

Range field set for relation

domainField
string <string>

Domain field set for relation

clause
required
string
Value: "must"
{
  • "preferredDirection": "direct",
  • "version": 102,
  • "hidden": true,
  • "countEnabled": true,
  • "undirected": true,
  • "timeout": 0,
  • "joinType": "string",
  • "rangeField": "string",
  • "rangeId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "domainField": "string",
  • "domainId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "inverseLabel": "string",
  • "inverseOf": "string",
  • "title": "string",
  • "directLabel": "string",
  • "conditions": [
    ]
}

ObjectPayload_SavedRelationAttributesV102_

required
object (SavedRelationAttributesV102)
preferredDirection
string (PreferredDirectionV102)
Enum: "direct" "inverse"
version
required
number <integer>
Value: 102

Relation object version

hidden
required
boolean <boolean>

Describes if the relation should be hidden

countEnabled
required
boolean <boolean>

Enables counts on relational button

undirected
required
boolean <boolean>

Describes if the directional relationship of the relation

timeout
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

joinType
required
string <string>

Join algorithm provided by Siren Federate

rangeField
string <string>

Range field set for relation

rangeId
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.

domainField
string <string>

Domain field set for relation

domainId
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.

inverseLabel
required
string <string>

Inverse Relational label for relation

inverseOf
required
string <string>

Relation will be the inverse of another

title
required
string <string>

Title for Relation

directLabel
required
string <string>

Direct label set for relation

required
Array of objects (RelationConditionV102)

Array with relation must conditions

Array
operator
required
string
Enum: "eq" "lt" "gt" "lte" "gte" "within" "intersects" "contains"

Join condition operator

rangeField
string <string>

Range field set for relation

domainField
string <string>

Domain field set for relation

clause
required
string
Value: "must"
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedRelationAttributesV103

entityResolutionTypes
Array of strings <keyword> (keyword) [ items <keyword > ]

Entity resolution types

preferredDirection
string (PreferredDirectionV103)
Enum: "direct" "inverse"
version
required
number <integer>
Value: 103

Relation object version

hidden
required
boolean <boolean>

Describes if the relation should be hidden

countEnabled
required
boolean <boolean>

Enables counts on relational button

undirected
required
boolean <boolean>

Describes if the directional relationship of the relation

timeout
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

joinType
required
string <string>

Join algorithm provided by Siren Federate

rangeField
string <string>

Range field set for relation

rangeId
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.

domainField
string <string>

Domain field set for relation

domainId
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.

inverseLabel
required
string <string>

Inverse Relational label for relation

inverseOf
required
string <string>

Relation will be the inverse of another

title
required
string <string>

Title for Relation

directLabel
required
string <string>

Direct label set for relation

required
Array of objects (RelationConditionV103)

Array with relation must conditions

Array
allowMissingBound
string (RelationAllowMissingBoundV103)
Enum: "left" "right" "both" "none"
operator
required
string (RelationOperatorV103)
Enum: "eq" "lt" "gt" "lte" "gte" "within" "intersects" "contains"
rangeField
string <keyword>

Range field set for relation

domainField
string <keyword>

Domain field set for relation

clause
required
string
Value: "must"
{
  • "entityResolutionTypes": [
    ],
  • "preferredDirection": "direct",
  • "version": 103,
  • "hidden": true,
  • "countEnabled": true,
  • "undirected": true,
  • "timeout": 0,
  • "joinType": "string",
  • "rangeField": "string",
  • "rangeId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "domainField": "string",
  • "domainId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "inverseLabel": "string",
  • "inverseOf": "string",
  • "title": "string",
  • "directLabel": "string",
  • "conditions": [
    ]
}

ObjectPayload_SavedRelationAttributesV103_

required
object (SavedRelationAttributesV103)
entityResolutionTypes
Array of strings <keyword> (keyword) [ items <keyword > ]

Entity resolution types

preferredDirection
string (PreferredDirectionV103)
Enum: "direct" "inverse"
version
required
number <integer>
Value: 103

Relation object version

hidden
required
boolean <boolean>

Describes if the relation should be hidden

countEnabled
required
boolean <boolean>

Enables counts on relational button

undirected
required
boolean <boolean>

Describes if the directional relationship of the relation

timeout
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

joinType
required
string <string>

Join algorithm provided by Siren Federate

rangeField
string <string>

Range field set for relation

rangeId
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.

domainField
string <string>

Domain field set for relation

domainId
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.

inverseLabel
required
string <string>

Inverse Relational label for relation

inverseOf
required
string <string>

Relation will be the inverse of another

title
required
string <string>

Title for Relation

directLabel
required
string <string>

Direct label set for relation

required
Array of objects (RelationConditionV103)

Array with relation must conditions

Array
allowMissingBound
string (RelationAllowMissingBoundV103)
Enum: "left" "right" "both" "none"
operator
required
string (RelationOperatorV103)
Enum: "eq" "lt" "gt" "lte" "gte" "within" "intersects" "contains"
rangeField
string <keyword>

Range field set for relation

domainField
string <keyword>

Domain field set for relation

clause
required
string
Value: "must"
isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedRelationalGraphAttributesV100

version
required
number <integer>
Value: 100

Graph object version

model
required
string <string>

Graph model - Stringified object containing the positions of nodes and the zoom and center position of the graph viewport

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 100,
  • "model": "string",
  • "title": "string"
}

ObjectPayload_SavedRelationalGraphAttributesV100_

required
object (SavedRelationalGraphAttributesV100)
version
required
number <integer>
Value: 100

Graph object version

model
required
string <string>

Graph model - Stringified object containing the positions of nodes and the zoom and center position of the graph viewport

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedScriptAttributesV100

version
required
number <integer>
Value: 100

Script object version

object
searchSourceJSON
required
string <string>

Stringified JSON object

scriptSource
required
string <string>

Script type

type
required
string <string>

Script type

description
string <string>

An optional description for script

title
required
string <string>

Title for script

{
  • "version": 100,
  • "kibanaSavedObjectMeta": {
    },
  • "scriptSource": "string",
  • "type": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedScriptAttributesV100_

required
object (SavedScriptAttributesV100)
version
required
number <integer>
Value: 100

Script object version

object
searchSourceJSON
required
string <string>

Stringified JSON object

scriptSource
required
string <string>

Script type

type
required
string <string>

Script type

description
string <string>

An optional description for script

title
required
string <string>

Title for script

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

IndexPatternAttributesV100

error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

{
  • "error": null,
  • "fieldFormatMap": "string",
  • "excludeIndices": true,
  • "sourceFilters": "string",
  • "fields": "string",
  • "intervalName": "string",
  • "timeFieldName": "string",
  • "pattern": "string"
}

EditableFieldsModeV100

string (EditableFieldsModeV100)
Enum: "whitelist" "blacklist"
"whitelist"

IndexingScopeStringV100

string (IndexingScopeStringV100)
Enum: "G:S" "G:NS" "L" "N"
"G:S"

RevisionSettingsV100

copyToFields
object
indexingScope
required
string (IndexingScopeStringV100)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

filteringMode
string <keyword>
Value: "filter-by-index-join"

Filtering mode; Eg: 'filter-by-index-join'

editableFieldsMode
required
string (EditableFieldsModeV100)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "copyToFields": {
    },
  • "indexingScope": "G:S",
  • "editableFieldsExceptions": [
    ],
  • "filteringMode": "filter-by-index-join",
  • "editableFieldsMode": "whitelist",
  • "primaryKey": "string",
  • "isEditable": true,
  • "index": "string"
}

PerspectiveTypesV100

string (PerspectiveTypesV100)
Enum: "view" "binary"
"view"

PerspectiveInfoV100

type
required
string (PerspectiveTypesV100)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "type": "view",
  • "perspective": "string",
  • "scriptId": "string"
}

SavedSearchAttributesV100

version
required
number <integer>
Value: 100

Search object version

required
object
required
object
required
Array of objects (PerspectiveInfoV100)

Record table, can be an empty array

Array
type
required
string (PerspectiveTypesV100)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (PerspectiveInfoV100)

Record view, can be an empty array

Array
type
required
string (PerspectiveTypesV100)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV100)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV100)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

filteringMode
string <keyword>
Value: "filter-by-index-join"

Filtering mode; Eg: 'filter-by-index-join'

editableFieldsMode
required
string (EditableFieldsModeV100)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string <keyword>
Enum: "G:S" "G:NS" "L" "N"

Scope of search 'G:S' - Shared search with private data (Admin only) 'G:NS'- Shared search with shared data (Admin only) 'L' - Private search 'N' - A standard Elasticsearch index (Admin only)

parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV100)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

{
  • "version": 100,
  • "siren": {
    },
  • "indexPattern": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "sort": [
    ],
  • "columns": [
    ],
  • "hits": 0,
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedSearchAttributesV100_

required
object (SavedSearchAttributesV100)
version
required
number <integer>
Value: 100

Search object version

required
object
required
object
required
Array of objects (PerspectiveInfoV100)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV100)

Record view, can be an empty array

required
object
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV100)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV100)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

filteringMode
string <keyword>
Value: "filter-by-index-join"

Filtering mode; Eg: 'filter-by-index-join'

editableFieldsMode
required
string (EditableFieldsModeV100)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string <keyword>
Enum: "G:S" "G:NS" "L" "N"

Scope of search 'G:S' - Shared search with private data (Admin only) 'G:NS'- Shared search with shared data (Admin only) 'L' - Private search 'N' - A standard Elasticsearch index (Admin only)

parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV100)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

IndexPatternAttributesV101

error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

{
  • "error": null,
  • "fieldFormatMap": "string",
  • "excludeIndices": true,
  • "sourceFilters": "string",
  • "fields": "string",
  • "intervalName": "string",
  • "timeFieldName": "string",
  • "pattern": "string"
}

IndexingScopeStringV101

string (IndexingScopeStringV101)
Enum: "G:S" "G:NS" "L" "N"
"G:S"

EditableFieldsModeV101

string (EditableFieldsModeV101)
Enum: "whitelist" "blacklist"
"whitelist"

RevisionSettingsV101

copyToFields
object
indexingScope
required
string (IndexingScopeStringV101)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

filteringMode
string <keyword>
Value: "filter-by-index-join"

Filtering mode; Eg: 'filter-by-index-join'

editableFieldsMode
required
string (EditableFieldsModeV101)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "copyToFields": {
    },
  • "indexingScope": "G:S",
  • "editableFieldsExceptions": [
    ],
  • "filteringMode": "filter-by-index-join",
  • "editableFieldsMode": "whitelist",
  • "primaryKey": "string",
  • "isEditable": true,
  • "index": "string"
}

PerspectiveTypesV101

string (PerspectiveTypesV101)
Enum: "view" "binary"
"view"

PerspectiveInfoV101

type
required
string (PerspectiveTypesV101)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "type": "view",
  • "perspective": "string",
  • "scriptId": "string"
}

DynamicFilterMappingV101

filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "filterId": "string",
  • "field": "string"
}

SavedSearchAttributesV101

version
required
number <integer>
Value: 101

Search object version

required
object
required
Array of objects (DynamicFilterMappingV101)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV101)

Record table, can be an empty array

Array
type
required
string (PerspectiveTypesV101)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (PerspectiveInfoV101)

Record view, can be an empty array

Array
type
required
string (PerspectiveTypesV101)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV101)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV101)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

filteringMode
string <keyword>
Value: "filter-by-index-join"

Filtering mode; Eg: 'filter-by-index-join'

editableFieldsMode
required
string (EditableFieldsModeV101)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV101)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV101)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

{
  • "version": 101,
  • "siren": {
    },
  • "indexPattern": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "sort": [
    ],
  • "columns": [
    ],
  • "hits": 0,
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedSearchAttributesV101_

required
object (SavedSearchAttributesV101)
version
required
number <integer>
Value: 101

Search object version

required
object
required
Array of objects (DynamicFilterMappingV101)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV101)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV101)

Record view, can be an empty array

required
object
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV101)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV101)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

filteringMode
string <keyword>
Value: "filter-by-index-join"

Filtering mode; Eg: 'filter-by-index-join'

editableFieldsMode
required
string (EditableFieldsModeV101)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV101)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV101)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

IndexPatternAttributesV102

error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

{
  • "error": null,
  • "fieldFormatMap": "string",
  • "excludeIndices": true,
  • "sourceFilters": "string",
  • "fields": "string",
  • "intervalName": "string",
  • "timeFieldName": "string",
  • "pattern": "string"
}

IndexingScopeStringV102

string (IndexingScopeStringV102)
Enum: "G:S" "G:NS" "L" "N"
"G:S"

EditableFieldsModeV102

string (EditableFieldsModeV102)
Enum: "whitelist" "blacklist"
"whitelist"

RevisionSettingsV102

copyToFields
object
indexingScope
required
string (IndexingScopeStringV102)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

filteringMode
string <keyword>
Value: "filter-by-index-join"

Filtering mode; Eg: 'filter-by-index-join'

editableFieldsMode
required
string (EditableFieldsModeV102)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "copyToFields": {
    },
  • "indexingScope": "G:S",
  • "editableFieldsExceptions": [
    ],
  • "filteringMode": "filter-by-index-join",
  • "editableFieldsMode": "whitelist",
  • "primaryKey": "string",
  • "isEditable": true,
  • "index": "string"
}

PerspectiveTypesV102

string (PerspectiveTypesV102)
Enum: "view" "binary"
"view"

PerspectiveInfoV102

type
required
string (PerspectiveTypesV102)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "type": "view",
  • "perspective": "string",
  • "scriptId": "string"
}

DynamicFilterMappingV102

filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "filterId": "string",
  • "field": "string"
}

SavedSearchAttributesV102

version
required
number <integer>
Value: 102

Search object version

required
object
required
Array of objects (DynamicFilterMappingV102)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV102)

Record table, can be an empty array

Array
type
required
string (PerspectiveTypesV102)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (PerspectiveInfoV102)

Record view, can be an empty array

Array
type
required
string (PerspectiveTypesV102)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV102)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV102)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

filteringMode
string <keyword>
Value: "filter-by-index-join"

Filtering mode; Eg: 'filter-by-index-join'

editableFieldsMode
required
string (EditableFieldsModeV102)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV102)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV102)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

{
  • "version": 102,
  • "siren": {
    },
  • "indexPattern": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "sort": [
    ],
  • "columns": [
    ],
  • "hits": 0,
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedSearchAttributesV102_

required
object (SavedSearchAttributesV102)
version
required
number <integer>
Value: 102

Search object version

required
object
required
Array of objects (DynamicFilterMappingV102)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV102)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV102)

Record view, can be an empty array

required
object
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV102)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV102)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

filteringMode
string <keyword>
Value: "filter-by-index-join"

Filtering mode; Eg: 'filter-by-index-join'

editableFieldsMode
required
string (EditableFieldsModeV102)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV102)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV102)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

IndexPatternAttributesV103

error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

{
  • "error": null,
  • "fieldFormatMap": "string",
  • "excludeIndices": true,
  • "sourceFilters": "string",
  • "fields": "string",
  • "intervalName": "string",
  • "timeFieldName": "string",
  • "pattern": "string"
}

IndexingScopeStringV103

string (IndexingScopeStringV103)
Enum: "G:S" "G:NS" "L" "N"
"G:S"

EditableFieldsModeV103

string (EditableFieldsModeV103)
Enum: "whitelist" "blacklist"
"whitelist"

RevisionSettingsV103

copyToFields
object
indexingScope
required
string (IndexingScopeStringV103)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV103)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "copyToFields": {
    },
  • "indexingScope": "G:S",
  • "editableFieldsExceptions": [
    ],
  • "editableFieldsMode": "whitelist",
  • "primaryKey": "string",
  • "isEditable": true,
  • "index": "string"
}

SavedSearchAttributesV103

version
required
number <integer>
Value: 103

Search object version

required
object
required
Array of objects (DynamicFilterMappingV103)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

Array
type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

Array
type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object (GlobalSearchSettingsV103)
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV103)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV103)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV103)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV103)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV103)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

{
  • "version": 103,
  • "siren": {
    },
  • "indexPattern": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "sort": [
    ],
  • "columns": [
    ],
  • "hits": 0,
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedSearchAttributesV103_

required
object (SavedSearchAttributesV103)
version
required
number <integer>
Value: 103

Search object version

required
object
required
Array of objects (DynamicFilterMappingV103)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

required
object (GlobalSearchSettingsV103)
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV103)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV103)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV103)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV103)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV103)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

IndexPatternAttributesV104

error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

{
  • "error": null,
  • "fieldFormatMap": "string",
  • "excludeIndices": true,
  • "sourceFilters": "string",
  • "fields": "string",
  • "intervalName": "string",
  • "timeFieldName": "string",
  • "pattern": "string"
}

IndexingScopeStringV104

string (IndexingScopeStringV104)
Enum: "G:S" "G:NS" "L" "N"
"G:S"

EditableFieldsModeV104

string (EditableFieldsModeV104)
Enum: "whitelist" "blacklist"
"whitelist"

RevisionSettingsV104

copyToFields
object
indexingScope
required
string (IndexingScopeStringV104)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV104)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "copyToFields": {
    },
  • "indexingScope": "G:S",
  • "editableFieldsExceptions": [
    ],
  • "editableFieldsMode": "whitelist",
  • "primaryKey": "string",
  • "isEditable": true,
  • "index": "string"
}

SavedSearchAttributesV104

version
required
number <integer>
Value: 104

Search object version

required
object
required
Array of objects (DynamicFilterMappingV104)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

Array
type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

Array
type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object (GlobalSearchSettingsV104)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV104)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV104)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV104)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV104)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV104)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

{
  • "version": 104,
  • "siren": {
    },
  • "indexPattern": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "sort": [
    ],
  • "columns": [
    ],
  • "hits": 0,
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedSearchAttributesV104_

required
object (SavedSearchAttributesV104)
version
required
number <integer>
Value: 104

Search object version

required
object
required
Array of objects (DynamicFilterMappingV104)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

required
object (GlobalSearchSettingsV104)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV104)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV104)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV104)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV104)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV104)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string>

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

IndexPatternAttributesV105

error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

{
  • "error": null,
  • "fieldFormatMap": "string",
  • "excludeIndices": true,
  • "sourceFilters": "string",
  • "fields": "string",
  • "intervalName": "string",
  • "timeFieldName": "string",
  • "pattern": "string"
}

IndexingScopeStringV105

string (IndexingScopeStringV105)
Enum: "G:S" "G:NS" "L" "N"
"G:S"

EditableFieldsModeV105

string (EditableFieldsModeV105)
Enum: "whitelist" "blacklist"
"whitelist"

RevisionSettingsV105

copyToFields
object
indexingScope
required
string (IndexingScopeStringV105)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV105)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "copyToFields": {
    },
  • "indexingScope": "G:S",
  • "editableFieldsExceptions": [
    ],
  • "editableFieldsMode": "whitelist",
  • "primaryKey": "string",
  • "isEditable": true,
  • "index": "string"
}

GlobalSearchRecencyBoostRangeV105

boost
required
number <double>
required
object
count
required
number <double>
unit
required
string
Enum: "y" "M" "w" "d" "h" "m" "s"
{
  • "boost": 0.1,
  • "from": {
    }
}

GlobalSearchSettingsV105

selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV105)

Global search boost configuration for recent records

Array
boost
required
number <double>
required
object
count
required
number <double>
unit
required
string
Enum: "y" "M" "w" "d" "h" "m" "s"
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

{
  • "selectedByDefault": true,
  • "forceSearchedOnTimeFilter": true,
  • "recencyBoost": [
    ],
  • "boost": 0.1,
  • "enabled": true
}

DynamicFilterMappingV105

filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "filterId": "string",
  • "field": "string"
}

SavedSearchAttributesV105

version
required
number <integer>
Value: 105

Search object version

required
object
required
Array of objects (DynamicFilterMappingV105)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

Array
type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

Array
type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object (GlobalSearchSettingsV105)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV105)

Global search boost configuration for recent records

Array
boost
required
number <double>
required
object
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV105)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV105)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV105)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV105)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV105)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

{
  • "version": 105,
  • "siren": {
    },
  • "indexPattern": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "sort": [
    ],
  • "columns": [
    ],
  • "hits": 0,
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedSearchAttributesV105_

required
object (SavedSearchAttributesV105)
version
required
number <integer>
Value: 105

Search object version

required
object
required
Array of objects (DynamicFilterMappingV105)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

required
object (GlobalSearchSettingsV105)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV105)

Global search boost configuration for recent records

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV105)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV105)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV105)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV105)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV105)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

IndexPatternAttributesV106

error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

{
  • "error": null,
  • "fieldFormatMap": "string",
  • "excludeIndices": true,
  • "sourceFilters": "string",
  • "fields": "string",
  • "intervalName": "string",
  • "timeFieldName": "string",
  • "pattern": "string"
}

IndexingScopeStringV106

string (IndexingScopeStringV106)
Enum: "G:S" "G:NS" "L" "N"
"G:S"

EditableFieldsModeV106

string (EditableFieldsModeV106)
Enum: "whitelist" "blacklist"
"whitelist"

RevisionSettingsV106

copyToFields
object
indexingScope
required
string (IndexingScopeStringV106)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV106)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "copyToFields": {
    },
  • "indexingScope": "G:S",
  • "editableFieldsExceptions": [
    ],
  • "editableFieldsMode": "whitelist",
  • "primaryKey": "string",
  • "isEditable": true,
  • "index": "string"
}

GlobalSearchRecencyBoostRangeV106

boost
required
number <double>
required
object
count
required
number <double>
unit
required
string
Enum: "y" "M" "w" "d" "h" "m" "s"
{
  • "boost": 0.1,
  • "from": {
    }
}

GlobalSearchSettingsV106

selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV106)

Global search boost configuration for recent records

Array
boost
required
number <double>
required
object
count
required
number <double>
unit
required
string
Enum: "y" "M" "w" "d" "h" "m" "s"
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

{
  • "selectedByDefault": true,
  • "forceSearchedOnTimeFilter": true,
  • "recencyBoost": [
    ],
  • "boost": 0.1,
  • "enabled": true
}

DynamicFilterMappingV106

filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "filterId": "string",
  • "field": "string"
}

EntityResolutionV106

enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

{
  • "enabled": true
}

SavedSearchAttributesV106

version
required
number <integer>
Value: 106

Search object version

compositePrimaryKeyFields
required
Array of strings <keyword> (keyword) [ items <keyword > ]
required
object
object (EntityResolutionV106)
enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

required
Array of objects (DynamicFilterMappingV106)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

Array
type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

Array
type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object (GlobalSearchSettingsV106)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV106)

Global search boost configuration for recent records

Array
boost
required
number <double>
required
object
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV106)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV106)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV106)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV106)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV106)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

{
  • "version": 106,
  • "compositePrimaryKeyFields": [
    ],
  • "siren": {
    },
  • "indexPattern": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "sort": [
    ],
  • "columns": [
    ],
  • "hits": 0,
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedSearchAttributesV106_

required
object (SavedSearchAttributesV106)
version
required
number <integer>
Value: 106

Search object version

compositePrimaryKeyFields
required
Array of strings <keyword> (keyword) [ items <keyword > ]
required
object
object (EntityResolutionV106)
enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

required
Array of objects (DynamicFilterMappingV106)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

required
object (GlobalSearchSettingsV106)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV106)

Global search boost configuration for recent records

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV106)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV106)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV106)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV106)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV106)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

IndexPatternAttributesV107

error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

{
  • "error": null,
  • "fieldFormatMap": "string",
  • "excludeIndices": true,
  • "sourceFilters": "string",
  • "fields": "string",
  • "intervalName": "string",
  • "timeFieldName": "string",
  • "pattern": "string"
}

IndexingScopeStringV107

string (IndexingScopeStringV107)
Enum: "G:S" "G:NS" "L" "N"
"G:S"

EditableFieldsModeV107

string (EditableFieldsModeV107)
Enum: "whitelist" "blacklist"
"whitelist"

RevisionSettingsV107

copyToFields
object
indexingScope
required
string (IndexingScopeStringV107)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV107)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "copyToFields": {
    },
  • "indexingScope": "G:S",
  • "editableFieldsExceptions": [
    ],
  • "editableFieldsMode": "whitelist",
  • "primaryKey": "string",
  • "isEditable": true,
  • "index": "string"
}

GlobalSearchRecencyBoostRangeV107

boost
required
number <double>
required
object
count
required
number <double>
unit
required
string
Enum: "y" "M" "w" "d" "h" "m" "s"
{
  • "boost": 0.1,
  • "from": {
    }
}

GlobalSearchSettingsV107

selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV107)

Global search boost configuration for recent records

Array
boost
required
number <double>
required
object
count
required
number <double>
unit
required
string
Enum: "y" "M" "w" "d" "h" "m" "s"
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

{
  • "selectedByDefault": true,
  • "forceSearchedOnTimeFilter": true,
  • "recencyBoost": [
    ],
  • "boost": 0.1,
  • "enabled": true
}

DynamicFilterMappingV107

filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "filterId": "string",
  • "field": "string"
}

EntityResolutionV107

enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

{
  • "enabled": true
}

ImportSettingsV107

allowedFields
Array of strings <keyword> (keyword) [ items <keyword > ]

An optional list of fields that imported data can be mapped to. Defaults to all fields.

targetIndex
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

projectImportsEnabled
boolean

Whether the Entity Table is a possible upload target in the Upload center. Defaults to false.

{
  • "allowedFields": [
    ],
  • "targetIndex": "string",
  • "projectImportsEnabled": true
}

SavedSearchAttributesV107

version
required
number <integer>
Value: 107

Search object version

compositePrimaryKeyFields
required
Array of strings <keyword> (keyword) [ items <keyword > ]

Array of fields used to construct the key for reconciliation.

required
object
object (ImportSettingsV107)
allowedFields
Array of strings <keyword> (keyword) [ items <keyword > ]

An optional list of fields that imported data can be mapped to. Defaults to all fields.

targetIndex
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

projectImportsEnabled
boolean

Whether the Entity Table is a possible upload target in the Upload center. Defaults to false.

object (EntityResolutionV107)
enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

required
Array of objects (DynamicFilterMappingV107)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

Array
type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

Array
type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object (GlobalSearchSettingsV107)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV107)

Global search boost configuration for recent records

Array
boost
required
number <double>
required
object
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV107)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV107)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV107)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV107)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV107)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

{
  • "version": 107,
  • "compositePrimaryKeyFields": [
    ],
  • "siren": {
    },
  • "indexPattern": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "sort": [
    ],
  • "columns": [
    ],
  • "hits": 0,
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedSearchAttributesV107_

required
object (SavedSearchAttributesV107)
version
required
number <integer>
Value: 107

Search object version

compositePrimaryKeyFields
required
Array of strings <keyword> (keyword) [ items <keyword > ]

Array of fields used to construct the key for reconciliation.

required
object
object (ImportSettingsV107)
allowedFields
Array of strings <keyword> (keyword) [ items <keyword > ]

An optional list of fields that imported data can be mapped to. Defaults to all fields.

targetIndex
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

projectImportsEnabled
boolean

Whether the Entity Table is a possible upload target in the Upload center. Defaults to false.

object (EntityResolutionV107)
enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

required
Array of objects (DynamicFilterMappingV107)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

required
object (GlobalSearchSettingsV107)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV107)

Global search boost configuration for recent records

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV107)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV107)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV107)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV107)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV107)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SearchAppColumnEntityConfigurationV100

string or PerspectiveInfoV103 (object)

Cell information of column rendering to use on mobile devices.

Any of
string

Cell information of column rendering to use on mobile devices.

required
string or PerspectiveInfoV103 (object)

Cell information of main column rendering.

Any of
string

Cell information of main column rendering.

searchId
required
string

Id of linked search.

{
  • "mobile": "string",
  • "main": "string",
  • "searchId": "string"
}

SearchAppColumnConfigurationV100

required
Array of objects (SearchAppColumnEntityConfigurationV100)

Column configurations per entity.

Array
string or PerspectiveInfoV103 (object)

Cell information of column rendering to use on mobile devices.

Any of
string

Cell information of column rendering to use on mobile devices.

required
string or PerspectiveInfoV103 (object)

Cell information of main column rendering.

Any of
string

Cell information of main column rendering.

searchId
required
string

Id of linked search.

title
required
string

Column title.

{
  • "entities": [
    ],
  • "title": "string"
}

SearchAppConfigurationV100

required
Array of objects (SearchAppColumnConfigurationV100)
Array
required
Array of objects (SearchAppColumnEntityConfigurationV100)

Column configurations per entity.

Array
string or PerspectiveInfoV103 (object)

Cell information of column rendering to use on mobile devices.

required
string or PerspectiveInfoV103 (object)

Cell information of main column rendering.

searchId
required
string

Id of linked search.

title
required
string

Column title.

showSearchHighlightsOnMobile
required
boolean

Search highlights column visibility in the mobile mode.

showSearchHighlightsOnDesktop
required
boolean

Search highlights column visibility in the desktop mode.

{
  • "columns": [
    ],
  • "showSearchHighlightsOnMobile": true,
  • "showSearchHighlightsOnDesktop": true
}

AnyObjectEsType_SearchAppConfigurationV100_

required
Array of objects (SearchAppColumnConfigurationV100)
Array
required
Array of objects (SearchAppColumnEntityConfigurationV100)

Column configurations per entity.

Array
string or PerspectiveInfoV103 (object)

Cell information of column rendering to use on mobile devices.

required
string or PerspectiveInfoV103 (object)

Cell information of main column rendering.

searchId
required
string

Id of linked search.

title
required
string

Column title.

showSearchHighlightsOnMobile
required
boolean

Search highlights column visibility in the mobile mode.

showSearchHighlightsOnDesktop
required
boolean

Search highlights column visibility in the desktop mode.

{
  • "columns": [
    ],
  • "showSearchHighlightsOnMobile": true,
  • "showSearchHighlightsOnDesktop": true
}

SavedSearchAppConfigurationAttributesV100

version
required
number <integer>
Value: 100

Search app configuration object version.

required
object (AnyObjectEsType_SearchAppConfigurationV100_)
required
Array of objects (SearchAppColumnConfigurationV100)
Array
required
Array of objects (SearchAppColumnEntityConfigurationV100)

Column configurations per entity.

title
required
string

Column title.

showSearchHighlightsOnMobile
required
boolean

Search highlights column visibility in the mobile mode.

showSearchHighlightsOnDesktop
required
boolean

Search highlights column visibility in the desktop mode.

title
required
string

Title for search app configuration.

{
  • "version": 100,
  • "configuration": {
    },
  • "title": "string"
}

ObjectPayload_SavedSearchAppConfigurationAttributesV100_

required
object (SavedSearchAppConfigurationAttributesV100)
version
required
number <integer>
Value: 100

Search app configuration object version.

required
object (AnyObjectEsType_SearchAppConfigurationV100_)
required
Array of objects (SearchAppColumnConfigurationV100)
Array
required
Array of objects (SearchAppColumnEntityConfigurationV100)

Column configurations per entity.

title
required
string

Column title.

showSearchHighlightsOnMobile
required
boolean

Search highlights column visibility in the mobile mode.

showSearchHighlightsOnDesktop
required
boolean

Search highlights column visibility in the desktop mode.

title
required
string

Title for search app configuration.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSearchAppConfigurationAttributesV101

version
required
number <integer>
Value: 101

Search app configuration object version.

required
object (AnyObjectEsType_SearchAppConfigurationV101_)
required
Array of objects (SearchAppColumnConfigurationV101)
Array
required
Array of objects (SearchAppColumnEntityConfigurationV101)

Column configurations per entity.

title
required
string

Column title.

id
required
string

Column id. Must be unique.

Array of objects (SearchAppScriptsConfigurationV101)
Array
required
object
scriptId
required
string <keyword>

ScriptId

object

Search preference configurations

showEquivalentResultsByDefault
required
boolean

Show equivalents results by default.

showSearchHighlightsOnMobile
required
boolean

Search highlights column visibility in the mobile mode.

showSearchHighlightsOnDesktop
required
boolean

Search highlights column visibility in the desktop mode.

title
required
string

Title for search app configuration.

{
  • "version": 101,
  • "configuration": {
    },
  • "title": "string"
}

ObjectPayload_SavedSearchAppConfigurationAttributesV101_

required
object (SavedSearchAppConfigurationAttributesV101)
version
required
number <integer>
Value: 101

Search app configuration object version.

required
object (AnyObjectEsType_SearchAppConfigurationV101_)
required
Array of objects (SearchAppColumnConfigurationV101)
Array
required
Array of objects (SearchAppColumnEntityConfigurationV101)

Column configurations per entity.

title
required
string

Column title.

id
required
string

Column id. Must be unique.

Array of objects (SearchAppScriptsConfigurationV101)
Array
required
object
scriptId
required
string <keyword>

ScriptId

object

Search preference configurations

showEquivalentResultsByDefault
required
boolean

Show equivalents results by default.

showSearchHighlightsOnMobile
required
boolean

Search highlights column visibility in the mobile mode.

showSearchHighlightsOnDesktop
required
boolean

Search highlights column visibility in the desktop mode.

title
required
string

Title for search app configuration.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSentinlWatcherAttributesV100

version
required
number <integer>
Value: 100

SentinlWatcher object version

(string or null) or (Array of strings or null) <string>

Roles for SentinlWatcher

Any of
string or null <string>

Roles for SentinlWatcher

custom
string <string>

Custom for SentinlWatcher

dashboard_link
string <string>

Dashboard link for SentinlWatcher

wizard
string <string>

Wizard for SentinlWatcher

trigger
required
string <string>

Trigger for SentinlWatcher

spy
required
boolean <boolean>

Is spy

save_payload
required
boolean <boolean>

Is payload to be saved

priority
string <string>

Priority of SentinlWatcher

input
required
string <string>

Input for SentinlWatcher

is_private
boolean <boolean>

Is private

impersonate
required
boolean <boolean>

Does impersonate

disable
required
boolean <boolean>

Is disabled

string or any <string>

Creator of SentinlWatcher

Any of
string <string>

Creator of SentinlWatcher

transform
string <string>

Transform for sentinlWatcher

condition
required
string <string>

Condition for sentinlWatcher

actions
required
string <string>

Action for sentinlWatcher

report
required
boolean <string>

Report on for sentinlWatcher

username
string <string>

Username for sentinlWatcher

title
required
string <string>

Title for sentinlWatcher

{
  • "version": 100,
  • "roles": "string",
  • "custom": "string",
  • "dashboard_link": "string",
  • "wizard": "string",
  • "trigger": "string",
  • "spy": true,
  • "save_payload": true,
  • "priority": "string",
  • "input": "string",
  • "is_private": true,
  • "impersonate": true,
  • "disable": true,
  • "created_by": "string",
  • "transform": "string",
  • "condition": "string",
  • "actions": "string",
  • "report": true,
  • "username": "string",
  • "title": "string"
}

ObjectPayload_SavedSentinlWatcherAttributesV100_

required
object (SavedSentinlWatcherAttributesV100)
version
required
number <integer>
Value: 100

SentinlWatcher object version

(string or null) or (Array of strings or null) <string>

Roles for SentinlWatcher

Any of
string or null <string>

Roles for SentinlWatcher

custom
string <string>

Custom for SentinlWatcher

dashboard_link
string <string>

Dashboard link for SentinlWatcher

wizard
string <string>

Wizard for SentinlWatcher

trigger
required
string <string>

Trigger for SentinlWatcher

spy
required
boolean <boolean>

Is spy

save_payload
required
boolean <boolean>

Is payload to be saved

priority
string <string>

Priority of SentinlWatcher

input
required
string <string>

Input for SentinlWatcher

is_private
boolean <boolean>

Is private

impersonate
required
boolean <boolean>

Does impersonate

disable
required
boolean <boolean>

Is disabled

string or any <string>

Creator of SentinlWatcher

Any of
string <string>

Creator of SentinlWatcher

transform
string <string>

Transform for sentinlWatcher

condition
required
string <string>

Condition for sentinlWatcher

actions
required
string <string>

Action for sentinlWatcher

report
required
boolean <string>

Report on for sentinlWatcher

username
string <string>

Username for sentinlWatcher

title
required
string <string>

Title for sentinlWatcher

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSidebarGroupAttributesV100

version
required
number <integer>
Value: 100

SidebarGroups object version

hide
required
boolean <boolean>

Is the sidebar group hidden

iconCss
required
string <string>

Icon of the sidebar group

description
required
string <string>

Description for Sidebar Group

title
required
string <string>

Title for Sidebar Group

{
  • "version": 100,
  • "hide": true,
  • "iconCss": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedSidebarGroupAttributesV100_

required
object (SavedSidebarGroupAttributesV100)
version
required
number <integer>
Value: 100

SidebarGroups object version

hide
required
boolean <boolean>

Is the sidebar group hidden

iconCss
required
string <string>

Icon of the sidebar group

description
required
string <string>

Description for Sidebar Group

title
required
string <string>

Title for Sidebar Group

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSidebarOptionsAttributesV100

version
required
number <integer>
Value: 100

Sidebar options object version

order
required
string <string>

Sidebar options display order

title
required
string <keyword>

Title for sidebar options

{
  • "version": 100,
  • "order": "string",
  • "title": "string"
}

ObjectPayload_SavedSidebarOptionsAttributesV100_

required
object (SavedSidebarOptionsAttributesV100)
version
required
number <integer>
Value: 100

Sidebar options object version

order
required
string <string>

Sidebar options display order

title
required
string <keyword>

Title for sidebar options

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSidebarOptionsAttributesV101

version
required
number <integer>
Value: 101

Sidebar options object version

order
required
string <string>

Sidebar options display order

title
required
string <keyword>

Title for sidebar options

{
  • "version": 101,
  • "order": "string",
  • "title": "string"
}

ObjectPayload_SavedSidebarOptionsAttributesV101_

required
object (SavedSidebarOptionsAttributesV101)
version
required
number <integer>
Value: 101

Sidebar options object version

order
required
string <string>

Sidebar options display order

title
required
string <keyword>

Title for sidebar options

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SystemGroupConfigV102

title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

{
  • "title": "string",
  • "iconCss": "string"
}

SystemGroupsV102

required
object (SystemGroupConfigV102)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

required
object (SystemGroupConfigV102)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

{
  • "private": {
    },
  • "shared": {
    }
}

AnyObjectEsType_SystemGroupsV102_

required
object (SystemGroupConfigV102)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

required
object (SystemGroupConfigV102)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

{
  • "private": {
    },
  • "shared": {
    }
}

SavedSidebarOptionsAttributesV102

version
required
number <integer>
Value: 102

Sidebar options object version

required
object (AnyObjectEsType_SystemGroupsV102_)
required
object (SystemGroupConfigV102)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

required
object (SystemGroupConfigV102)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

order
required
string <string>

Sidebar options display order

title
required
string <keyword>

Title for sidebar options

{
  • "version": 102,
  • "systemGroups": {
    },
  • "order": "string",
  • "title": "string"
}

ObjectPayload_SavedSidebarOptionsAttributesV102_

required
object (SavedSidebarOptionsAttributesV102)
version
required
number <integer>
Value: 102

Sidebar options object version

required
object (AnyObjectEsType_SystemGroupsV102_)
required
object (SystemGroupConfigV102)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

required
object (SystemGroupConfigV102)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

order
required
string <string>

Sidebar options display order

title
required
string <keyword>

Title for sidebar options

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SystemGroupConfigV103

title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

{
  • "title": "string",
  • "iconCss": "string"
}

SystemGroupsV103

required
object (SystemGroupConfigV103)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

required
object (SystemGroupConfigV103)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

{
  • "private": {
    },
  • "shared": {
    }
}

AnyObjectEsType_SystemGroupsV103_

required
object (SystemGroupConfigV103)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

required
object (SystemGroupConfigV103)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

{
  • "private": {
    },
  • "shared": {
    }
}

SavedSidebarOptionsAttributesV103

_skip_id_validation
boolean

Temporary property to indicate that strict id validation should be skipped for this object This property will be removed in the future

version
required
number <integer>
Value: 103

Sidebar options object version

required
object (AnyObjectEsType_SystemGroupsV103_)
required
object (SystemGroupConfigV103)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

required
object (SystemGroupConfigV103)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

order
required
string <string>

Sidebar options display order

title
required
string <keyword>

Title for sidebar options

{
  • "_skip_id_validation": true,
  • "version": 103,
  • "systemGroups": {
    },
  • "order": "string",
  • "title": "string"
}

ObjectPayload_SavedSidebarOptionsAttributesV103_

required
object (SavedSidebarOptionsAttributesV103)
_skip_id_validation
boolean

Temporary property to indicate that strict id validation should be skipped for this object This property will be removed in the future

version
required
number <integer>
Value: 103

Sidebar options object version

required
object (AnyObjectEsType_SystemGroupsV103_)
required
object (SystemGroupConfigV103)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

required
object (SystemGroupConfigV103)
title
required
string

Title of private system group.

iconCss
required
string

Icon of private system group.

order
required
string <string>

Sidebar options display order

title
required
string <keyword>

Title for sidebar options

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSirenApiScriptAttributesV100

object
searchSourceJSON
required
string <string>

Stringified JSON object

apiVersion
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

version
required
number <integer>
Value: 100

Script object version

scriptTypeVersion
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

scriptSource
required
string <string>

Script type

type
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

description
required
string <string>

An optional description for script

title
required
string <string>

Title for script

{
  • "kibanaSavedObjectMeta": {
    },
  • "apiVersion": 0,
  • "version": 100,
  • "scriptTypeVersion": 0,
  • "scriptSource": "string",
  • "type": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedSirenApiScriptAttributesV100_

required
object (SavedSirenApiScriptAttributesV100)
object
searchSourceJSON
required
string <string>

Stringified JSON object

apiVersion
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

version
required
number <integer>
Value: 100

Script object version

scriptTypeVersion
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

scriptSource
required
string <string>

Script type

type
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

description
required
string <string>

An optional description for script

title
required
string <string>

Title for script

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedTimelionSheetAttributesV100

version
required
number <integer>
Value: 100

TimelionSheet object version

timelion_rows
required
number <double> \b([1-9]|1[0-2])\b

Number of rows for timelion

timelion_columns
required
number <double> \b([1-9]|1[0-2])\b

Number of columns for timelion

timelion_interval
required
string <string>

Interval used for filtering data by time

timelion_sheet
required
Array of strings <keyword> (TimelionExpression) [ items <keyword > ]

Array of queries used for each panel

description
required
string <string>

Description

hits
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

title
required
string <string>

Title

{
  • "version": 100,
  • "timelion_rows": 0.1,
  • "timelion_columns": 0.1,
  • "timelion_interval": "string",
  • "timelion_sheet": [
    ],
  • "description": "string",
  • "hits": 0,
  • "title": "string"
}

ObjectPayload_SavedTimelionSheetAttributesV100_

required
object (SavedTimelionSheetAttributesV100)
version
required
number <integer>
Value: 100

TimelionSheet object version

timelion_rows
required
number <double> \b([1-9]|1[0-2])\b

Number of rows for timelion

timelion_columns
required
number <double> \b([1-9]|1[0-2])\b

Number of columns for timelion

timelion_interval
required
string <string>

Interval used for filtering data by time

timelion_sheet
required
Array of strings <keyword> (TimelionExpression) [ items <keyword > ]

Array of queries used for each panel

description
required
string <string>

Description

hits
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

title
required
string <string>

Title

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedTransformerAttributesV100

version
required
number <integer>
Value: 100

Transformer object version

userPipeline
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

fieldScripts
required
string <string>

Transformer script used to transform fields (json value)

description
required
string <string>

A description for transformer

title
required
string <string>

Title for transformer

{
  • "version": 100,
  • "userPipeline": "string",
  • "fieldScripts": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedTransformerAttributesV100_

required
object (SavedTransformerAttributesV100)
version
required
number <integer>
Value: 100

Transformer object version

userPipeline
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

fieldScripts
required
string <string>

Transformer script used to transform fields (json value)

description
required
string <string>

A description for transformer

title
required
string <string>

Title for transformer

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedTransformerAttributesV101

version
required
number <integer>
Value: 101

Transformer object version

userPipeline
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

fieldScripts
required
string

Transformer script used to transform fields (json value)

searchId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

description
required
string

A description for the transformer

title
required
string

Title of the transformer

{
  • "version": 101,
  • "userPipeline": "string",
  • "fieldScripts": "string",
  • "searchId": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedTransformerAttributesV101_

required
object (SavedTransformerAttributesV101)
version
required
number <integer>
Value: 101

Transformer object version

userPipeline
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

fieldScripts
required
string

Transformer script used to transform fields (json value)

searchId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

description
required
string

A description for the transformer

title
required
string

Title of the transformer

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedUrlAttributesV100

version
required
number <integer>
Value: 100

Url object version

sirenSession
any <any>

Siren session

url
required
string <string>

Url string

string or dateString (string) <date>

Create date of url

Any of
string <date>

Create date of url

string or dateString (string) <date>

Access date of url, if not passed will take the current date

Any of
string <date>

Access date of url, if not passed will take the current date

accessCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

{
  • "version": 100,
  • "sirenSession": null,
  • "url": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "accessDate": "2019-08-24T14:15:22Z",
  • "accessCount": 0
}

ObjectPayload_SavedUrlAttributesV100_

required
object (SavedUrlAttributesV100)
version
required
number <integer>
Value: 100

Url object version

sirenSession
any <any>

Siren session

url
required
string <string>

Url string

string or dateString (string) <date>

Create date of url

Any of
string <date>

Create date of url

string or dateString (string) <date>

Access date of url, if not passed will take the current date

Any of
string <date>

Access date of url, if not passed will take the current date

accessCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedUrlAttributesV101

version
required
number <integer>
Value: 101

Url object version

sirenSession
any <any>

Siren session

url
required
string <string>

Url string

string or dateString (string) <date>

Create date of url

Any of
string <date>

Create date of url

string or dateString (string) <date>

Access date of url, if not passed will take the current date

Any of
string <date>

Access date of url, if not passed will take the current date

accessCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

{
  • "version": 101,
  • "sirenSession": null,
  • "url": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "accessDate": "2019-08-24T14:15:22Z",
  • "accessCount": 0
}

ObjectPayload_SavedUrlAttributesV101_

required
object (SavedUrlAttributesV101)
version
required
number <integer>
Value: 101

Url object version

sirenSession
any <any>

Siren session

url
required
string <string>

Url string

string or dateString (string) <date>

Create date of url

Any of
string <date>

Create date of url

string or dateString (string) <date>

Access date of url, if not passed will take the current date

Any of
string <date>

Access date of url, if not passed will take the current date

accessCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV100

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 100

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of sripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 100,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV100_

required
object (SavedVisualizationAttributesV100)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 100

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of sripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV101

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 101

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 101,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV101_

required
object (SavedVisualizationAttributesV101)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 101

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV102

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 102

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 102,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV102_

required
object (SavedVisualizationAttributesV102)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 102

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV103

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 103

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 103,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV103_

required
object (SavedVisualizationAttributesV103)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 103

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV105

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 105

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 105,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV105_

required
object (SavedVisualizationAttributesV105)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 105

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedWebServiceConfigAttributesV100

version
required
number <integer>
Value: 100

Web service config object version

data
required
string <string>

Web service config data json value

type
required
string (WebServiceConfigTypesV100)
Enum: "service-configuration" "profile"
title
required
string <string>

Title for Web service config

{
  • "version": 100,
  • "data": "string",
  • "type": "service-configuration",
  • "title": "string"
}

ObjectPayload_SavedWebServiceConfigAttributesV100_

required
object (SavedWebServiceConfigAttributesV100)
version
required
number <integer>
Value: 100

Web service config object version

data
required
string <string>

Web service config data json value

type
required
string (WebServiceConfigTypesV100)
Enum: "service-configuration" "profile"
title
required
string <string>

Title for Web service config

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV121

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV121_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV121

string (ExpansionLayoutModesV121)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV121_

string (AnyObjectEsType_ExpansionLayoutModesV121_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

SelectionSettingsV121

string (SelectionSettingsV121)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

AnyObjectEsType_SelectionSettingsV121_

string (AnyObjectEsType_SelectionSettingsV121_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

MapNodeVisibilityModesV121

string (MapNodeVisibilityModesV121)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

AnyObjectEsType_MapNodeVisibilityModesV121_

string (AnyObjectEsType_MapNodeVisibilityModesV121_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

TimebarNodeVisibilityModesV121

string (TimebarNodeVisibilityModesV121)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV121_

string (AnyObjectEsType_TimebarNodeVisibilityModesV121_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

ItemsHighlightModesV121

string (ItemsHighlightModesV121)
Enum: "no" "selected" "selectedAndConnected"
"no"

AnyObjectEsType_ItemsHighlightModesV121_

string (AnyObjectEsType_ItemsHighlightModesV121_)
Enum: "no" "selected" "selectedAndConnected"
"no"

ToolbarSettingsTypeV121

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV121_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV121_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV121_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV121_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV121_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV121_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV121_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV121_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV121_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV121_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV121_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV121

version
required
number <integer>
Value: 121

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV121. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV121_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV121_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV121_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV121_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV121_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV121_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV121_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 121,
  • "visualizerHash": "string",
  • "toolbarSettings": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "nodesCount": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV121_

required
object (SavedGraphAttributesV121)
version
required
number <integer>
Value: 121

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV121. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV121_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV121_)
Enum: "no" "selected" "selectedAndConnected"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV121_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV121_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV121_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV121_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV121_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV104

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 104

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 104,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV104_

required
object (SavedVisualizationAttributesV104)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 104

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV123

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV123_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV123

string (ExpansionLayoutModesV123)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV123_

string (AnyObjectEsType_ExpansionLayoutModesV123_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

SelectionSettingsV123

string (SelectionSettingsV123)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

AnyObjectEsType_SelectionSettingsV123_

string (AnyObjectEsType_SelectionSettingsV123_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

MapNodeVisibilityModesV123

string (MapNodeVisibilityModesV123)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

AnyObjectEsType_MapNodeVisibilityModesV123_

string (AnyObjectEsType_MapNodeVisibilityModesV123_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

PersistedLayerTypeV123

string (PersistedLayerTypeV123)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
"wfs"

MapLayerV123

type
required
string (PersistedLayerTypeV123)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "type": "wfs",
  • "enabled": true,
  • "id": "string"
}

TimebarNodeVisibilityModesV123

string (TimebarNodeVisibilityModesV123)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV123_

string (AnyObjectEsType_TimebarNodeVisibilityModesV123_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

TimebarRenderingModeV123

string (TimebarRenderingModeV123)
Enum: "histogram" "saturn"
"histogram"

AnyObjectEsType_TimebarRenderingModeV123_

string (AnyObjectEsType_TimebarRenderingModeV123_)
Enum: "histogram" "saturn"
"histogram"

TimebarTargetHeightV123

string (TimebarTargetHeightV123)
Enum: "default" "tall"
"default"

AnyObjectEsType_TimebarTargetHeightV123_

string (AnyObjectEsType_TimebarTargetHeightV123_)
Enum: "default" "tall"
"default"

ItemsHighlightModesV123

string (ItemsHighlightModesV123)
Enum: "no" "selected" "selectedAndConnected"
"no"

AnyObjectEsType_ItemsHighlightModesV123_

string (AnyObjectEsType_ItemsHighlightModesV123_)
Enum: "no" "selected" "selectedAndConnected"
"no"

ToolbarSettingsTypeV123

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV123_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV123_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV123_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV123_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV123)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV123)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV123_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV123_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV123_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timebar": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV123_

required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV123_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV123_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV123_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV123_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV123)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV123)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV123_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV123_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV123_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timebar": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV123

version
required
number <integer>
Value: 123

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV123. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV123_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV123_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV123_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV123_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV123_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV123)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV123)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV123_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV123_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV123_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
required
object
searchSourceJSON
required
string <string>

Stringified JSON object

vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV123_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 123,
  • "visualizerHash": "string",
  • "toolbarSettings": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "nodesCount": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV123_

required
object (SavedGraphAttributesV123)
version
required
number <integer>
Value: 123

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV123. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV123_)
required
object
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV123_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV123_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV123_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV123_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV123)

map overlays and base layers

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV123_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV123_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV123_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
required
object
searchSourceJSON
required
string <string>

Stringified JSON object

vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV123_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV106

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 106

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 106,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV106_

required
object (SavedVisualizationAttributesV106)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 106

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV124

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV124_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV124

string (ExpansionLayoutModesV124)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV124_

string (AnyObjectEsType_ExpansionLayoutModesV124_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

SelectionSettingsV124

string (SelectionSettingsV124)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

AnyObjectEsType_SelectionSettingsV124_

string (AnyObjectEsType_SelectionSettingsV124_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

MapNodeVisibilityModesV124

string (MapNodeVisibilityModesV124)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

AnyObjectEsType_MapNodeVisibilityModesV124_

string (AnyObjectEsType_MapNodeVisibilityModesV124_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

PersistedLayerTypeV124

string (PersistedLayerTypeV124)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
"wfs"

MapLayerV124

type
required
string (PersistedLayerTypeV124)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "type": "wfs",
  • "enabled": true,
  • "id": "string"
}

TimebarNodeVisibilityModesV124

string (TimebarNodeVisibilityModesV124)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV124_

string (AnyObjectEsType_TimebarNodeVisibilityModesV124_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

TimebarRenderingModeV124

string (TimebarRenderingModeV124)
Enum: "histogram" "saturn"
"histogram"

AnyObjectEsType_TimebarRenderingModeV124_

string (AnyObjectEsType_TimebarRenderingModeV124_)
Enum: "histogram" "saturn"
"histogram"

TimebarTargetHeightV124

string (TimebarTargetHeightV124)
Enum: "default" "tall"
"default"

AnyObjectEsType_TimebarTargetHeightV124_

string (AnyObjectEsType_TimebarTargetHeightV124_)
Enum: "default" "tall"
"default"

ItemsHighlightModesV124

string (ItemsHighlightModesV124)
Enum: "no" "selected" "selectedAndConnected"
"no"

AnyObjectEsType_ItemsHighlightModesV124_

string (AnyObjectEsType_ItemsHighlightModesV124_)
Enum: "no" "selected" "selectedAndConnected"
"no"

EdgeGroupingModesV124

string (EdgeGroupingModesV124)
Enum: "singleEdge" "perDirection" "off"
"singleEdge"

AnyObjectEsType_EdgeGroupingModesV124_

string (AnyObjectEsType_EdgeGroupingModesV124_)
Enum: "singleEdge" "perDirection" "off"
"singleEdge"

ToolbarSettingsTypeV124

required
object
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV124_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV124_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV124_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV124_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV124_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV124)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV124)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV124_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV124_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV124_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timebar": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV124_

required
object
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV124_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV124_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV124_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV124_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV124_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV124)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV124)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV124_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV124_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV124_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timebar": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV124

version
required
number <integer>
Value: 124

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV124. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV124_)
required
object
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV124_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV124_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV124_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV124_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV124_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV124)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV124)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV124_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV124_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV124_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
required
object
searchSourceJSON
required
string <string>

Stringified JSON object

vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV124_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 124,
  • "visualizerHash": "string",
  • "toolbarSettings": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "nodesCount": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV124_

required
object (SavedGraphAttributesV124)
version
required
number <integer>
Value: 124

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV124. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV124_)
required
object
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV124_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV124_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV124_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV124_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV124_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV124)

map overlays and base layers

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV124_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV124_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV124_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
required
object
searchSourceJSON
required
string <string>

Stringified JSON object

vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV124_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV107

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 107

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 107,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV107_

required
object (SavedVisualizationAttributesV107)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 107

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV108

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 108

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 108,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV108_

required
object (SavedVisualizationAttributesV108)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 108

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV109

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 109

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 109,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV109_

required
object (SavedVisualizationAttributesV109)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 109

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV110

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 110

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 110,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV110_

required
object (SavedVisualizationAttributesV110)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 110

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV111

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 111

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 111,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV111_

required
object (SavedVisualizationAttributesV111)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 111

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV112

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 112

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 112,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV112_

required
object (SavedVisualizationAttributesV112)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 112

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSearchAttributesV108

version
required
number <integer>
Value: 108

Search object version

compositePrimaryKeyFields
required
Array of strings <keyword> (keyword) [ items <keyword > ]

Array of fields used to construct the key for reconciliation.

required
object
object (ComputedFieldsScriptsV108)
required
Array of objects (ComputedFieldsScriptV108)
Array
id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (ComputedFieldV108)
Array
type
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

label
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

name
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (ImportSettingsV108)
allowedFields
Array of strings <keyword> (keyword) [ items <keyword > ]

An optional list of fields that imported data can be mapped to. Defaults to all fields.

targetIndex
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

projectImportsEnabled
boolean

Whether the Entity Table is a possible upload target in the Upload center. Defaults to false.

object (EntityResolutionV108)
enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

required
Array of objects (DynamicFilterMappingV108)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

Array
type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

Array
type
required
string (PerspectiveTypesV103)
Enum: "view" "binary"
perspective
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

scriptId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object (GlobalSearchSettingsV108)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

Array
boost
required
number <double>
required
object
boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV108)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV108)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV108)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

{
  • "version": 108,
  • "compositePrimaryKeyFields": [
    ],
  • "siren": {
    },
  • "indexPattern": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "sort": [
    ],
  • "columns": [
    ],
  • "hits": 0,
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedSearchAttributesV108_

required
object (SavedSearchAttributesV108)
version
required
number <integer>
Value: 108

Search object version

compositePrimaryKeyFields
required
Array of strings <keyword> (keyword) [ items <keyword > ]

Array of fields used to construct the key for reconciliation.

required
object
object (ComputedFieldsScriptsV108)
required
Array of objects (ComputedFieldsScriptV108)
required
Array of objects (ComputedFieldV108)
object (ImportSettingsV108)
allowedFields
Array of strings <keyword> (keyword) [ items <keyword > ]

An optional list of fields that imported data can be mapped to. Defaults to all fields.

targetIndex
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

projectImportsEnabled
boolean

Whether the Entity Table is a possible upload target in the Upload center. Defaults to false.

object (EntityResolutionV108)
enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

required
Array of objects (DynamicFilterMappingV108)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

required
object (GlobalSearchSettingsV108)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV108)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV108)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV108)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedSidebarOptionsAttributesV104

_skip_id_validation
boolean

Temporary property to indicate that strict id validation should be skipped for this object This property will be removed in the future

version
required
number <integer>
Value: 104

Sidebar options object version

required
object (AnyObjectEsType_SystemGroupsV104_)
required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

order
required
string <string>

Sidebar options display order

title
required
string <keyword>

Title for sidebar options

{
  • "_skip_id_validation": true,
  • "version": 104,
  • "systemGroups": {
    },
  • "order": "string",
  • "title": "string"
}

ObjectPayload_SavedSidebarOptionsAttributesV104_

required
object (SavedSidebarOptionsAttributesV104)
_skip_id_validation
boolean

Temporary property to indicate that strict id validation should be skipped for this object This property will be removed in the future

version
required
number <integer>
Value: 104

Sidebar options object version

required
object (AnyObjectEsType_SystemGroupsV104_)
required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

required
object (SystemGroupConfigV104)
title
required
string

Title of system group.

iconCss
required
string

Icon of system group.

order
required
string <string>

Sidebar options display order

title
required
string <keyword>

Title for sidebar options

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SelectionColumnsV125

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

AnyObjectEsType_SelectionColumnsV125_

property name*
additional property
Array of strings
{
  • "property1": [
    ],
  • "property2": [
    ]
}

ExpansionLayoutModesV125

string (ExpansionLayoutModesV125)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

AnyObjectEsType_ExpansionLayoutModesV125_

string (AnyObjectEsType_ExpansionLayoutModesV125_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
"freeExpansion"

SelectionSettingsV125

string (SelectionSettingsV125)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

AnyObjectEsType_SelectionSettingsV125_

string (AnyObjectEsType_SelectionSettingsV125_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

"keep"

MapNodeVisibilityModesV125

string (MapNodeVisibilityModesV125)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

AnyObjectEsType_MapNodeVisibilityModesV125_

string (AnyObjectEsType_MapNodeVisibilityModesV125_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
"allNodes"

PersistedLayerTypeV125

string (PersistedLayerTypeV125)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
"wfs"

MapLayerV125

type
required
string (PersistedLayerTypeV125)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "type": "wfs",
  • "enabled": true,
  • "id": "string"
}

TimebarNodeVisibilityModesV125

string (TimebarNodeVisibilityModesV125)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

AnyObjectEsType_TimebarNodeVisibilityModesV125_

string (AnyObjectEsType_TimebarNodeVisibilityModesV125_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
"allNodes"

TimebarRenderingModeV125

string (TimebarRenderingModeV125)
Enum: "histogram" "saturn"
"histogram"

AnyObjectEsType_TimebarRenderingModeV125_

string (AnyObjectEsType_TimebarRenderingModeV125_)
Enum: "histogram" "saturn"
"histogram"

TimebarTargetHeightV125

string (TimebarTargetHeightV125)
Enum: "default" "tall"
"default"

AnyObjectEsType_TimebarTargetHeightV125_

string (AnyObjectEsType_TimebarTargetHeightV125_)
Enum: "default" "tall"
"default"

ItemsHighlightModesV125

string (ItemsHighlightModesV125)
Enum: "no" "selected" "selectedAndConnected"
"no"

AnyObjectEsType_ItemsHighlightModesV125_

string (AnyObjectEsType_ItemsHighlightModesV125_)
Enum: "no" "selected" "selectedAndConnected"
"no"

EdgeGroupingModesV125

string (EdgeGroupingModesV125)
Enum: "singleEdge" "perDirection" "off"
"singleEdge"

AnyObjectEsType_EdgeGroupingModesV125_

string (AnyObjectEsType_EdgeGroupingModesV125_)
Enum: "singleEdge" "perDirection" "off"
"singleEdge"

ToolbarSettingsTypeV125

required
object
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV125_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV125_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV125_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV125_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV125_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV125)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV125)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV125_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV125_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV125_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timebar": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

AnyObjectEsType_ToolbarSettingsTypeV125_

required
object
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV125_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV125_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV125_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV125_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV125_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV125)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV125)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV125_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV125_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV125_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
{
  • "visualize": {
    },
  • "timebar": {
    },
  • "timeFilter": {
    },
  • "mapSettings": {
    },
  • "selectionSettings": {
    },
  • "expansionLayoutMode": {
    }
}

SavedGraphAttributesV125

version
required
number <integer>
Value: 125

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV125. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV125_)
required
object
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV125_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV125_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV125_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV125_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV125_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV125)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV125)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV125_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV125_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV125_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
required
object
searchSourceJSON
required
string <string>

Stringified JSON object

vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV125_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 125,
  • "visualizerHash": "string",
  • "toolbarSettings": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "nodesCount": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV125_

required
object (SavedGraphAttributesV125)
version
required
number <integer>
Value: 125

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV125. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV125_)
required
object
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV125_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV125_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV125_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV125_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV125_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV125)

map overlays and base layers

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV125_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV125_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV125_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
required
object
searchSourceJSON
required
string <string>

Stringified JSON object

vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV125_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedGraphAttributesV126

version
required
number <integer>
Value: 126

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV126. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV126_)
required
object
nodeCount
required
string (AnyObjectEsType_NodeCountModesV126_)
Enum: "connectedNodes" "connectedEdges" "off"
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV126_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV126_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV126_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV126_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV126_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV126)

map overlays and base layers

Array
type
required
string (PersistedLayerTypeV126)
Enum: "wfs" "wms" "pbf-basemap" "pbf-tile" "agg" "poi" "shape" "stored" "choropleth"
enabled
required
boolean

whether the layer is displayed

id
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV126_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV126_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV126_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
required
object
searchSourceJSON
required
string <string>

Stringified JSON object

vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV126_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

{
  • "version": 126,
  • "visualizerHash": "string",
  • "toolbarSettings": {
    },
  • "kibanaSavedObjectMeta": {
    },
  • "vedgeStyles": "string",
  • "collectionId": "string",
  • "lastSaveTime": 0,
  • "nodesCount": 0,
  • "count": 0,
  • "newDataModelEids": "string",
  • "newDataModelRecords": "string",
  • "sidebarState": "string",
  • "position": "string",
  • "zoom": 0.1,
  • "selectionColumns": {
    },
  • "selection": "string",
  • "graph": "string",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedGraphAttributesV126_

required
object (SavedGraphAttributesV126)
version
required
number <integer>
Value: 126

Graph object version

visualizerHash
required
string <string>

A hash created from DiffHashArrayV126. When the graph is created, this hash is generated from the visualizer and stored. Used to determine if the visualizer toolbar & sidebar settings has changed.

required
object (AnyObjectEsType_ToolbarSettingsTypeV126_)
required
object
nodeCount
required
string (AnyObjectEsType_NodeCountModesV126_)
Enum: "connectedNodes" "connectedEdges" "off"
edgeGrouping
required
string (AnyObjectEsType_EdgeGroupingModesV126_)
Enum: "singleEdge" "perDirection" "off"
invertRelations
required
boolean <boolean>

invert relations on graph visualize

highlight
required
string (AnyObjectEsType_ItemsHighlightModesV126_)
Enum: "no" "selected" "selectedAndConnected"
required
object
targetHeight
required
string (AnyObjectEsType_TimebarTargetHeightV126_)
Enum: "default" "tall"
mode
required
string (AnyObjectEsType_TimebarRenderingModeV126_)
Enum: "histogram" "saturn"
required
object
nodeVisibility
required
string (AnyObjectEsType_TimebarNodeVisibilityModesV126_)
Enum: "allNodes" "onlyNodesConnectedToItemWithTime" "onlyNodesWithTime"
enabled
required
boolean <boolean>

graph time filter mode

required
object
mapId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

Array of objects (MapLayerV126)

map overlays and base layers

nodeVisibility
required
string (AnyObjectEsType_MapNodeVisibilityModesV126_)
Enum: "allNodes" "nodesWithGeoAndConnection" "nodesWithGeoOnly"
heatmapEnabled
required
boolean <boolean>

graph heatmap mode on map mode

enabled
required
boolean <boolean>

graph map mode

required
object
mode
required
string (AnyObjectEsType_SelectionSettingsV126_)
Enum: "keep" "add" "replace"

Decides the selection of the added nodes after an expansion. keep - Keeps the current selection as it is add - Adds the new nodes to current selection replace - Replaces the current selection with the new nodes

required
object
mode
required
string (AnyObjectEsType_ExpansionLayoutModesV126_)
Enum: "freeExpansion" "moveSelected" "fixNodes"
required
object
searchSourceJSON
required
string <string>

Stringified JSON object

vedgeStyles
required
string <object>

Map containing the styles for the vedges

collectionId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

lastSaveTime
required
number <dateEpochMillis> (dateEpochMillis)

A date format for Unix timestamps (milliseconds since epoch).

nodesCount
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

count
required
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

newDataModelEids
required
string <string;>

Stringified map of entity identifiers

newDataModelRecords
required
string <string;>

Stringified map of entity ids and corresponding elastic search hit

sidebarState
required
string <string;>

Stringified object of the Graph's sidebar state

position
required
string <string>

Stringified map of X,Y coordinates for the Graph's center

zoom
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

selectionColumns
required
object (AnyObjectEsType_SelectionColumnsV126_)
selection
required
string <string>

Stringified array of the graph's selected nodes and combos

graph
required
string (BinaryBase64)
description
string <string>

Graph description

title
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV113

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 113

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 113,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV113_

required
object (SavedVisualizationAttributesV113)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 113

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedVisualizationAttributesV114

visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 114

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

{
  • "visState": "string",
  • "version": 114,
  • "uiStateJSON": "string",
  • "scriptIds": [
    ],
  • "savedSearchInherit": true,
  • "kibanaSavedObjectMeta": {
    },
  • "savedSearchId": "search:a14c5675-1fdd-4bfb-804c-b2f67594656a",
  • "description": "string",
  • "title": "string"
}

ObjectPayload_SavedVisualizationAttributesV114_

required
object (SavedVisualizationAttributesV114)
visState
required
string <string>

Visualization state

version
required
number <integer>
Value: 114

Visualization object version

uiStateJSON
required
string <string>

UI State used by Visualization

scriptIds
required
Array of strings

Ids of scripts on a Visualization

savedSearchInherit
required
boolean <boolean>

Is Visualization inherited from a savedSearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

savedSearchId
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.

description
required
string <string>

Description for Visualization

title
required
string <string>

Title for Visualization

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

SavedDataspaceAttributesV100

version
required
number <integer>
Value: 100

Dataspace object version

Array of objects (ShareDataspaceObjectV100)

An array of roles this dataspace is accessible to

Array
required
AccessLevelV100 (string) or string <keyword>

Access level associated to the role.

readOnly - Read only access to all objects in the dataspace.

privateCreator - Read only access to everything. Can create private dashboards, graphs and bookmarked searches.

sharedCreator - Read only access to everything. Can create and share dashboards, graphs and bookmarked searches.

contentManager - Read only access to everything. Can create, share, change and delete dashboards, graphs and bookmarked searches.

dataModelManager - Read/write/delete access to all objects in the dataspace.

dataspaceManager - Read/write/delete access to all objects in the dataspace and can change and delete the dataspace itself.

R - (deprecated) Same as readOnly

RW- (deprecated) Read/Write access

RWD - (deprecated) Same as dataspaceManager

Any of
string <keyword> (AccessLevelV100)
Enum: "readOnly" "privateCreator" "sharedCreator" "contentManager" "dataModelManager" "dataspaceManager"

Access level associated to the role.

readOnly - Read only access to all objects in the dataspace.

privateCreator - Read only access to everything. Can create private dashboards, graphs and bookmarked searches.

sharedCreator - Read only access to everything. Can create and share dashboards, graphs and bookmarked searches.

contentManager - Read only access to everything. Can create, share, change and delete dashboards, graphs and bookmarked searches.

dataModelManager - Read/write/delete access to all objects in the dataspace.

dataspaceManager - Read/write/delete access to all objects in the dataspace and can change and delete the dataspace itself.

R - (deprecated) Same as readOnly

RW- (deprecated) Read/Write access

RWD - (deprecated) Same as dataspaceManager

roleName
required
string <string>

Role name

icon
required
string <string>

Icon for Dataspace

colorCode
required
string <string>

Color code

description
string <string>

Description for Dataspace

title
required
string <string>

Title for Dataspace

shortCode
required
string <string> ^[a-z0-9\-_]+$

Alphanumeric string used to uniquely identify each dataspace

{
  • "version": 100,
  • "sharedWith": [
    ],
  • "icon": "string",
  • "colorCode": "string",
  • "description": "string",
  • "title": "string",
  • "shortCode": "string"
}

ObjectPayload_SavedDataspaceAttributesV100_

required
object (SavedDataspaceAttributesV100)
version
required
number <integer>
Value: 100

Dataspace object version

Array of objects (ShareDataspaceObjectV100)

An array of roles this dataspace is accessible to

Array
required
AccessLevelV100 (string) or string <keyword>

Access level associated to the role.

readOnly - Read only access to all objects in the dataspace.

privateCreator - Read only access to everything. Can create private dashboards, graphs and bookmarked searches.

sharedCreator - Read only access to everything. Can create and share dashboards, graphs and bookmarked searches.

contentManager - Read only access to everything. Can create, share, change and delete dashboards, graphs and bookmarked searches.

dataModelManager - Read/write/delete access to all objects in the dataspace.

dataspaceManager - Read/write/delete access to all objects in the dataspace and can change and delete the dataspace itself.

R - (deprecated) Same as readOnly

RW- (deprecated) Read/Write access

RWD - (deprecated) Same as dataspaceManager

roleName
required
string <string>

Role name

icon
required
string <string>

Icon for Dataspace

colorCode
required
string <string>

Color code

description
string <string>

Description for Dataspace

title
required
string <string>

Title for Dataspace

shortCode
required
string <string> ^[a-z0-9\-_]+$

Alphanumeric string used to uniquely identify each dataspace

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

object
excludeTypes
Array of strings

Option for which object types not to clone, only applies when create is true

includeTypes
Array of strings

Option for which object types to clone - clone all if undefined, only applies when create is true

create
required
boolean

Option whether to update or create a dataspace. Note - must be set to true if creating and false if updating

copyFrom
required
Array of strings

A stringified array of existing dataspace shortCodes, only applies when create is true

{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string",
  • "options": {
    }
}

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)
version
required
number <integer>
Value: 108

Search object version

compositePrimaryKeyFields
required
Array of strings <keyword> (keyword) [ items <keyword > ]

Array of fields used to construct the key for reconciliation.

required
object
object (ComputedFieldsScriptsV108)
required
Array of objects (ComputedFieldsScriptV108)
required
Array of objects (ComputedFieldV108)
object (ImportSettingsV108)
allowedFields
Array of strings <keyword> (keyword) [ items <keyword > ]

An optional list of fields that imported data can be mapped to. Defaults to all fields.

targetIndex
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

projectImportsEnabled
boolean

Whether the Entity Table is a possible upload target in the Upload center. Defaults to false.

object (EntityResolutionV108)
enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

required
Array of objects (DynamicFilterMappingV108)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

required
object (GlobalSearchSettingsV108)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV108)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV108)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV108)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

Responses

Request samples

Content type
application/json
Example
{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "acknowledged": true,
  • "error": {
    },
  • "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)
version
required
number <integer>
Value: 108

Search object version

compositePrimaryKeyFields
required
Array of strings <keyword> (keyword) [ items <keyword > ]

Array of fields used to construct the key for reconciliation.

required
object
object (ComputedFieldsScriptsV108)
required
Array of objects (ComputedFieldsScriptV108)
required
Array of objects (ComputedFieldV108)
object (ImportSettingsV108)
allowedFields
Array of strings <keyword> (keyword) [ items <keyword > ]

An optional list of fields that imported data can be mapped to. Defaults to all fields.

targetIndex
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

projectImportsEnabled
boolean

Whether the Entity Table is a possible upload target in the Upload center. Defaults to false.

object (EntityResolutionV108)
enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

required
Array of objects (DynamicFilterMappingV108)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

required
object (GlobalSearchSettingsV108)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV108)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV108)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV108)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

Responses

Request samples

Content type
application/json
Example
{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "acknowledged": true,
  • "error": {
    },
  • "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)
version
required
number <integer>
Value: 108

Search object version

compositePrimaryKeyFields
required
Array of strings <keyword> (keyword) [ items <keyword > ]

Array of fields used to construct the key for reconciliation.

required
object
object (ComputedFieldsScriptsV108)
required
Array of objects (ComputedFieldsScriptV108)
required
Array of objects (ComputedFieldV108)
object (ImportSettingsV108)
allowedFields
Array of strings <keyword> (keyword) [ items <keyword > ]

An optional list of fields that imported data can be mapped to. Defaults to all fields.

targetIndex
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

projectImportsEnabled
boolean

Whether the Entity Table is a possible upload target in the Upload center. Defaults to false.

object (EntityResolutionV108)
enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

required
Array of objects (DynamicFilterMappingV108)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

required
object (GlobalSearchSettingsV108)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV108)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV108)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV108)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

Responses

Request samples

Content type
application/json
Example
{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "acknowledged": true,
  • "error": {
    },
  • "action": "string",
  • "status": 0,
  • "warning": "string",
  • "version": "string",
  • "attributes": null,
  • "namespace": "string",
  • "type": "string",
  • "id": "string"
}

DeleteObjectDefinition

Authorizations:
basicAuth
path Parameters
id
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": [
    ],
  • "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)
version
required
number <integer>
Value: 108

Search object version

compositePrimaryKeyFields
required
Array of strings <keyword> (keyword) [ items <keyword > ]

Array of fields used to construct the key for reconciliation.

required
object
object (ComputedFieldsScriptsV108)
required
Array of objects (ComputedFieldsScriptV108)
required
Array of objects (ComputedFieldV108)
object (ImportSettingsV108)
allowedFields
Array of strings <keyword> (keyword) [ items <keyword > ]

An optional list of fields that imported data can be mapped to. Defaults to all fields.

targetIndex
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

projectImportsEnabled
boolean

Whether the Entity Table is a possible upload target in the Upload center. Defaults to false.

object (EntityResolutionV108)
enabled
required
boolean

Whether this search represents an entity resolution Entity Table.

required
Array of objects (DynamicFilterMappingV108)
Array
filterId
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

field
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

required
object
required
Array of objects (PerspectiveInfoV103)

Record table, can be an empty array

required
Array of objects (PerspectiveInfoV103)

Record view, can be an empty array

required
object (GlobalSearchSettingsV108)
selectedByDefault
required
boolean <boolean>

Is the Entity table selected by default in searches

forceSearchedOnTimeFilter
required
boolean <boolean>

Should include documents that do not contain a timefield in search results, if there is a time filter applied.

Array of objects (GlobalSearchRecencyBoostRangeV108)

Global search boost configuration for recent records

boost
required
number <double> (double)

A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.

enabled
required
boolean <boolean>

Property to enable/disable globalSearch

object
fields
required
string <string>

Fields name

object (RevisionSettingsV108)
copyToFields
object
indexingScope
required
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string (EditableFieldsModeV108)
Enum: "whitelist" "blacklist"
primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

isEditable
required
boolean <boolean>

Property to enable/disable revision

index
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object
maxJoinCardinalityApplyToTarget
boolean <boolean>

Property to apply max join cardinality to target

maxJoinCardinalityApplyToSource
boolean <boolean>

Property to apply max join cardinality to source

maxJoinCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxJoinCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxJoinCardinalityEnabled
boolean <boolean>

Property to enable max join cardinality required when maxJoinCardinality or maxJoinCardinalityUnit are defined

maxCardinalityUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxCardinality
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxCardinalityEnabled
boolean <boolean>

Property to enable max cardinality required when maxCardinality or maxCardinalityUnit are defined

maxTimeRangeUnit
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

maxTimeRange
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

maxTimeRangeEnabled
boolean <boolean>

Property to enable max time range required when maxTimeRange or maxTimeRangeUnit are defined

required
object
instanceImageValue
string <string>

Search instance image value

instanceImageType
string <string>

Search instance image type

instanceLabelValue
string <string>

Search instance label value

instanceLabelType
string <string>

Search instance label type

shortDescription
required
string <string>

Short description

color
required
string <string>

Search icon color

icon
required
string <string>

Search icon to display

samplingScriptId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

indexingScope
string (IndexingScopeStringV108)
Enum: "G:S" "G:NS" "L" "N"
parentId
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it is stored into the inverted index.

object (IndexPatternAttributesV108)
error
any
fieldFormatMap
string <string>

Format maps for the search fields

excludeIndices
boolean <boolean>

Is excluded indice true/false

sourceFilters
string <string>

Source filters for the search

fields
required
string <string>

Stringified array having fields for search

intervalName
string <string>

Interval name for the search

timeFieldName
string <string> non-empty

Time field name for the search

pattern
required
string <string>

Index pattern name in elasticsearch

required
object
searchSourceJSON
required
string <string>

Stringified JSON object

sort
Array of strings

Sort string array

columns
Array of strings

Search columns name array

hits
number <integer> (integer)

A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1.

description
string <string>

An optional description for search

title
required
string <string>

Title for search

isGlobal
boolean <boolean>

Is global true/false

version
string <string>

Version of document stored in Elasticsearch document meta

Responses

Request samples

Content type
application/json
Example
{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "acknowledged": true,
  • "error": {
    },
  • "action": "string",
  • "status": 0,
  • "warning": "string",
  • "version": "string",
  • "attributes": null,
  • "namespace": "string",
  • "type": "string",
  • "id": "string"
}