Chilkat Online Tools

SQL Server / Cognite API v1 / Search sequences

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
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    -- Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    -- The following JSON is sent in the request body.

    -- {
    --   "filter": {
    --     "name": "commodo non nulla aute",
    --     "externalIdPrefix": "commodo qui cupidatat",
    --     "metadata": {},
    --     "assetIds": [
    --       4769293985777598,
    --       5785768360784284
    --     ],
    --     "rootAssetIds": [
    --       1096264439313816,
    --       4922424346728832
    --     ],
    --     "assetSubtreeIds": [
    --       {
    --         "externalId": "exercitation pariatur id in"
    --       },
    --       {
    --         "id": 22443661565144
    --       }
    --     ],
    --     "createdTime": {
    --       "max": 14384577,
    --       "min": 60974975
    --     },
    --     "lastUpdatedTime": {
    --       "max": 83207483,
    --       "min": 43920599
    --     },
    --     "dataSetIds": [
    --       {
    --         "externalId": "voluptate e"
    --       },
    --       {
    --         "externalId": "laboris"
    --       }
    --     ]
    --   },
    --   "search": {
    --     "name": "non culpa irure velit consequat",
    --     "description": "id eiusmod",
    --     "query": "ad"
    --   },
    --   "limit": 100
    -- }

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'filter.name', 'commodo non nulla aute'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'filter.externalIdPrefix', 'commodo qui cupidatat'
    EXEC sp_OAMethod @json, 'UpdateNewObject', @success OUT, 'filter.metadata'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'filter.assetIds[0]', 4769293985777598
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'filter.assetIds[1]', 5785768360784284
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'filter.rootAssetIds[0]', 1096264439313816
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'filter.rootAssetIds[1]', 4922424346728832
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'filter.assetSubtreeIds[0].externalId', 'exercitation pariatur id in'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'filter.assetSubtreeIds[1].id', 123
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'filter.createdTime.max', 14384577
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'filter.createdTime.min', 60974975
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'filter.lastUpdatedTime.max', 83207483
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'filter.lastUpdatedTime.min', 43920599
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'filter.dataSetIds[0].externalId', 'voluptate e'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'filter.dataSetIds[1].externalId', 'laboris'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'search.name', 'non culpa irure velit consequat'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'search.description', 'id eiusmod'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'search.query', 'ad'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'limit', 100

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'content-type', 'application/json'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'api-key', '{{api-key}}'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/api/v1/projects/{{project}}/sequences/search', 'application/json', @json
    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 @json
        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 @json


END
GO

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "filter": {
        "name": "commodo non nulla aute",
        "externalIdPrefix": "commodo qui cupidatat",
        "metadata": {},
        "assetIds": [
            4769293985777598,
            5785768360784284
        ],
        "rootAssetIds": [
            1096264439313816,
            4922424346728832
        ],
        "assetSubtreeIds": [
            {
                "externalId": "exercitation pariatur id in"
            },
            {
                "id": 22443661565144
            }
        ],
        "createdTime": {
            "max": 14384577,
            "min": 60974975
        },
        "lastUpdatedTime": {
            "max": 83207483,
            "min": 43920599
        },
        "dataSetIds": [
            {
                "externalId": "voluptate e"
            },
            {
                "externalId": "laboris"
            }
        ]
    },
    "search": {
        "name": "non culpa irure velit consequat",
        "description": "id eiusmod",
        "query": "ad"
    },
    "limit": 100
}'
https://domain.com/api/v1/projects/{{project}}/sequences/search

Postman Collection Item JSON

{
  "id": "searchSequences",
  "name": "Search sequences",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "sequences",
        "search"
      ],
      "query": [
      ],
      "variable": [
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      },
      {
        "key": "content-type",
        "value": "application/json"
      }
    ],
    "description": "Retrieves a list of sequences matching the given criteria. This operation does not support pagination.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"name\": \"commodo non nulla aute\",\n        \"externalIdPrefix\": \"commodo qui cupidatat\",\n        \"metadata\": {},\n        \"assetIds\": [\n            4769293985777598,\n            5785768360784284\n        ],\n        \"rootAssetIds\": [\n            1096264439313816,\n            4922424346728832\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"externalId\": \"exercitation pariatur id in\"\n            },\n            {\n                \"id\": 22443661565144\n            }\n        ],\n        \"createdTime\": {\n            \"max\": 14384577,\n            \"min\": 60974975\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 83207483,\n            \"min\": 43920599\n        },\n        \"dataSetIds\": [\n            {\n                \"externalId\": \"voluptate e\"\n            },\n            {\n                \"externalId\": \"laboris\"\n            }\n        ]\n    },\n    \"search\": {\n        \"name\": \"non culpa irure velit consequat\",\n        \"description\": \"id eiusmod\",\n        \"query\": \"ad\"\n    },\n    \"limit\": 100\n}"
    }
  }
}