Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateInt("limit",100)
loQueryParams.UpdateString("assetIds","[363848954441724, 793045462540095, 1261042166839739]")
loQueryParams.UpdateString("assetExternalIds",'["externalId1", "externalId2", "externalId3"]')
loQueryParams.UpdateString("rootAssetIds","[363848954441724, 793045462540095, 1261042166839739]")
loQueryParams.UpdateString("assetSubtreeIds","[363848954441724, 793045462540095, 1261042166839739]")
loQueryParams.UpdateString("assetSubtreeExternalIds",'["externalId1", "externalId2", "externalId3"]')
loQueryParams.UpdateString("includeMetadata","true")
loQueryParams.UpdateString("sort","endTime:desc")
loHttp.SetRequestHeader("api-key","{{api-key}}")
loResp = loHttp.QuickRequestParams("GET","https://domain.com/api/v1/projects/{{project}}/events",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
? str(loResp.StatusCode)
? loResp.BodyStr
release loResp
release loHttp
release loQueryParams
Curl Command
curl -G -d "limit=100"
-d "assetIds=%5B363848954441724,%20793045462540095,%201261042166839739%5D"
-d "assetExternalIds=%5B%22externalId1%22,%20%22externalId2%22,%20%22externalId3%22%5D"
-d "rootAssetIds=%5B363848954441724,%20793045462540095,%201261042166839739%5D"
-d "assetSubtreeIds=%5B363848954441724,%20793045462540095,%201261042166839739%5D"
-d "assetSubtreeExternalIds=%5B%22externalId1%22,%20%22externalId2%22,%20%22externalId3%22%5D"
-d "includeMetadata=true"
-d "sort=endTime%3Adesc"
-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/events
Postman Collection Item JSON
{
"id": "listEvents",
"name": "Filter events",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": [
"api",
"v1",
"projects",
"{{project}}",
"events"
],
"query": [
{
"key": "limit",
"description": "Limits the number of results to be returned. The maximum results returned by the server is 1000 even if you specify a higher limit.",
"value": "100",
"disabled": true
},
{
"key": "cursor",
"description": "Cursor for paging through results.",
"disabled": true
},
{
"key": "minStartTime",
"description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
"disabled": true
},
{
"key": "maxStartTime",
"description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
"disabled": true
},
{
"key": "minEndTime",
"description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
"disabled": true
},
{
"key": "maxEndTime",
"description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
"disabled": true
},
{
"key": "minActiveAtTime",
"description": "Event is considered active from its startTime to endTime inclusive. If startTime is null, event is never active. If endTime is null, event is active from startTime onwards. activeAtTime filter will match all events that are active at some point from min to max, from min, or to max, depending on which of min and max parameters are specified.",
"disabled": true
},
{
"key": "maxActiveAtTime",
"description": "Event is considered active from its startTime to endTime inclusive. If startTime is null, event is never active. If endTime is null, event is active from startTime onwards. activeAtTime filter will match all events that are active at some point from min to max, from min, or to max, depending on which of min and max parameters are specified.",
"disabled": true
},
{
"key": "assetIds",
"description": "Asset IDs of equipment that this event relates to. Format is list of IDs serialized as JSON array(int64). Takes [ 1 .. 100 ] of unique items.",
"value": "[363848954441724, 793045462540095, 1261042166839739]",
"disabled": true
},
{
"key": "assetExternalIds",
"description": "Asset external IDs of equipment that this event relates to. Takes 1..100 unique items.",
"value": "[\"externalId1\", \"externalId2\", \"externalId3\"]",
"disabled": true
},
{
"key": "rootAssetIds",
"description": "This parameter is deprecated. Use assetSubtreeIds instead. Only include events that have a related asset in a tree rooted at any of these root assetIds.",
"value": "[363848954441724, 793045462540095, 1261042166839739]",
"disabled": true
},
{
"key": "assetSubtreeIds",
"description": "Only include events that have a related asset in a subtree rooted at any of these assetIds (including the roots given). If the total size of the given subtrees exceeds 100,000 assets, an error will be returned.",
"value": "[363848954441724, 793045462540095, 1261042166839739]",
"disabled": true
},
{
"key": "assetSubtreeExternalIds",
"description": "Only include events that have a related asset in a subtree rooted at any of these assetExternalIds (including the roots given). If the total size of the given subtrees exceeds 100,000 assets, an error will be returned.",
"value": "[\"externalId1\", \"externalId2\", \"externalId3\"]",
"disabled": true
},
{
"key": "source",
"description": "The source of this event.",
"disabled": true
},
{
"key": "type",
"description": "Type of the event, e.g 'failure'.",
"disabled": true
},
{
"key": "subtype",
"description": "SubType of the event, e.g 'electrical'.",
"disabled": true
},
{
"key": "minCreatedTime",
"description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
"disabled": true
},
{
"key": "maxCreatedTime",
"description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
"disabled": true
},
{
"key": "minLastUpdatedTime",
"description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
"disabled": true
},
{
"key": "maxLastUpdatedTime",
"description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
"disabled": true
},
{
"key": "externalIdPrefix",
"description": "Filter by this (case-sensitive) prefix for the external ID.",
"disabled": true
},
{
"key": "partition",
"description": "Splits the data set into N partitions.\nYou need to follow the cursors within each partition in order to receive all the data.\nExample: 1/10\n",
"disabled": true
},
{
"key": "includeMetadata",
"description": "Whether the metadata field should be returned, or not.",
"value": "true",
"disabled": true
},
{
"key": "sort",
"description": "Sort by array of selected fields. Syntax: `[\"<fieldname>:asc|desc\"]`. Default sort order is `asc` with short syntax: `[\"<fieldname>\"]`.\nFilter accepts the following field names: startTime, endTime, createdTime, lastUpdatedTime.\nPartitions are done independently of sorting, there is no guarantee on sort order between elements from different partitions.\n",
"value": "endTime:desc",
"disabled": true
}
],
"variable": [
]
},
"method": "GET",
"header": [
{
"key": "api-key",
"value": "{{api-key}}",
"description": "An admin can create API keys in the Cognite console."
}
],
"description": "List events optionally filtered on query parameters"
}
}
