Chilkat Online Tools

PowerBuilder / GP-API Collection / ACT_1.0 Get Actions List

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
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_QueryParams.UpdateString("from_time_created","2020-09-29")
loo_QueryParams.UpdateString("order","DESC")

// Adds the "Authorization: Bearer {{token}}" header.
loo_Http.AuthToken = "{{token}}"
loo_Http.SetRequestHeader("X-GP-Version","{{version}}")

loo_Resp = loo_Http.QuickRequestParams("GET","https://{{url}}/ucp/actions",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 "from_time_created=2020-09-29"
	-d "order=DESC"
	-H "Authorization: Bearer {{token}}"
	-H "X-GP-Version: {{version}}"
https://{{url}}/ucp/actions

Postman Collection Item JSON

{
  "name": "ACT_1.0 Get Actions List",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "\r",
          "\r",
          "tests[\"Response time is acceptable\"] = _.inRange(responseTime, 100, 1500); \r",
          "\r",
          "\r",
          "pm.test(\"Successful POST request\", function () {\r",
          "    pm.expect(pm.response.code).to.be.oneOf([200,201,202]);\r",
          "});\r",
          "\r",
          "pm.test(\"Status code name has string\", function () {\r",
          "    pm.response.to.have.status(\"OK\");\r",
          "});"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "type": "text",
        "value": "Bearer {{token}}"
      },
      {
        "key": "X-GP-Version",
        "type": "text",
        "value": "{{version}}"
      }
    ],
    "url": {
      "raw": "https://{{url}}/ucp/actions?from_time_created=2020-09-29&order=DESC",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "actions"
      ],
      "query": [
        {
          "key": "to_time_created",
          "value": "2020-05-28",
          "disabled": true
        },
        {
          "key": "from_time_created",
          "value": "2020-09-29"
        },
        {
          "key": "page_size",
          "value": "100",
          "disabled": true
        },
        {
          "key": "page",
          "value": "1",
          "disabled": true
        },
        {
          "key": "order",
          "value": "DESC"
        },
        {
          "key": "order_by",
          "value": "time_created",
          "disabled": true
        }
      ]
    },
    "description": "This request gets a log of requests and responses sent by the merchant and received by GP-API.\r\n\r\nFor more information on what query params you can return the list by, please visit the following Dev Portal link: https://developer.globalpay.com/api/actions#/Actions/get_actions"
  },
  "response": [
  ]
}