Chilkat Online Tools

PowerBuilder / Cognite API v1 / List security categories

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")

loo_QueryParams.UpdateString("sort","ASC")
loo_QueryParams.UpdateInt("limit",25)

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

loo_Resp = loo_Http.QuickRequestParams("GET","https://domain.com/api/v1/projects/{{project}}/securitycategories",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_QueryParams
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http
destroy loo_QueryParams

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