Skip to main content
API docs by Redocly

metadata (1.1)

Download OpenAPI specification:Download

Provides robolog metadata management capabilities, including custom metadata field configuration, robolog metadata values, and supplementary file associations.

See our Getting Started documentation for more detailed information on how to use our API.

fields

Fields define common sets of attributes for your organization's robologs.

Returns a list of fields owned by your organization.

Returns a list of all fields owned by your organization.

query Parameters
show_deactivated
boolean
page_size
integer [ 0 .. 100000 ]

The number of results to display per response page. The default is the maximum.

page_number
integer >= 1
Default: 1

The desired page number, starting from 1. For instance, if page_size=100, then page_number=2 will contain items 101-200.

robolog_type
string (RobologType)
Enum: "ROS1Bag" "ROS2Bag" "ROS2BagMCAP" "GENERATED" "ULOG" "JSON" "UNKNOWN"

The type of robolog which this request should be performed for.

is_extrinsic
boolean
type
string (FieldType)
Enum: "TEXT" "TIMESTAMP" "INTEGER" "DECIMAL" "BOOLEAN" "ONTOLOGY" "DURATION"

The data type of this field, typically TEXT. Field values can be made up of composite types (i.e. objects, arrays), but it is recommended that they represent primitives (strings, timestamps, numbers, booleans)

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "items": [
    ]
}

Creates new metadata field(s) for your organization.

Creates new metadata fields for your organization. Use POST /robologs/{id}/values to create values for a field.

Request Body schema: application/json
alias
string <= 255 characters ^[a-zA-z_][a-zA-z0-9 _\-]*$

Alias is the name used to identify the field. Field aliases must be unique.

definition
string <= 1000 characters

a string in the jq format which identifies where this value can be found in a JSON or YAML metadata file.

description
string <= 1000 characters

an optional description of the field

input_format
string (InputFormat)
Enum: "" "RFC3339" "EPOCH_SECONDS" "EPOCH_NANOSECONDS" "SECONDS" "NANOSECONDS"

The expected input format for this field. Not required. Does not affect how the value is displayed. The empty-string value ("") can be used to clear this property, resetting it to default. Examples:

  • RFC3339 - "2020-09-19T16:23:19.773Z"
  • EPOCH_SECONDS - "1600554199"
  • EPOCH_NANOSECONDS - "1600554199773829010"
  • SECONDS - "119"
  • NANOSECONDS - "119087036115"
is_extrinsic
boolean

is_extrinsic must be set to true if the field represents information not found directly within the robolog metadata; for example a tag, triage-annotation, or similar. Extrinsic field values can be supplied from supplementary robolog files or using the API.

model_prime_field
string <uuid>

ModelPrimeField is an optional parameter for the identifier of a Model Prime field which has already been defined

ontology_id
string

To create a field of type ONTOLOGY, provide the ID of the ontology you wish to link to.

robolog_type
string (RobologType)
Enum: "ROS1Bag" "ROS2Bag" "ROS2BagMCAP" "GENERATED" "ULOG" "JSON" "UNKNOWN"

A string enum specifying the type of robolog associated with a resource. We recommended specifying the RobologType wherever it aids in avoiding ambiguity.

type
string (FieldType)
Enum: "TEXT" "TIMESTAMP" "INTEGER" "DECIMAL" "BOOLEAN" "ONTOLOGY" "DURATION"

The data type of this field, typically TEXT. Field values can be made up of composite types (i.e. objects, arrays), but it is recommended that they represent primitives (strings, timestamps, numbers, booleans)

Responses

Request samples

Content type
application/json
{
  • "alias": "Location",
  • "definition": ".rosbag2_bagfile_information.starting_time.nanoseconds_since_epoch",
  • "description": "optional field description",
  • "input_format": "",
  • "is_extrinsic": false,
  • "model_prime_field": "dccc049a-6bc4-4e48-93a4-2bd20059ac81",
  • "ontology_id": "string",
  • "robolog_type": "ROS1Bag",
  • "type": "TEXT"
}

Response samples

