Chilkat Online Tools

phpExt / Orchestrator / Queues - Create

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.

// {
//   "Name": "NewQueue",
//   "Description": "A queue created with the Orchestrator API",
//   "MaxNumberOfRetries": 1,
//   "AcceptAutomaticallyRetry": true,
//   "EnforceUniqueReference": false
// }

$json = new CkJsonObject();
$json->UpdateString('Name','NewQueue');
$json->UpdateString('Description','A queue created with the Orchestrator API');
$json->UpdateInt('MaxNumberOfRetries',1);
$json->UpdateBool('AcceptAutomaticallyRetry',true);
$json->UpdateBool('EnforceUniqueReference',false);

$http->SetRequestHeader('Content-Type','application/json');
// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$http->SetRequestHeader('X-UIPATH-OrganizationUnitId','{{folderId}}');
$http->SetRequestHeader('X-UIPATH-TenantName','{{tenantName}}');

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://domain.com/odata/QueueDefinitions','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://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

$odata_context = $jResp->stringOf('\'@odata.context\'');
$Name = $jResp->stringOf('Name');
$Description = $jResp->stringOf('Description');
$MaxNumberOfRetries = $jResp->IntOf('MaxNumberOfRetries');
$AcceptAutomaticallyRetry = $jResp->BoolOf('AcceptAutomaticallyRetry');
$EnforceUniqueReference = $jResp->BoolOf('EnforceUniqueReference');
$CreationTime = $jResp->stringOf('CreationTime');
$Id = $jResp->IntOf('Id');

?>

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}"
    }
  ]
}