Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject json;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *odata_context;
const char *Name;
const char *Description;
int MaxNumberOfRetries;
BOOL AcceptAutomaticallyRetry;
BOOL EnforceUniqueReference;
const char *CreationTime;
int Id;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "Name": "NewQueue",
// "Description": "A queue created with the Orchestrator API",
// "MaxNumberOfRetries": 1,
// "AcceptAutomaticallyRetry": true,
// "EnforceUniqueReference": false
// }
json = CkJsonObject_Create();
CkJsonObject_UpdateString(json,"Name","NewQueue");
CkJsonObject_UpdateString(json,"Description","A queue created with the Orchestrator API");
CkJsonObject_UpdateInt(json,"MaxNumberOfRetries",1);
CkJsonObject_UpdateBool(json,"AcceptAutomaticallyRetry",TRUE);
CkJsonObject_UpdateBool(json,"EnforceUniqueReference",FALSE);
CkHttp_SetRequestHeader(http,"Content-Type","application/json");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,"<access_token>");
CkHttp_SetRequestHeader(http,"X-UIPATH-OrganizationUnitId","{{folderId}}");
CkHttp_SetRequestHeader(http,"X-UIPATH-TenantName","{{tenantName}}");
resp = CkHttp_PostJson3(http,"https://domain.com/odata/QueueDefinitions","application/json",json);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "@odata.context": "https://platform.uipath.com/odata/$metadata#QueueDefinitions/$entity",
// "Name": "NewQueue",
// "Description": "A queue created with the Orchestrator API",
// "MaxNumberOfRetries": 1,
// "AcceptAutomaticallyRetry": true,
// "EnforceUniqueReference": false,
// "CreationTime": "2018-12-01T10:31:22.176966Z",
// "Id": 67671
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
odata_context = CkJsonObject_stringOf(jResp,"\"@odata.context\"");
Name = CkJsonObject_stringOf(jResp,"Name");
Description = CkJsonObject_stringOf(jResp,"Description");
MaxNumberOfRetries = CkJsonObject_IntOf(jResp,"MaxNumberOfRetries");
AcceptAutomaticallyRetry = CkJsonObject_BoolOf(jResp,"AcceptAutomaticallyRetry");
EnforceUniqueReference = CkJsonObject_BoolOf(jResp,"EnforceUniqueReference");
CreationTime = CkJsonObject_stringOf(jResp,"CreationTime");
Id = CkJsonObject_IntOf(jResp,"Id");
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-H "X-UIPATH-TenantName: {{tenantName}}"
-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
-d '{
"Name": "NewQueue",
"Description": "A queue created with the Orchestrator API",
"MaxNumberOfRetries": 1,
"AcceptAutomaticallyRetry": true,
"EnforceUniqueReference": false
}'
https://domain.com/odata/QueueDefinitions
Postman Collection Item JSON
{
"name": "Queues - Create",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
},
{
"key": "X-UIPATH-TenantName",
"value": "{{tenantName}}",
"type": "text"
},
{
"key": "X-UIPATH-OrganizationUnitId",
"value": "{{folderId}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"Name\": \"NewQueue\",\r\n \"Description\": \"A queue created with the Orchestrator API\",\r\n \"MaxNumberOfRetries\": 1,\r\n \"AcceptAutomaticallyRetry\": true,\r\n \"EnforceUniqueReference\": false\r\n}"
},
"url": {
"raw": "{{url}}/odata/QueueDefinitions",
"host": [
"{{url}}"
],
"path": [
"odata",
"QueueDefinitions"
]
}
},
"response": [
{
"name": "Create New Queue",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"Name\": \"NewQueue\",\r\n \"Description\": \"A queue created with the Orchestrator API\",\r\n \"MaxNumberOfRetries\": 1,\r\n \"AcceptAutomaticallyRetry\": true,\r\n \"EnforceUniqueReference\": false\r\n}"
},
"url": {
"raw": "{{url}}/odata/QueueDefinitions",
"host": [
"{{url}}"
],
"path": [
"odata",
"QueueDefinitions"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Sat, 01 Dec 2018 10:31:22 GMT"
},
{
"key": "Content-Type",
"value": "application/json; odata.metadata=minimal"
},
{
"key": "Content-Length",
"value": "307"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Cache-Control",
"value": "no-store, must-revalidate, no-cache, max-age=0"
},
{
"key": "Location",
"value": "https://platform.uipath.com/odata/QueueDefinitions(67671)"
},
{
"key": "Set-Cookie",
"value": "; SameSite=lax"
},
{
"key": "api-supported-versions",
"value": "7.0"
},
{
"key": "OData-Version",
"value": "4.0"
},
{
"key": "Request-Context",
"value": "appId=cid-v1:d00ce63d-0891-41e4-a17c-25b2c5382e49"
},
{
"key": "Access-Control-Expose-Headers",
"value": "Request-Context"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains"
},
{
"key": "Expect-CT",
"value": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""
},
{
"key": "Server",
"value": "cloudflare"
},
{
"key": "CF-RAY",
"value": "4824e23a39c4c297-FRA"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://platform.uipath.com/odata/$metadata#QueueDefinitions/$entity\",\n \"Name\": \"NewQueue\",\n \"Description\": \"A queue created with the Orchestrator API\",\n \"MaxNumberOfRetries\": 1,\n \"AcceptAutomaticallyRetry\": true,\n \"EnforceUniqueReference\": false,\n \"CreationTime\": \"2018-12-01T10:31:22.176966Z\",\n \"Id\": 67671\n}"
}
]
}
