Api version - v1

CreateObjectDefinition

API to create an object definition

Authorizations:
basicAuth
path Parameters
type
required
string (ObjectDefinitionType)
Enum: "search" "eid" "relation" "sirenapiscript" "dataspace"

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

query Parameters
dataspace
string
Request Body schema: application/json
Any of
required
object (SavedSearchAttributes)
version
required
number <integer>
Value: 103

Search object version

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

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

field
required
string <keyword> (keyword)

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

required
object
required
Array of objects

Record table, can be an empty array

required
Array of objects

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
copyToFields
object
indexingScope
required
string <keyword>
Enum: "G:S" "G:NS" "L" "N"

Scope of revision

editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string <keyword>
Enum: "whitelist" "blacklist"

Editable fields mode; 'whitelist' or 'blacklist'

primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it’s 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’s 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’s 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’s 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’s 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’s 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’s stored into the inverted index.

object
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

Responses

Request samples

Content type
application/json
Example
{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "acknowledged": true,
  • "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" "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
Request Body schema: application/json
Any of
required
object (SavedSearchAttributes)
version
required
number <integer>
Value: 103

Search object version

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

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

field
required
string <keyword> (keyword)

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

required
object
required
Array of objects

Record table, can be an empty array

required
Array of objects

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
copyToFields
object
indexingScope
required
string <keyword>
Enum: "G:S" "G:NS" "L" "N"

Scope of revision

editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string <keyword>
Enum: "whitelist" "blacklist"

Editable fields mode; 'whitelist' or 'blacklist'

primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it’s 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’s 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’s 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’s 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’s 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’s 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’s stored into the inverted index.

object
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

Responses

Request samples

Content type
application/json
Example
{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "acknowledged": true,
  • "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" "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
Request Body schema: application/json
Any of
required
object (SavedSearchAttributes)
version
required
number <integer>
Value: 103

Search object version

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

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

field
required
string <keyword> (keyword)

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

required
object
required
Array of objects

Record table, can be an empty array

required
Array of objects

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
copyToFields
object
indexingScope
required
string <keyword>
Enum: "G:S" "G:NS" "L" "N"

Scope of revision

editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string <keyword>
Enum: "whitelist" "blacklist"

Editable fields mode; 'whitelist' or 'blacklist'

primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it’s 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’s 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’s 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’s 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’s 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’s 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’s stored into the inverted index.

object
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

Responses

Request samples

Content type
application/json
Example
{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "acknowledged": true,
  • "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" "dataspace"

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

Request Body schema: application/json
Any of
required
object (SavedSearchAttributes)
version
required
number <integer>
Value: 103

Search object version

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

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

field
required
string <keyword> (keyword)

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

required
object
required
Array of objects

Record table, can be an empty array

required
Array of objects

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
copyToFields
object
indexingScope
required
string <keyword>
Enum: "G:S" "G:NS" "L" "N"

Scope of revision

editableFieldsExceptions
required
Array of strings

Field name exceptions list

editableFieldsMode
required
string <keyword>
Enum: "whitelist" "blacklist"

Editable fields mode; 'whitelist' or 'blacklist'

primaryKey
required
string <keyword> (keyword)

A string mapped as keyword. This will not be analyzed before it’s 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’s 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’s 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’s 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’s 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’s 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’s stored into the inverted index.

object
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

Responses

Request samples

Content type
application/json
Example
{
  • "attributes": {
    },
  • "isGlobal": true,
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "acknowledged": true,
  • "action": "string",
  • "status": 0,
  • "warning": "string",
  • "version": "string",
  • "attributes": null,
  • "namespace": "string",
  • "type": "string",
  • "id": "string"
}