Receive an event by its ID

Retrieves an event by its internal (service-generated) ID.

Request throttling

This endpoint is a subject of the new throttling schema (limited request rate and concurrency). Please check Events resource description for more information.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
id
required
integer <int64> (CogniteInternalId) [ 1 .. 9007199254740991 ]

A server-generated ID for the object.

Responses
200

response with list of events

400

The response for a bad request.

429

The response for too many requests (concurrency or rate throttling).

get/events/{id}
Request samples 
const events = await client.events.retrieve([{id: 123}, {externalId: 'abc'}]);
Response samples
application/json
{
  • "externalId": "my.known.id",
  • "dataSetId": 1,
  • "startTime": 0,
  • "endTime": 0,
  • "type": "string",
  • "subtype": "string",
  • "description": "string",
  • "metadata": {
    • "property1": "string",
    • "property2": "string"
    },
  • "assetIds": [
    • 1
    ],
  • "source": "string",
  • "id": 1,
  • "lastUpdatedTime": 0,
  • "createdTime": 0
}
➔ Next to Retrieve events