Chilkat Online Tools

PureBasic / Cognite API v1 / List notification subscriptions

Back to Collection Items

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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

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

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

    success = CkHttp::ckQuickGetSb(http,"https://domain.com/api/v1/projects/{{project}}/transformations/notifications",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    Debug "Response status code = " + Str(CkHttp::ckLastStatus(http))
    Debug CkStringBuilder::ckGetAsString(sbResponseBody)


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X GET
	-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/transformations/notifications?

Postman Collection Item JSON

{
  "id": "getTransformationNotifications",
  "name": "List notification subscriptions",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "transformations",
        "notifications"
      ],
      "query": [
        {
          "key": "transformationId",
          "description": "List only notifications for the specified transformation. The transformation is identified by ID.",
          "disabled": true
        },
        {
          "key": "transformationExternalId",
          "description": "List only notifications for the specified transformation. The transformation is identified by external ID.",
          "disabled": true
        },
        {
          "key": "destination",
          "description": "Filter by notification destination.",
          "disabled": true
        },
        {
          "key": "limit",
          "description": "Limits the number of results to be returned. The maximum is 1000, default limit is 100.",
          "disabled": true
        },
        {
          "key": "cursor",
          "description": "Cursor for paging through results.",
          "disabled": true
        }
      ],
      "variable": [
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      }
    ]
  }
}