Content type
application/json
{
  • "alias": "Location",
  • "client_id": "f5b1f0e0-96fa-4dc0-998f-3516908b0328",
  • "deactivated_at": "2019-08-24T14:15:22Z",
  • "definition": ".rosbag2_bagfile_information.starting_time.nanoseconds_since_epoch",
  • "description": "Robolog ID is a unique identifier for the robolog.",
  • "id": "da6eacd7-9176-43f3-ab89-cb4673bce556",
  • "input_format": "",
  • "is_extrinsic": true,
  • "model_prime_field": {
    },
  • "ontology_id": "string",
  • "robolog_type": "ROS1Bag",
  • "type": "TEXT"
}

Deactivates a field.

Deactivates a field, making it unavailable for storing new metadata values. Deactivated fields are unable to be updated by default and are not returned when listing your organization's fields. When a field is deactivated, metadata values associated with it are still available in search.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

query Parameters
hard
boolean
Default: false

If set to true, the data will be immediately, irreversibly deleted. Otherwise, it is simply marked for deletion, and can be recovered until it is fully deleted by any configured data retention policies.

Responses

Response samples

Content type
application/json
{
  • "alias": "Location",
  • "client_id": "f5b1f0e0-96fa-4dc0-998f-3516908b0328",
  • "deactivated_at": "2019-08-24T14:15:22Z",
  • "definition": ".rosbag2_bagfile_information.starting_time.nanoseconds_since_epoch",
  • "description": "Robolog ID is a unique identifier for the robolog.",
  • "id": "da6eacd7-9176-43f3-ab89-cb4673bce556",
  • "input_format": "",
  • "is_extrinsic": true,
  • "model_prime_field": {
    },
  • "ontology_id": "string",
  • "robolog_type": "ROS1Bag",
  • "type": "TEXT"
}

Returns the field properties.

Returns the field properties for the specified field id.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

query Parameters
robolog_type
string (RobologType)
Enum: "ROS1Bag" "ROS2Bag" "ROS2BagMCAP" "GENERATED" "ULOG" "JSON" "UNKNOWN"

The type of robolog which this request should be performed for.

Responses

Response samples

Content type
application/json
{
  • "alias": "Location",
  • "client_id": "f5b1f0e0-96fa-4dc0-998f-3516908b0328",
  • "deactivated_at": "2019-08-24T14:15:22Z",
  • "definition": ".rosbag2_bagfile_information.starting_time.nanoseconds_since_epoch",
  • "description": "Robolog ID is a unique identifier for the robolog.",
  • "id": "da6eacd7-9176-43f3-ab89-cb4673bce556",
  • "input_format": "",
  • "is_extrinsic": true,
  • "model_prime_field": {
    },
  • "ontology_id": "string",
  • "robolog_type": "ROS1Bag",
  • "type": "TEXT"
}

Updates the properties of a field.

Updates a fields's properties, such as alias or description.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

query Parameters
robolog_type
string (RobologType)
Enum: "ROS1Bag" "ROS2Bag" "ROS2BagMCAP" "GENERATED" "ULOG" "JSON" "UNKNOWN"

The type of robolog which this request should be performed for.

Request Body schema: application/json
required

The field properties you want to update

alias
string <= 255 characters ^[a-zA-z_][a-zA-z0-9 _\-]*$

Alias is the name used to identify the field. Field aliases must be unique.

definition
string <= 1000 characters

a string in the jq format which identifies where this value can be found in a JSON or YAML metadata file.

description
string <= 1000 characters

an optional description of the field

input_format
string (InputFormat)
Enum: "" "RFC3339" "EPOCH_SECONDS" "EPOCH_NANOSECONDS" "SECONDS" "NANOSECONDS"

The expected input format for this field. Not required. Does not affect how the value is displayed. The empty-string value ("") can be used to clear this property, resetting it to default. Examples:

  • RFC3339 - "2020-09-19T16:23:19.773Z"
  • EPOCH_SECONDS - "1600554199"
  • EPOCH_NANOSECONDS - "1600554199773829010"
  • SECONDS - "119"
  • NANOSECONDS - "119087036115"
is_extrinsic
boolean

