Chilkat Online Tools

DataFlex / Cognite API v1 / Retrieve rows

Back to Collection Items

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    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

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

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

    // {
    //   "id": 1844083276579324,
    //   "start": 0,
    //   "end": -14940119,
    //   "limit": 100,
    //   "cursor": "laborum",
    //   "columns": [
    //     "voluptate esse dolor",
    //     "ex"
    //   ]
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateInt Of hoJson "id" 123 To iSuccess
    Get ComUpdateInt Of hoJson "start" 0 To iSuccess
    Get ComUpdateInt Of hoJson "end" -14940119 To iSuccess
    Get ComUpdateInt Of hoJson "limit" 100 To iSuccess
    Get ComUpdateString Of hoJson "cursor" "laborum" To iSuccess
    Get ComUpdateString Of hoJson "columns[0]" "voluptate esse dolor" To iSuccess
    Get ComUpdateString Of hoJson "columns[1]" "ex" To iSuccess

    Send ComSetRequestHeader To hoHttp "content-type" "application/json"
    Send ComSetRequestHeader To hoHttp "api-key" "{{api-key}}"

    Get pvComObject of hoJson to vJson
    Get ComPostJson3 Of hoHttp "https://domain.com/api/v1/projects/{{project}}/sequences/data/list" "application/json" vJson 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 -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "id": 1844083276579324,
    "start": 0,
    "end": -14940119,
    "limit": 100,
    "cursor": "laborum",
    "columns": [
        "voluptate esse dolor",
        "ex"
    ]
}'
https://domain.com/api/v1/projects/{{project}}/sequences/data/list

Postman Collection Item JSON

{
  "id": "getSequenceData",
  "name": "Retrieve rows",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "sequences",
        "data",
        "list"
      ],
      "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": "Processes data requests, and returns the result. NB - This operation uses a dynamic limit on the number of rows returned based on the number and type of columns, use the provided cursor to paginate and retrieve all data.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"id\": 1844083276579324,\n    \"start\": 0,\n    \"end\": -14940119,\n    \"limit\": 100,\n    \"cursor\": \"laborum\",\n    \"columns\": [\n        \"voluptate esse dolor\",\n        \"ex\"\n    ]\n}"
    }
  }
}