Cognite · JSON Structure

Cognite Asset Structure

Physical asset in Cognite Data Fusion — a factory, equipment, or location node in the asset hierarchy.

Type: Properties: 0
Industrial IoTManufacturingIndustrial DataDigital TwinAsset ManagementTime SeriesIndustrial AI

Asset is a JSON Structure definition published by Cognite.

Meta-schema:

JSON Structure

Raw ↑
{
  "name": "Asset",
  "description": "Physical asset in Cognite Data Fusion — a factory, equipment, or location node in the asset hierarchy.",
  "fields": [
    {"name": "id", "type": "integer(int64)", "required": true, "description": "Server-generated internal ID"},
    {"name": "externalId", "type": "string", "required": false, "description": "Client-supplied unique ID (max 255 chars)"},
    {"name": "name", "type": "string", "required": true, "description": "Human-readable asset name (max 140 chars)"},
    {"name": "parentId", "type": "integer(int64)", "required": false, "description": "Internal ID of parent asset"},
    {"name": "parentExternalId", "type": "string", "required": false, "description": "External ID of parent asset"},
    {"name": "rootId", "type": "integer(int64)", "required": false, "description": "Internal ID of root asset in hierarchy"},
    {"name": "description", "type": "string", "required": false, "description": "Asset description (max 500 chars)"},
    {"name": "dataSetId", "type": "integer(int64)", "required": false, "description": "Dataset this asset belongs to"},
    {"name": "metadata", "type": "object(string->string)", "required": false, "description": "Custom key-value metadata (max 256 pairs)"},
    {"name": "source", "type": "string", "required": false, "description": "Source system (max 128 chars)"},
    {"name": "labels", "type": "array[Label]", "required": false, "description": "Labels associated with this asset"},
    {"name": "geoLocation", "type": "GeoLocation", "required": false, "description": "Geographic metadata (GeoJSON Feature)"},
    {"name": "aggregates", "type": "object", "required": false, "description": "Aggregated metrics: childCount, depth, path"},
    {"name": "createdTime", "type": "integer(int64)", "required": true, "description": "Creation time as Unix epoch milliseconds"},
    {"name": "lastUpdatedTime", "type": "integer(int64)", "required": true, "description": "Last update time as Unix epoch milliseconds"}
  ],
  "relationships": [
    {"field": "parentId / parentExternalId", "target": "Asset", "cardinality": "many-to-one", "description": "Asset hierarchy parent link"},
    {"field": "dataSetId", "target": "DataSet", "cardinality": "many-to-one", "description": "Owning dataset"},
    {"field": "labels", "target": "Label", "cardinality": "many-to-many", "description": "Classification labels"}
  ],
  "endpoints": {
    "list": "POST /assets/list",
    "create": "POST /assets",
    "retrieve": "POST /assets/byids",
    "update": "POST /assets/update",
    "delete": "POST /assets/delete",
    "search": "POST /assets/search",
    "aggregate": "POST /assets/aggregate"
  }
}