Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'limit', 100
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'includeMetadata', 'true'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'parentIds', '[363848954441724, 793045462540095, 1261042166839739]'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'parentExternalIds', '[externalId_1, externalId_2, externalId_3]'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'rootIds', '[363848954441724, 793045462540095, 1261042166839739]'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'assetSubtreeIds', '[363848954441724, 793045462540095, 1261042166839739]'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'assetSubtreeExternalIds', '[externalId_1, externalId_2, externalId_3]'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'root', 'false'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'api-key', '{{api-key}}'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/api/v1/projects/{{project}}/assets', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
END
GO
Curl Command
curl -G -d "limit=100"
-d "includeMetadata=true"
-d "parentIds=%5B363848954441724,%20793045462540095,%201261042166839739%5D"
-d "parentExternalIds=%5BexternalId_1,%20externalId_2,%20externalId_3%5D"
-d "rootIds=%5B363848954441724,%20793045462540095,%201261042166839739%5D"
-d "assetSubtreeIds=%5B363848954441724,%20793045462540095,%201261042166839739%5D"
-d "assetSubtreeExternalIds=%5BexternalId_1,%20externalId_2,%20externalId_3%5D"
-d "root=false"
-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/assets
Postman Collection Item JSON
{
"id": "getAssets",
"name": "List assets",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": [
"api",
"v1",
"projects",
"{{project}}",
"assets"
],
"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": "includeMetadata",
"description": "Whether the metadata field should be returned, or not.",
"value": "true",
"disabled": true
},
{
"key": "name",
"description": "The name of the asset.",
"disabled": true
},
{
"key": "parentIds",
"description": "List only assets that have one of the parentIds as a parent. The parentId for root assets is null.",
"value": "[363848954441724, 793045462540095, 1261042166839739]",
"disabled": true
},
{
"key": "parentExternalIds",
"description": "List only assets that have one of the parentExternalIds as a parent. The parentId for root assets is null.",
"value": "[externalId_1, externalId_2, externalId_3]",
"disabled": true
},
{
"key": "rootIds",
"description": "This parameter is deprecated. Use assetSubtreeIds instead. List only assets that have one of the rootIds as a root asset. A root asset is its own root asset.",
"value": "[363848954441724, 793045462540095, 1261042166839739]",
"disabled": true
},
{
"key": "assetSubtreeIds",
"description": "List only assets that are 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": "List only assets that are in a subtree rooted at any of these assetExternalIds. If the total size of the given subtrees exceeds 100,000 assets, an error will be returned.",
"value": "[externalId_1, externalId_2, externalId_3]",
"disabled": true
},
{
"key": "source",
"description": "The source of the asset, for example which database it's from.",
"disabled": true
},
{
"key": "root",
"description": "Whether the filtered assets are root assets, or not. Set to True to only list root assets.",
"value": "false",
"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
}
],
"variable": [
]
},
"method": "GET",
"header": [
{
"key": "api-key",
"value": "{{api-key}}",
"description": "An admin can create API keys in the Cognite console."
}
],
"description": "List all assets, or only the assets matching the specified query."
}
}