is_extrinsic must be set to true if the field represents information not found directly within the robolog metadata; for example a tag, triage-annotation, or similar. Extrinsic field values can be supplied from supplementary robolog files or using the API.

model_prime_field
string

model_prime_field is used to establish a connection between this field and a predefined Model-Prime field.

robolog_type
string (RobologType)
Enum: "ROS1Bag" "ROS2Bag" "ROS2BagMCAP" "GENERATED" "ULOG" "JSON" "UNKNOWN"

A string enum specifying the type of robolog associated with a resource. We recommended specifying the RobologType wherever it aids in avoiding ambiguity.

Responses

Request samples

Content type
application/json
{
  • "alias": "Location",
  • "definition": ".rosbag2_bagfile_information.starting_time.nanoseconds_since_epoch",
  • "description": "optional field description",
  • "input_format": "",
  • "is_extrinsic": false,
  • "model_prime_field": "string",
  • "robolog_type": "ROS1Bag"
}

Response samples

Content type
application/json
{
  • "alias": "Location",
  • "client_id": "f5b1f0e0-96fa-4dc0-998f-3516908b0328",
  • "deactivated_at": "2019-08-24T14:15:22Z",
  • "definition": ".rosbag2_bagfile_information.starting_time.nanoseconds_since_epoch",
  • "description": "Robolog ID is a unique identifier for the robolog.",
  • "id": "da6eacd7-9176-43f3-ab89-cb4673bce556",
  • "input_format": "",
  • "is_extrinsic": true,
  • "model_prime_field": {
    },
  • "ontology_id": "string",
  • "robolog_type": "ROS1Bag",
  • "type": "TEXT"
}

Deletes the field definition for the specified robolog type.

Deletes the field definition for the specified robolog type. If a definition for the given robolog type does not exist, an error will be returned.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

query Parameters
robolog_type
required
string (RobologType)
Enum: "ROS1Bag" "ROS2Bag" "ROS2BagMCAP" "GENERATED" "ULOG" "JSON" "UNKNOWN"

The type of robolog which this request should be performed for.

Responses

Returns the field's definitions.

Returns a page of definitions for the specified field. There may be multiple definitions for a field — one per robolog type. If no robolog type is specified, all definitions for the field will be returned.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

query Parameters
robolog_type
string (RobologType)
Enum: "ROS1Bag" "ROS2Bag" "ROS2BagMCAP" "GENERATED" "ULOG" "JSON" "UNKNOWN"

The type of robolog which this request should be performed for.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ]
}

Updates the field definition for the specified robolog type.

Updates a field definition for the specified robolog type. If a definition for the specified robolog type does not exist, a definition will be created.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

query Parameters
robolog_type
required
string (RobologType)
Enum: "ROS1Bag" "ROS2Bag" "ROS2BagMCAP" "GENERATED" "ULOG" "JSON" "UNKNOWN"

The type of robolog which this request should be performed for.

Request Body schema: application/json
required

The definition to be updated for the field.

definition
required
string

The field definition to be updated.

input_format
string (InputFormat)
Enum: "" "RFC3339" "EPOCH_SECONDS" "EPOCH_NANOSECONDS" "SECONDS" "NANOSECONDS"

The expected input format for this field. Not required. Does not affect how the value is displayed. The empty-string value ("") can be used to clear this property, resetting it to default. Examples:

  • RFC3339 - "2020-09-19T16:23:19.773Z"
  • EPOCH_SECONDS - "1600554199"
  • EPOCH_NANOSECONDS - "1600554199773829010"
  • SECONDS - "119"
  • NANOSECONDS - "119087036115"

Responses

Request samples

Content type
application/json
{
  • "definition": "string",
  • "input_format": ""
}

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "definition": ".rosbag2_bagfile_information.starting_time.nanoseconds_since_epoch",
  • "field_id": "da6eacd7-9176-43f3-ab89-cb4673bce556",
  • "input_format": "",
  • "robolog_type": "ROS1Bag",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Creates a new field definition for the specified robolog type.

Creates a new field definition for the specified robolog type, which is used by the Model-Prime platform when ingesting metadata values from your organization's robologs. If a definition of the given robolog type exists for the field, an error will be returned. Use POST /fields/{id}/definitions to update an existing definition.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

