Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
String sTemp1
Integer iTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateInt Of hoQueryParams "limit" 100 To iSuccess
Get ComUpdateString Of hoQueryParams "includeMetadata" "true" To iSuccess
Get ComUpdateString Of hoQueryParams "parentIds" "[363848954441724, 793045462540095, 1261042166839739]" To iSuccess
Get ComUpdateString Of hoQueryParams "parentExternalIds" "[externalId_1, externalId_2, externalId_3]" To iSuccess
Get ComUpdateString Of hoQueryParams "rootIds" "[363848954441724, 793045462540095, 1261042166839739]" To iSuccess
Get ComUpdateString Of hoQueryParams "assetSubtreeIds" "[363848954441724, 793045462540095, 1261042166839739]" To iSuccess
Get ComUpdateString Of hoQueryParams "assetSubtreeExternalIds" "[externalId_1, externalId_2, externalId_3]" To iSuccess
Get ComUpdateString Of hoQueryParams "root" "false" To iSuccess
Send ComSetRequestHeader To hoHttp "api-key" "{{api-key}}"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://domain.com/api/v1/projects/{{project}}/assets" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
Showln iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
Send Destroy of hoResp
End_Procedure
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."
}
}
