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) + "created_at" + Chr(34) + "," + Chr(34) + "updated_at" + Chr(34) + "," + Chr(34) + "name" + Chr(34) + "," + Chr(34) + "active" + Chr(34) + "," + Chr(34) + "open" + Chr(34) + "," + Chr(34) + "description" + Chr(34) + "," + Chr(34) + "mention-name" + Chr(34) + "," + Chr(34) + "start-date" + Chr(34) + "," + Chr(34) + "project-id" + Chr(34) + "," + Chr(34) + "status" + Chr(34) + ",{" + Chr(34) + "template-group" + Chr(34) + ": [" + Chr(34) + "id" + Chr(34) + "," + Chr(34) + "name" + Chr(34) + "]},{" + Chr(34) + "category" + Chr(34) + ": [" + Chr(34) + "id" + Chr(34) + "," + Chr(34) + "name" + Chr(34) + "," + Chr(34) + "active" + Chr(34) + "]},{" + Chr(34) + "commodities" + Chr(34) + ": [" + Chr(34) + "id" + Chr(34) + "," + Chr(34) + "name" + Chr(34) + "]},{" + Chr(34) + "created_by" + Chr(34) + ": [" + Chr(34) + "id" + Chr(34) + "," + Chr(34) + "login" + Chr(34) + "," + Chr(34) + "email" + Chr(34) + "]},{" + Chr(34) + "updated_by" + Chr(34) + ": [" + Chr(34) + "id" + Chr(34) + "," + Chr(34) + "login" + Chr(34) + "," + Chr(34) + "email" + 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/projects/: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,%22created_at%22,%22updated_at%22,%22name%22,%22active%22,%22open%22,%22description%22,%22mention-name%22,%22start-date%22,%22project-id%22,%22status%22,%7B%22template-group%22%3A%20%5B%22id%22,%22name%22%5D%7D,%7B%22category%22%3A%20%5B%22id%22,%22name%22,%22active%22%5D%7D,%7B%22commodities%22%3A%20%5B%22id%22,%22name%22%5D%7D,%7B%22created_by%22%3A%20%5B%22id%22,%22login%22,%22email%22%5D%7D,%7B%22updated_by%22%3A%20%5B%22id%22,%22login%22,%22email%22%5D%7D,%7B%22custom_fields%22%3A%20%7B%7D%7D%5D"
-H "Authorization: Bearer <access_token>"
https://domain.com/projects/:id
Postman Collection Item JSON
{
"name": "GET Project by ID",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{URL}}/projects/:id?fields=[\"id\",\"created_at\",\"updated_at\",\"name\",\"active\",\"open\",\"description\",\"mention-name\",\"start-date\",\"project-id\",\"status\",{\"template-group\": [\"id\",\"name\"]},{\"category\": [\"id\",\"name\",\"active\"]},{\"commodities\": [\"id\",\"name\"]},{\"created_by\": [\"id\",\"login\",\"email\"]},{\"updated_by\": [\"id\",\"login\",\"email\"]},{\"custom_fields\": {}}]",
"host": [
"{{URL}}"
],
"path": [
"projects",
":id"
],
"query": [
{
"key": "fields",
"value": "[\"id\",\"created_at\",\"updated_at\",\"name\",\"active\",\"open\",\"description\",\"mention-name\",\"start-date\",\"project-id\",\"status\",{\"template-group\": [\"id\",\"name\"]},{\"category\": [\"id\",\"name\",\"active\"]},{\"commodities\": [\"id\",\"name\"]},{\"created_by\": [\"id\",\"login\",\"email\"]},{\"updated_by\": [\"id\",\"login\",\"email\"]},{\"custom_fields\": {}}]"
}
],
"variable": [
{
"key": "id",
"value": "15"
}
]
}
},
"response": [
]
}