Request Body schema: application/json
required
definition
required
string

A JQ query string defining the filter for the metadata value within a JSON or YAML metadata file.

input_format
string (InputFormat)
Enum: "" "RFC3339" "EPOCH_SECONDS" "EPOCH_NANOSECONDS" "SECONDS" "NANOSECONDS"

The expected input format for this field. Not required. Does not affect how the value is displayed. The empty-string value ("") can be used to clear this property, resetting it to default. Examples:

  • RFC3339 - "2020-09-19T16:23:19.773Z"
  • EPOCH_SECONDS - "1600554199"
  • EPOCH_NANOSECONDS - "1600554199773829010"
  • SECONDS - "119"
  • NANOSECONDS - "119087036115"
robolog_type
required
string (RobologType)
Enum: "ROS1Bag" "ROS2Bag" "ROS2BagMCAP" "GENERATED" "ULOG" "JSON" "UNKNOWN"

A string enum specifying the type of robolog associated with a resource. We recommended specifying the RobologType wherever it aids in avoiding ambiguity.

Responses

Request samples

Content type
application/json
{
  • "definition": "string",
  • "input_format": "",
  • "robolog_type": "ROS1Bag"
}

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "definition": ".rosbag2_bagfile_information.starting_time.nanoseconds_since_epoch",
  • "field_id": "da6eacd7-9176-43f3-ab89-cb4673bce556",
  • "input_format": "",
  • "robolog_type": "ROS1Bag",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Restores one or more deactivated fields.

Restores one or more deactivated fields. Any values associated with the fields before deactivation will also be restored unless the values themselves have been deleted.

Request Body schema: application/json
ids
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "count": 1,
  • "items": [
    ]
}

Idempotently creates the inherent Model-Prime fields.

Idempotently creates the fields for your organization that are required for your organization to ingest robologs into the Model-Prime platform, including intrinsic fields for the specified robolog type.

query Parameters
robolog_type
string (RobologType)
Enum: "ROS1Bag" "ROS2Bag" "ROS2BagMCAP" "GENERATED" "ULOG" "JSON" "UNKNOWN"

The type of robolog which this request should be performed for.

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "items": [
    ]
}

model-prime fields

Model-Prime fields allow your organization's custom fields to be linked to common concepts in the Model-Prime platform.

Lists all Model-Prime fields.

query Parameters
page_size
integer [ 0 .. 100000 ]

The number of results to display per response page. The default is the maximum.

page_number
integer >= 1
Default: 1

The desired page number, starting from 1. For instance, if page_size=100, then page_number=2 will contain items 101-200.

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "items": [
    ]
}

Returns the properties of a Model-Prime field.

Returns the properties of a Model-Prime field.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

Responses

Response samples

Content type
application/json
{
  • "description": "Robolog ID is a unique identifier for a robolog which is generated during ingestion. It is used in later requests to retrieve or update data regarding the robolog it identifies.",
  • "field_name": "Robolog ID",
  • "id": "da6eacd7-9176-43f3-ab89-cb4673bce556",
  • "is_inherent": true,
  • "type": "TEXT"
}

robologs

Robologs represent robotics logs and related files managed by the Model-Prime platform.

Returns the robolog location having the specified URI.

query Parameters
uri
string

the URI corresponding to a robolog location.

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "data_store": "string",
  • "evicted_at": "2019-08-24T14:15:22Z",
  • "evicted_by": "99aaa855-d9e5-4813-b12d-9e44fc16cc57",
  • "file_path": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "robolog_id": "6ccbb5c1-4e10-41af-a0e6-5090b62433fd",
  • "storage_kind": "string",
  • "uri": "string"
}

Returns the robolog location with the specified ID.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "data_store": "string",
  • "evicted_at": "2019-08-24T14:15:22Z",
  • "evicted_by": "99aaa855-d9e5-4813-b12d-9e44fc16cc57",
  • "file_path": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "robolog_id": "6ccbb5c1-4e10-41af-a0e6-5090b62433fd",
  • "storage_kind": "string",
  • "uri": "string"
}

