Metadata

The Metadata endpoint provides detailed metadata about time series tags. This includes information such as the human-readable name of the signal, description, units of measure, data source, scaling factor, valid range, and mappings to other naming domains. Use this endpoint to understand what a particular time series represents.

Get metadata from the id domain

get

Authorizations

authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idsstringOptional

A comma-separated list of one or more GUIDs

Example: ba529839-8179-40e2-b3fb-5da01a8d76e8,e8317666-77f2-4185-ae48-847af57563db

Query parameters

formatstring · enumOptional

Desired output format of the data. You can also specify the response format via the HTTP Accept Header instead of the format query parameter.

Default: jsonPossible values:

verbosebooleanOptional

When true, includes human-readable names for the corresponding VIS path elements in vis-3-8a domainIds. If false (or omitted), regular domainIds are returned.

Default: false

Header parameters

x-api-versionstring · enumOptional

API version

Default: 2025-10-31Possible values:

Responses

200

Response from the route

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/metadata/id/{ids}

HTTPcURLJavaScriptPython

GET /{ENVIRONMENT}/metadata/id/{ids} HTTP/1.1
Host: prism.raalabs.io/{ENVIRONMENT}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ba529839-8179-40e2-b3fb-5da01a8d76e8": {
    "description": "Open door #0",
    "mapsTo": {
      "jsmea": "IMO1000001/jsmea_mac/MainEngine/Fuel/Input/Inlet/Energy/",
      "raalabs": "IMO1000001/ME FuelEnergy_0"
    },
    "name": "BEEF0",
    "rangeHigh": 0,
    "rangeLow": -1,
    "scale": 1,
    "source": "Matrix",
    "timeSeriesId": "ba529839-8179-40e2-b3fb-5da01a8d76e8",
    "uom": "Joule",
    "vesselImo": "1000001",
    "vesselName": "Blue Whale"
  },
  "e8317666-77f2-4185-ae48-847af57563db": {
    "description": "Open door #1",
    "mapsTo": {
      "jsmea": "IMO1000001/jsmea_mac/MainEngine/Fuel/Input/Inlet/Energy/",
      "raalabs": "IMO1000001/ME FuelEnergy_1"
    },
    "name": "BEEF1",
    "rangeHigh": 1,
    "rangeLow": -1,
    "scale": 1,
    "source": "Matrix",
    "timeSeriesId": "e8317666-77f2-4185-ae48-847af57563db",
    "uom": "Joule",
    "vesselImo": "1000001",
    "vesselName": "Blue Whale"
  }
}

Get metadata from the jsmea domain

get

Get metadata from the jsmea domain

Authorizations

authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

imo_numberstringOptional

The IMO number of the vessel to retrieve from

Example: IMO1000002

naming_rulestringOptional

The naming rule to use for retrieval

Example: jsmea_mac

categorystringOptional

The category to retrieve from

Example: MainEngine

sub_categorystringOptional

The sub category to retrieve from

Example: Fuel

contentstringOptional

The content to retrieve from

Example: Input

positionstringOptional

The position to retrieve from

Example: Inlet

itemstringOptional

The item to retrieve from

Example: Energy

modifierstringOptional

The modifier to retrieve from

Query parameters

formatstring · enumOptional

Desired output format of the data. You can also specify the response format via the HTTP Accept Header instead of the format query parameter.

Default: jsonPossible values:

verbosebooleanOptional

When true, includes human-readable names for the corresponding VIS path elements in vis-3-8a domainIds. If false (or omitted), regular domainIds are returned.

Default: false

Header parameters

x-api-versionstring · enumOptional

API version

Default: 2025-10-31Possible values:

Responses

200

Response from the route

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/metadata/jsmea/{imo_number}/{naming_rule}/{category}/{sub_category}/{content}/{position}/{item}/{modifier}

HTTPcURLJavaScriptPython

GET /{ENVIRONMENT}/metadata/jsmea/{imo_number}/{naming_rule}/{category}/{sub_category}/{content}/{position}/{item}/{modifier} HTTP/1.1
Host: prism.raalabs.io/{ENVIRONMENT}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "IMO1000003/jsmea_nav/PositioningSystem/GPS///Latitude/": {
    "description": "SHIP POSITION (LATITUDE)",
    "mapsTo": {
      "jsmea": "IMO1000003/jsmea_nav/PositioningSystem/GPS///Latitude/",
      "raalabs": "IMO1000003/GPS_LAT"
    },
    "name": "Latitude",
    "rangeHigh": 90,
    "rangeLow": -90,
    "scale": 1,
    "source": "FurunoVDR",
    "timeSeriesId": "11000001-0000-0000-0000-000000000001",
    "uom": "deg",
    "vesselImo": "1000003",
    "vesselName": "Flying Dutchman"
  },
  "IMO1000003/jsmea_nav/PositioningSystem/GPS///Longitude/": {
    "description": "SHIP POSITION (LONGITUDE)",
    "mapsTo": {
      "jsmea": "IMO1000003/jsmea_nav/PositioningSystem/GPS///Longitude/",
      "raalabs": "IMO1000003/GPS_LONG"
    },
    "name": "Longitude",
    "rangeHigh": 180,
    "rangeLow": -180,
    "scale": 1,
    "source": "FurunoVDR",
    "timeSeriesId": "11000001-0000-0000-0000-000000000000",
    "uom": "deg",
    "vesselImo": "1000003",
    "vesselName": "Flying Dutchman"
  }
}

