Cognite · Example Payload

Cognite Assets List Example

Industrial IoTManufacturingIndustrial DataDigital TwinAsset ManagementTime SeriesIndustrial AI

Cognite Assets List Example is an example object payload from Cognite, with 2 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

requestresponse

Example Payload

{
  "request": {
    "method": "POST",
    "url": "https://api.cognitedata.com/{project}/assets/list",
    "headers": {
      "Authorization": "Bearer <access_token>",
      "Content-Type": "application/json"
    },
    "body": {
      "filter": {
        "name": "Pump",
        "dataSetIds": [{"id": 1234567890}],
        "labels": {
          "containsAny": [{"externalId": "pump"}]
        }
      },
      "limit": 100,
      "cursor": null
    }
  },
  "response": {
    "status": 200,
    "body": {
      "items": [
        {
          "id": 6192931774716896,
          "externalId": "pump-unit-01",
          "name": "Pump Unit 01",
          "parentId": 2254478787923185,
          "parentExternalId": "production-area-a",
          "rootId": 8175671908001234,
          "description": "Main water injection pump in production area A",
          "dataSetId": 1234567890,
          "metadata": {
            "manufacturer": "Grundfos",
            "model": "CR 45-2",
            "serialNumber": "GF20230145"
          },
          "source": "SAP",
          "labels": [{"externalId": "pump"}, {"externalId": "critical"}],
          "aggregates": {
            "childCount": 4,
            "depth": 3,
            "path": [
              {"id": 8175671908001234},
              {"id": 3456781234509876},
              {"id": 2254478787923185}
            ]
          },
          "createdTime": 1672531200000,
          "lastUpdatedTime": 1706745600000
        }
      ],
      "nextCursor": null
    }
  }
}