Chilkat Online Tools

PureBasic / Coupa Postman Collection - OAuth - Master / Get Lookup Value by ID

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,"fields","[" + Chr(34) + "id" + Chr(34) + "," + Chr(34) + "name" + Chr(34) + "," + Chr(34) + "active" + Chr(34) + "," + Chr(34) + "external-ref-num" + Chr(34) + "," + Chr(34) + "external-ref-code" + Chr(34) + ",{" + Chr(34) + "parent" + Chr(34) + ":[" + Chr(34) + "id" + Chr(34) + "," + Chr(34) + "name" + Chr(34) + "," + Chr(34) + "active" + Chr(34) + ",{" + Chr(34) + "custom_fields" + Chr(34) + ":{}},{" + Chr(34) + "parent" + Chr(34) + ": [" + Chr(34) + "id" + Chr(34) + "," + Chr(34) + "name" + Chr(34) + "," + Chr(34) + "active" + Chr(34) + ",{" + Chr(34) + "custom_fields" + Chr(34) + ":{}}]}]},{" + Chr(34) + "custom_fields" + Chr(34) + ":{}}]")

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/lookup_values/:id",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 "fields=%5B%22id%22,%22name%22,%22active%22,%22external-ref-num%22,%22external-ref-code%22,%7B%22parent%22%3A%5B%22id%22,%22name%22,%22active%22,%7B%22custom_fields%22%3A%7B%7D%7D,%7B%22parent%22%3A%20%5B%22id%22,%22name%22,%22active%22,%7B%22custom_fields%22%3A%7B%7D%7D%5D%7D%5D%7D,%7B%22custom_fields%22%3A%7B%7D%7D%5D"
	-H "Authorization: Bearer <access_token>"
https://domain.com/lookup_values/:id

Postman Collection Item JSON

{
  "name": "Get Lookup Value by ID",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{URL}}/lookup_values/:id?fields=[\"id\",\"name\",\"active\",\"external-ref-num\",\"external-ref-code\",{\"parent\":[\"id\",\"name\",\"active\",{\"custom_fields\":{}},{\"parent\": [\"id\",\"name\",\"active\",{\"custom_fields\":{}}]}]},{\"custom_fields\":{}}]",
      "host": [
        "{{URL}}"
      ],
      "path": [
        "lookup_values",
        ":id"
      ],
      "query": [
        {
          "key": "fields",
          "value": "[\"id\",\"name\",\"active\",\"external-ref-num\",\"external-ref-code\",{\"parent\":[\"id\",\"name\",\"active\",{\"custom_fields\":{}},{\"parent\": [\"id\",\"name\",\"active\",{\"custom_fields\":{}}]}]},{\"custom_fields\":{}}]"
        }
      ],
      "variable": [
        {
          "key": "id",
          "value": "4"
        }
      ]
    }
  },
  "response": [
  ]
}