Get metadata from the raalabs domain

get

Authorizations

authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

imo_numberstringOptional

The IMO number of the vessel

Example: IMO1000001

tag_namestringOptional

Short descriptive tag name

Example: ME FuelEnergy*

Query parameters

formatstring · enumOptional

Desired output format of the data. You can also specify the response format via the HTTP Accept Header instead of the format query parameter.

Default: jsonPossible values:

verbosebooleanOptional

When true, includes human-readable names for the corresponding VIS path elements in vis-3-8a domainIds. If false (or omitted), regular domainIds are returned.

Default: false

Header parameters

x-api-versionstring · enumOptional

API version

Default: 2025-10-31Possible values:

Responses

200

Response from the route

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/metadata/raalabs/{imo_number}/{tag_name}

HTTPcURLJavaScriptPython

GET /{ENVIRONMENT}/metadata/raalabs/{imo_number}/{tag_name} HTTP/1.1
Host: prism.raalabs.io/{ENVIRONMENT}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "IMO1000001/ME FuelEnergy_0": {
    "description": "Open door #0",
    "mapsTo": {
      "jsmea": "IMO1000001/jsmea_mac/MainEngine/Fuel/Input/Inlet/Energy/",
      "raalabs": "IMO1000001/ME FuelEnergy_0"
    },
    "name": "BEEF0",
    "rangeHigh": 0,
    "rangeLow": -1,
    "scale": 1,
    "source": "Matrix",
    "timeSeriesId": "11000001-0000-0000-0000-000000000000",
    "uom": "Joule",
    "vesselImo": "1000001",
    "vesselName": "Blue Whale"
  },
  "IMO1000001/ME FuelEnergy_1": {
    "description": "Open door #1",
    "mapsTo": {
      "jsmea": "IMO1000001/jsmea_mac/MainEngine/Fuel/Input/Inlet/Energy/",
      "raalabs": "IMO1000001/ME FuelEnergy_1"
    },
    "name": "BEEF1",
    "rangeHigh": 1,
    "rangeLow": -1,
    "scale": 1,
    "source": "Matrix",
    "timeSeriesId": "11000001-0000-0000-0000-000000000001",
    "uom": "Joule",
    "vesselImo": "1000001",
    "vesselName": "Blue Whale"
  }
}

Get metadata from the vis-3-8a domain

get

Authorizations

authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

imo_numberstringOptional

The IMO number of the vessel to retrieve from

Example: IMO1000001

primary_item_vis_pathstringOptional

Primary item VIS path

Example: 913/S130.1-2/S121

secondary_item_vis_pathstringOptional

Secondary item VIS path

Example: 406i/H233

metadatastringOptional

Metadata

Example: qty-power

Query parameters

formatstring · enumOptional

Desired output format of the data. You can also specify the response format via the HTTP Accept Header instead of the format query parameter.

Default: jsonPossible values:

verbosebooleanOptional

When true, includes human-readable names for the corresponding VIS path elements in vis-3-8a domainIds. If false (or omitted), regular domainIds are returned.

Default: false

Header parameters

x-api-versionstring · enumOptional

API version

Default: 2025-10-31Possible values:

Responses

200

Response from the route

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/metadata/vis-3-8a/{imo_number}/{primary_item_vis_path}/sec/{secondary_item_vis_path}/meta/{metadata}

HTTPcURLJavaScriptPython

GET /{ENVIRONMENT}/metadata/vis-3-8a/{imo_number}/{primary_item_vis_path}/sec/{secondary_item_vis_path}/meta/{metadata} HTTP/1.1
Host: prism.raalabs.io/{ENVIRONMENT}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "IMO1000005/913/S130.1-2/S121/sec/406i/H233/meta/qty-power": {
      "description": "NO.2 ESS FAN INV.POWER",
      "mapsTo": {
        "jsmea": "IMO1000005/jsmea_mac/VentilationFan/EngineRoomFan2/Electric//Power/",
        "maker": "IMO1000005/Aconis/45415",
        "raalabs": "IMO1000005/EngineRoomVentilationFanPower_2",
        "vis-3-8a": "IMO1000005/913/S130.1-2/S121/sec/406i/H233/meta/qty-power"
      },
      "name": "45415",
      "rangeHigh": 9999999,
      "rangeLow": 0,
      "scale": 1,
      "source": "Aconis",
      "timeSeriesId": "1a33e823-442b-4746-8c1f-c00382e4a282",
      "uom": "",
      "vesselImo": "1000005",
      "vesselName": "Happy Wanderer"
    }
  }
]