Returns a paginated list of robologs ordered by most recently ingested. Each robolog contains a robolog id and the ingestion date.

query Parameters
page_size
integer [ 0 .. 100 ]

The number of results to display per response page. The default is the maximum.

page_number
integer >= 1
Default: 1

The desired page number, starting from 1. For instance, if page_size=100, then page_number=2 will contain items 101-200.

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "items": [
    ]
}

Deletes a robolog from the Model-Prime platform.

Deletes a robolog from the Model-Prime platform. When hard is set to true, the robolog is completely removed from the Model-Prime platform. If hard is set to false, the robolog is soft-deleted and may be restored with the POST /robologs:restore endpoint. Deleted robologs will not be returned in robolog queries regardless of whether they were soft- or hard-deleted.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

query Parameters
hard
boolean
Default: false

If set to true, the data will be immediately, irreversibly deleted. Otherwise, it is simply marked for deletion, and can be recovered until it is fully deleted by any configured data retention policies.

Responses

Response samples

Content type
application/json
{
  • "hard_delete": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Returns a paginated list of every channel instance associated to this robolog.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

query Parameters
page_size
integer [ 0 .. 1000 ]

The number of results to display per response page. The default is the maximum.

page_number
integer >= 1
Default: 1

The desired page number, starting from 1. For instance, if page_size=100, then page_number=2 will contain items 101-200.

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "items": [
    ]
}

Returns the locations of the specified robolog.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

query Parameters
page_number
integer >= 1
Default: 1

The desired page number, starting from 1. For instance, if page_size=100, then page_number=2 will contain items 101-200.

page_size
integer [ 0 .. 100000 ]

The number of results to display per response page. The default is the maximum.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ]
}

Returns a paginated list of all metadata values associated to the specified robolog.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

query Parameters
show_deactivated
boolean
page_size
integer [ 0 .. 100000 ]

The number of results to display per response page. The default is the maximum.

page_number
integer >= 1
Default: 1

The desired page number, starting from 1. For instance, if page_size=100, then page_number=2 will contain items 101-200.

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "items": [
    ]
}

Creates new metadata values for the specified robolog.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

Request Body schema: application/json
Array
channels
Array of strings <uuid> [ items <uuid > ]

Channels is the list of channel ids for which the field and its value would be applied

field_alias
string

FieldAlias is the client provided name which can be used to identify it in comparison to other fields

field_id
string <uuid>

FieldID is the previously generated unique identifier for the client field being set

id
string <uuid>

Id is the value's UUID

object (Interval)
value
required
any

Value is the value of the field being set

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Updates existing metadata values for the specified robolog.

Updates existing metadata values for the specified robolog. This endpoint return an error if the specified robolog id does not exist, if any provided fields are not configured for your organization, or if any provided value ids do not exist for the specified robolog.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

Request Body schema: application/json
Array
channels
Array of strings <uuid> [ items <uuid > ]

Channels is the list of channel ids for which the field and its value would be applied

id
required
string <uuid>

ID is the unique identifier for an individual value within a robolog

object (Interval)
value
required
any

Value is the value of the field being set

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Deletes the specified value from a robolog.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

field_value_id
required
string <uuid>

the unique identifier for an individual value within a robolog

query Parameters
hard
boolean
Default: false

If set to true, the data will be immediately, irreversibly deleted. Otherwise, it is simply marked for deletion, and can be recovered until it is fully deleted by any configured data retention policies.

Responses

Returns the specified value for the specified robolog.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

field_value_id
required
string <uuid>

the unique identifier for an individual value within a robolog

Responses

Response samples

Content type
application/json
{
  • "channels": [
    ],
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "field_alias": "Ontology Label",
  • "field_id": "da6eacd7-9176-43f3-ab89-cb4673bce556",
  • "interval": {
    },
  • "raw_value": 1698183127.123456,
  • "value": "Sensor Anomaly"
}

Updates the specified metadata value for the specified robolog.

Updates a single existing metadata value offor the specified robolog. This endpoint will fail if the specified robolog id does not exist, if the specifiedd field is not configured for your organization, or if the value id does not exist for the specified robolog.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

