Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "itemData": {
// "DeferDate": "2021-03-11T14:19:56.4407392Z",
// "DueDate": "2021-03-11T15:19:56.4407392Z",
// "Priority": "Normal",
// "Name": "UnattendedQueue",
// "SpecificContent": {
// "Name@odata.type": "#String",
// "Name": "Testymonika2000"
// },
// "Reference": "Petstore"
// }
// }
$json = new CkJsonObject();
$json->UpdateString('itemData.DeferDate','2021-03-11T14:19:56.4407392Z');
$json->UpdateString('itemData.DueDate','2021-03-11T15:19:56.4407392Z');
$json->UpdateString('itemData.Priority','Normal');
$json->UpdateString('itemData.Name','UnattendedQueue');
$json->UpdateString('itemData.SpecificContent.\'Name@odata.type\'','#String');
$json->UpdateString('itemData.SpecificContent.Name','Testymonika2000');
$json->UpdateString('itemData.Reference','Petstore');
$http->SetRequestHeader('Content-Type','application/json');
// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$http->SetRequestHeader('X-UIPATH-OrganizationUnitId','{{folderId}}');
// resp is a CkHttpResponse
$resp = $http->PostJson3('https://domain.com/odata/Queues/UiPathODataSvc.AddQueueItem','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#QueueItems/$entity",
// "QueueDefinitionId": 28211,
// "OutputData": null,
// "AnalyticsData": null,
// "Status": "New",
// "ReviewStatus": "None",
// "ReviewerUserId": null,
// "Key": "883749b2-70cd-4beb-b0a7-4fd260d26635",
// "Reference": "Petstore",
// "ProcessingExceptionType": null,
// "DueDate": "2021-03-11T15:19:56.4407392Z",
// "RiskSlaDate": null,
// "Priority": "Normal",
// "DeferDate": "2021-03-11T14:19:56.4407392Z",
// "StartProcessing": null,
// "EndProcessing": null,
// "SecondsInPreviousAttempts": 0,
// "AncestorId": null,
// "RetryNumber": 0,
// "SpecificData": "{\"DynamicProperties\":{\"Name\":\"Testymonika2000\"}}",
// "CreationTime": "2021-03-31T12:55:21.7835527Z",
// "Progress": null,
// "RowVersion": "AAAAAAbEaR8=",
// "OrganizationUnitId": 515128,
// "OrganizationUnitFullyQualifiedName": null,
// "Id": 45403309,
// "ProcessingException": null,
// "SpecificContent": {
// "Name": "Testymonika2000"
// },
// "Output": null,
// "Analytics": null
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$odata_context = $jResp->stringOf('\'@odata.context\'');
$QueueDefinitionId = $jResp->IntOf('QueueDefinitionId');
$OutputData = $jResp->stringOf('OutputData');
$AnalyticsData = $jResp->stringOf('AnalyticsData');
$Status = $jResp->stringOf('Status');
$ReviewStatus = $jResp->stringOf('ReviewStatus');
$ReviewerUserId = $jResp->stringOf('ReviewerUserId');
$Key = $jResp->stringOf('Key');
$Reference = $jResp->stringOf('Reference');
$ProcessingExceptionType = $jResp->stringOf('ProcessingExceptionType');
$DueDate = $jResp->stringOf('DueDate');
$RiskSlaDate = $jResp->stringOf('RiskSlaDate');
$Priority = $jResp->stringOf('Priority');
$DeferDate = $jResp->stringOf('DeferDate');
$StartProcessing = $jResp->stringOf('StartProcessing');
$EndProcessing = $jResp->stringOf('EndProcessing');
$SecondsInPreviousAttempts = $jResp->IntOf('SecondsInPreviousAttempts');
$AncestorId = $jResp->stringOf('AncestorId');
$RetryNumber = $jResp->IntOf('RetryNumber');
$SpecificData = $jResp->stringOf('SpecificData');
$CreationTime = $jResp->stringOf('CreationTime');
$Progress = $jResp->stringOf('Progress');
$RowVersion = $jResp->stringOf('RowVersion');
$OrganizationUnitId = $jResp->IntOf('OrganizationUnitId');
$OrganizationUnitFullyQualifiedName = $jResp->stringOf('OrganizationUnitFullyQualifiedName');
$Id = $jResp->IntOf('Id');
$ProcessingException = $jResp->stringOf('ProcessingException');
$Name = $jResp->stringOf('SpecificContent.Name');
$Output = $jResp->stringOf('Output');
$Analytics = $jResp->stringOf('Analytics');
?>
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
-H "Content-Type: application/json"
-d '{
"itemData": {
"DeferDate": "2021-03-11T14:19:56.4407392Z",
"DueDate": "2021-03-11T15:19:56.4407392Z",
"Priority": "Normal",
"Name": "UnattendedQueue",
"SpecificContent": {
"Name@odata.type": "#String",
"Name": "Testymonika2000"
},
"Reference": "Petstore"
}
}'
https://domain.com/odata/Queues/UiPathODataSvc.AddQueueItem
Postman Collection Item JSON
{
"name": "Add Queue Item",
"event": [
{
"listen": "test",
"script": {
"exec": [
"//test status code\r",
"pm.test(\"Status code is 201\", function () {\r",
" pm.response.to.have.status(201);\r",
"});\r",
"\r",
"//set JobId key\r",
"var myResponse = pm.response.json();\r",
"pm.collectionVariables.set(\"queueItemId\", myResponse.Id);\r",
"console.log(pm.collectionVariables.get(\"queueItemId\"));"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"description": "Folder/OrganizationUnit Id",
"key": "X-UIPATH-OrganizationUnitId",
"value": "{{folderId}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"itemData\": {\n \"DeferDate\": \"2021-03-11T14:19:56.4407392Z\",\n \"DueDate\": \"2021-03-11T15:19:56.4407392Z\",\n \"Priority\": \"Normal\",\n \"Name\": \"UnattendedQueue\",\n \"SpecificContent\": {\n \"Name@odata.type\": \"#String\",\n \"Name\": \"Testymonika2000\"\n },\n \"Reference\": \"Petstore\"\n }\n}"
},
"url": {
"raw": "{{url}}/odata/Queues/UiPathODataSvc.AddQueueItem",
"host": [
"{{url}}"
],
"path": [
"odata",
"Queues",
"UiPathODataSvc.AddQueueItem"
],
"query": [
{
"key": "$expand",
"value": "",
"description": "Indicates the related entities to be represented inline. The maximum depth is 2.",
"disabled": true
},
{
"key": "$select",
"value": "",
"description": "Limits the properties returned in the result.",
"disabled": true
}
]
},
"description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\r\n\r\nRequired permissions: Queues.View and Transactions.Create."
},
"response": [
{
"name": "Add Queue Item",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Folder/OrganizationUnit Id",
"key": "X-UIPATH-OrganizationUnitId",
"value": "{{folderId}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"itemData\": {\n \"DeferDate\": \"2021-03-11T14:19:56.4407392Z\",\n \"DueDate\": \"2021-03-11T15:19:56.4407392Z\",\n \"Priority\": \"Normal\",\n \"Name\": \"UnattendedQueue\",\n \"SpecificContent\": {\n \"Name@odata.type\": \"#String\",\n \"Name\": \"Testymonika2000\"\n },\n \"Reference\": \"Petstore\"\n }\n}"
},
"url": {
"raw": "{{url}}/odata/Queues/UiPathODataSvc.AddQueueItem",
"host": [
"{{url}}"
],
"path": [
"odata",
"Queues",
"UiPathODataSvc.AddQueueItem"
],
"query": [
{
"key": "$expand",
"value": "",
"description": "Indicates the related entities to be represented inline. The maximum depth is 2.",
"disabled": true
},
{
"key": "$select",
"value": "",
"description": "Limits the properties returned in the result.",
"disabled": true
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 31 Mar 2021 12:55:21 GMT"
},
{
"key": "Content-Type",
"value": "application/json; odata.metadata=minimal; odata.streaming=true"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, must-revalidate"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Expires",
"value": "-1"
},
{
"key": "Location",
"value": "https://cloud.uipath.com/robertorg/modernDepartment/orchestrator_/odata/QueueItems(45403309)"
},
{
"key": "Request-Context",
"value": "appId=cid-v1:04884d99-0742-441b-a23c-847133cb0130"
},
{
"key": "X-Robots-Tag",
"value": "noindex,nofollow"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-XSS-Protection",
"value": "1"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Frame-Options",
"value": "Deny"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains"
},
{
"key": "Content-Security-Policy",
"value": "default-src 'self';script-src 'self';style-src 'self' 'unsafe-inline';img-src 'self' data: https://*.blob.core.windows.net https://*.amazonaws.com blob:;font-src 'self' data:;connect-src 'self' wss: https://sentry.io https://studio-feedback.azure-api.net https://storage.googleapis.com https://*.service.signalr.net https://*.blob.core.windows.net https://*.amazonaws.com dc.services.visualstudio.com;worker-src 'self' blob:"
},
{
"key": "X-Correlation-ID",
"value": "d758dbc2-952a-4cc6-b6d7-0685f3a83b7e"
},
{
"key": "OData-Version",
"value": "4.0"
},
{
"key": "api-supported-versions",
"value": "12.0"
},
{
"key": "CF-Cache-Status",
"value": "DYNAMIC"
},
{
"key": "cf-request-id",
"value": "0929f3610d0000cba027173000000001"
},
{
"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": "6389bb481bf4cba0-VIE"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#QueueItems/$entity\",\n \"QueueDefinitionId\": 28211,\n \"OutputData\": null,\n \"AnalyticsData\": null,\n \"Status\": \"New\",\n \"ReviewStatus\": \"None\",\n \"ReviewerUserId\": null,\n \"Key\": \"883749b2-70cd-4beb-b0a7-4fd260d26635\",\n \"Reference\": \"Petstore\",\n \"ProcessingExceptionType\": null,\n \"DueDate\": \"2021-03-11T15:19:56.4407392Z\",\n \"RiskSlaDate\": null,\n \"Priority\": \"Normal\",\n \"DeferDate\": \"2021-03-11T14:19:56.4407392Z\",\n \"StartProcessing\": null,\n \"EndProcessing\": null,\n \"SecondsInPreviousAttempts\": 0,\n \"AncestorId\": null,\n \"RetryNumber\": 0,\n \"SpecificData\": \"{\\\"DynamicProperties\\\":{\\\"Name\\\":\\\"Testymonika2000\\\"}}\",\n \"CreationTime\": \"2021-03-31T12:55:21.7835527Z\",\n \"Progress\": null,\n \"RowVersion\": \"AAAAAAbEaR8=\",\n \"OrganizationUnitId\": 515128,\n \"OrganizationUnitFullyQualifiedName\": null,\n \"Id\": 45403309,\n \"ProcessingException\": null,\n \"SpecificContent\": {\n \"Name\": \"Testymonika2000\"\n },\n \"Output\": null,\n \"Analytics\": null\n}"
}
]
}
