const events = await client.events.retrieve([{id: 123}, {externalId: 'abc'}]);{
"id": 4503599627370496,
"lastUpdatedTime": 1730204346000,
"createdTime": 1730204346000,
"externalId": "my.known.id",
"dataSetId": 4503599627370496,
"startTime": 1730204346000,
"endTime": 1730204346000,
"type": "<string>",
"subtype": "<string>",
"description": "<string>",
"metadata": {},
"assetIds": [
4503599627370496
],
"source": "<string>"
}Receive an event by its ID
Required capabilities:
eventsAcl:READ
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.
const events = await client.events.retrieve([{id: 123}, {externalId: 'abc'}]);{
"id": 4503599627370496,
"lastUpdatedTime": 1730204346000,
"createdTime": 1730204346000,
"externalId": "my.known.id",
"dataSetId": 4503599627370496,
"startTime": 1730204346000,
"endTime": 1730204346000,
"type": "<string>",
"subtype": "<string>",
"description": "<string>",
"metadata": {},
"assetIds": [
4503599627370496
],
"source": "<string>"
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Path Parameters
A server-generated ID for the object.
1 <= x <= 9007199254740991Response
response with list of events
An event represents something that happened at a given interval in time, for example, a failure, a work order, etc.
A server-generated ID for the object.
1 <= x <= 9007199254740991The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The external ID provided by the client. Must be unique for the resource type.
255"my.known.id"
The id of the dataset this event belongs to.
1 <= x <= 9007199254740991The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
Type of the event, e.g 'failure'.
64SubType of the event, e.g 'electrical'.
64Textual description of the event.
500Custom, application specific metadata. String key -> String value. Limits: Maximum length of key is 128 bytes, value 128000 bytes, up to 256 key-value pairs, of total size at most 200000.
Show child attributes
Show child attributes
Asset IDs of equipment that this event relates to.
A server-generated ID for the object.
1 <= x <= 9007199254740991The source of this event.
128Was this page helpful?