Chilkat Online Tools

PureBasic / Cognite API v1 / List security categories

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    queryParams.i = CkJsonObject::ckCreate()
    If queryParams.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(queryParams,"sort","ASC")
    CkJsonObject::ckUpdateInt(queryParams,"limit",25)

    CkHttp::ckSetRequestHeader(http,"api-key","{{api-key}}")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/api/v1/projects/{{project}}/securitycategories",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)


    ProcedureReturn
EndProcedure

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."
  }
}