field_value_id
required
string <uuid>

the unique identifier for an individual value within a robolog

Request Body schema: application/json
channels
Array of strings <uuid> [ items <uuid > ]

Channels is the list of channel ids for which the field and its value would be applied

object (Interval)
value
required
any

Value is the value of the field being set

Responses

Request samples

Content type
application/json
{
  • "channels": [
    ],
  • "interval": {
    },
  • "value": "Sensor Anomaly"
}

Response samples

Content type
application/json
{
  • "channels": [
    ],
  • "created_at": "2023-04-24T14:45:40Z",
  • "creator_id": "f5b1f0e0-96fa-4dc0-998f-3516908b0328",
  • "creator_type": "user",
  • "deleted_at": "2023-04-24T14:45:40Z",
  • "field_alias": "Ontology Label",
  • "field_id": "da6eacd7-9176-43f3-ab89-cb4673bce556",
  • "id": "da6eacd7-9176-43f3-ab89-cb4673bce556",
  • "interval": {
    },
  • "raw_value": 1698183127.123456,
  • "value": "Sensor Anomaly"
}

Restores a soft-deleted robolog.

Restores a soft-deleted robolog. Restoration of a hard-deleted robolog is not possible.

Request Body schema: application/json
ids
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

channels

Returns a paginated list of channels found in your organization's robolog data

query Parameters
page_number
integer >= 1
Default: 1

The desired page number, starting from 1. For instance, if page_size=100, then page_number=2 will contain items 101-200.

page_size
integer [ 0 .. 1000 ]

The number of results to display per response page. The default is the maximum.

name
string

identify a channel by name

table
string

identify a channel by its underlying table name

show_latest_schema
boolean
Default: true

if set, the latest schema (if any) will be provided with each channel result.

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "items": [
    ]
}

Returns a paginated list of observed message schemas for this channel.

Message schemas are read and recorded during introspective ingest into the Analytics Platform. Channel schemas are listed in reverse chronological order based on when they were first recorded.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

query Parameters
page_number
integer >= 1
Default: 1

The desired page number, starting from 1. For instance, if page_size=100, then page_number=2 will contain items 101-200.

page_size
integer [ 0 .. 1000 ]

The number of results to display per response page. The default is the maximum.

Responses

Response samples

Content type
application/json
{
  • "channel_table": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "latest_schema": {
    },
  • "name": "/odom",
  • "count": 1,
  • "items": [
    ]
}

supplements

Deletes all supplemental associations for the specified robolog.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

Responses

Returns the existing supplemental robologs for the specidfied robolog

path Parameters
id
required
string <uuid>

the unique identifier for the resource

Responses

Response samples

Content type
application/json
{
  • "children": [
    ],
  • "parent": {
    }
}

Creates supplemental associations between the specified robologs.

Creates parent and/or child associations between the specified robolog and the robologs provided in the request body. This operation is idempotent.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

Request Body schema: application/json
children
Array of strings <uuid> [ items <uuid > ]

the UUIDS of any child robologs.

parent
string <uuid>

the UUID of the parent robolog.

Responses

Request samples

Content type
application/json
{
  • "children": [
    ],
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999"
}

Response samples

Content type
application/json
{
  • "children": [
    ],
  • "parent": {
    }
}

Adds supplemental associations for the specified robolog.

Adds parent and/or child associations for the specified robolog without deleting existing associations. This operation is idempotent.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

Request Body schema: application/json
children
Array of strings <uuid> [ items <uuid > ]

the UUIDS of any child robologs.

parent
string <uuid>

the UUID of the parent robolog.

Responses

Request samples

Content type
application/json
{
  • "children": [
    ],
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999"
}

Response samples

Content type
application/json
{
  • "children": [
    ],
  • "parent": {
    }
}

Lists parent and child candidate robologs for the specified robolog.

Returns robologs which are candidates for being either parent or child files to the specified robolog based on robolog name matching criteria. Returns an empty list if no candidate robologs are found.

path Parameters
id
required
string <uuid>

the unique identifier for the resource

Responses

Response samples

Content type
application/json
{
  • "children": [
    ],
  • "parents": [
    ]
}