Chilkat Online Tools

Foxpro / Cognite API v1 / List security categories

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("sort","ASC")
loQueryParams.UpdateInt("limit",25)

loHttp.SetRequestHeader("api-key","{{api-key}}")

loResp = loHttp.QuickRequestParams("GET","https://domain.com/api/v1/projects/{{project}}/securitycategories",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loQueryParams

Curl Command

curl -G -d "sort=ASC"
	-d "limit=25"
	-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/securitycategories

Postman Collection Item JSON

{
  "id": "getSecurityCategories",
  "name": "List security categories",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "securitycategories"
      ],
      "query": [
        {
          "key": "sort",
          "description": "Sort descending or ascending.",
          "value": "ASC",
          "disabled": true
        },
        {
          "key": "cursor",
          "description": "Cursor to use for paging through results.",
          "disabled": true
        },
        {
          "key": "limit",
          "description": "Return up to this many results. Maximum is 1000. Default is 25.",
          "value": "25",
          "disabled": true
        }
      ],
      "variable": [
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      }
    ],
    "description": "Retrieves a list of all security categories for a project."
  }
}