Chilkat Online Tools

.NET Core C# / Orchestrator / Queue Items - Create

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

// 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": {
//     "Name": "TestQueue",
//     "Priority": "Normal",
//     "SpecificContent": {
//       "First": "Some String Value Here",
//       "First@odata.type": "#String",
//       "Second": 516,
//       "Fourth": "Did I skip the Third value?",
//       "AnotherKey": true
//     }
//   }
// }

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("itemData.Name","TestQueue");
json.UpdateString("itemData.Priority","Normal");
json.UpdateString("itemData.SpecificContent.First","Some String Value Here");
json.UpdateString("itemData.SpecificContent.\"First@odata.type\"","#String");
json.UpdateInt("itemData.SpecificContent.Second",516);
json.UpdateString("itemData.SpecificContent.Fourth","Did I skip the Third value?");
json.UpdateBool("itemData.SpecificContent.AnotherKey",true);

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

Chilkat.HttpResponse resp = http.PostJson3("https://domain.com/odata/Queues/UiPathODataSvc.AddQueueItem","application/json",json);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "@odata.context": "https://platform.uipath.com/odata/$metadata#queueItem/$entity",
//   "QueueDefinitionId": 33196,
//   "OutputData": null,
//   "Status": "New",
//   "ReviewStatus": "None",
//   "ReviewerUserId": null,
//   "Key": "7aa9a82d-781b-45e5-ba14-d1758825e314",
//   "Reference": null,
//   "ProcessingExceptionType": null,
//   "DueDate": null,
//   "Priority": "Normal",
//   "DeferDate": null,
//   "StartProcessing": null,
//   "EndProcessing": null,
//   "SecondsInPreviousAttempts": 0,
//   "AncestorId": null,
//   "RetryNumber": 0,
//   "SpecificData": "{\"DynamicProperties\":{\"Type\":\"Customer\",\"Name\":\"Some Guy\"}}",
//   "CreationTime": "2018-07-31T12:39:07.6923552Z",
//   "Progress": null,
//   "RowVersion": "AAAAAADu9Mg=",
//   "Id": 3888968,
//   "ProcessingException": null,
//   "SpecificContent": {
//     "Type": "Customer",
//     "Name": "Some Guy"
//   },
//   "Output": null
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

string odata_context = jResp.StringOf("\"@odata.context\"");
int QueueDefinitionId = jResp.IntOf("QueueDefinitionId");
string OutputData = jResp.StringOf("OutputData");
string Status = jResp.StringOf("Status");
string ReviewStatus = jResp.StringOf("ReviewStatus");
string ReviewerUserId = jResp.StringOf("ReviewerUserId");
string Key = jResp.StringOf("Key");
string Reference = jResp.StringOf("Reference");
string ProcessingExceptionType = jResp.StringOf("ProcessingExceptionType");
string DueDate = jResp.StringOf("DueDate");
string Priority = jResp.StringOf("Priority");
string DeferDate = jResp.StringOf("DeferDate");
string StartProcessing = jResp.StringOf("StartProcessing");
string EndProcessing = jResp.StringOf("EndProcessing");
int SecondsInPreviousAttempts = jResp.IntOf("SecondsInPreviousAttempts");
string AncestorId = jResp.StringOf("AncestorId");
int RetryNumber = jResp.IntOf("RetryNumber");
string SpecificData = jResp.StringOf("SpecificData");
string CreationTime = jResp.StringOf("CreationTime");
string Progress = jResp.StringOf("Progress");
string RowVersion = jResp.StringOf("RowVersion");
int Id = jResp.IntOf("Id");
string ProcessingException = jResp.StringOf("ProcessingException");
string v_Type = jResp.StringOf("SpecificContent.Type");
string Name = jResp.StringOf("SpecificContent.Name");
string Output = jResp.StringOf("Output");

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 '{
    "itemData": {
        "Name": "TestQueue",
        "Priority": "Normal",
        "SpecificContent": {
            "First": "Some String Value Here",
    		"First@odata.type": "#String",
            "Second": 516,
            "Fourth": "Did I skip the Third value?",
            "AnotherKey": true
        }
    }
}'
https://domain.com/odata/Queues/UiPathODataSvc.AddQueueItem

Postman Collection Item JSON

{
  "name": "Queue Items - 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": "{\n    \"itemData\": {\n        \"Name\": \"TestQueue\",\n        \"Priority\": \"Normal\",\n        \"SpecificContent\": {\n            \"First\": \"Some String Value Here\",\n    \t\t\"First@odata.type\": \"#String\",\n            \"Second\": 516,\n            \"Fourth\": \"Did I skip the Third value?\",\n            \"AnotherKey\": true\n        }\n    }\n}"
    },
    "url": {
      "raw": "{{url}}/odata/Queues/UiPathODataSvc.AddQueueItem",
      "host": [
        "{{url}}"
      ],
      "path": [
        "odata",
        "Queues",
        "UiPathODataSvc.AddQueueItem"
      ]
    },
    "description": "Add an item to a Queue"
  },
  "response": [
    {
      "name": "Queue Items - Create",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"itemData\": {\n        \"Name\": \"TestQueue\",\n        \"Priority\": \"Normal\",\n        \"SpecificContent\": {\n            \"Type\": \"Customer\",\n    \t\t\"Name@odata.type\": \"#String\",\n            \"Name\": \"Some Guy\"\n        }\n    }\n}"
        },
        "url": {
          "raw": "{{url}}/odata/Queues/UiPathODataSvc.AddQueueItem",
          "host": [
            "{{url}}"
          ],
          "path": [
            "odata",
            "Queues",
            "UiPathODataSvc.AddQueueItem"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "CF-RAY",
          "value": "44302040491791fa-EWR",
          "name": "CF-RAY",
          "description": "Custom header"
        },
        {
          "key": "Cache-Control",
          "value": "no-store, must-revalidate, no-cache, max-age=0",
          "name": "Cache-Control",
          "description": "Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"
        },
        {
          "key": "Connection",
          "value": "keep-alive",
          "name": "Connection",
          "description": "Options that are desired for the connection"
        },
        {
          "key": "Content-Length",
          "value": "725",
          "name": "Content-Length",
          "description": "The length of the response body in octets (8-bit bytes)"
        },
        {
          "key": "Content-Type",
          "value": "application/json; odata.metadata=minimal",
          "name": "Content-Type",
          "description": "The mime type of this content"
        },
        {
          "key": "Date",
          "value": "Tue, 31 Jul 2018 12:39:07 GMT",
          "name": "Date",
          "description": "The date and time that the message was sent"
        },
        {
          "key": "Expect-CT",
          "value": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"",
          "name": "Expect-CT",
          "description": "Custom header"
        },
        {
          "key": "Location",
          "value": "https://platform.uipath.com/odata/queueItem(3888968)",
          "name": "Location",
          "description": "Used in redirection, or when a new resource has been created."
        },
        {
          "key": "OData-Version",
          "value": "4.0",
          "name": "OData-Version",
          "description": "Custom header"
        },
        {
          "key": "Server",
          "value": "cloudflare",
          "name": "Server",
          "description": "A name for the server"
        },
        {
          "key": "Set-Cookie",
          "value": "; SameSite=lax",
          "name": "Set-Cookie",
          "description": "an HTTP cookie"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains",
          "name": "Strict-Transport-Security",
          "description": "A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff",
          "name": "X-Content-Type-Options",
          "description": "The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"
        },
        {
          "key": "X-Frame-Options",
          "value": "DENY",
          "name": "X-Frame-Options",
          "description": "Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"
        },
        {
          "key": "api-supported-versions",
          "value": "5.0",
          "name": "api-supported-versions",
          "description": "Custom header"
        }
      ],
      "cookie": [
        {
          "expires": "Wed Dec 19 2018 11:35:02 GMT-0600 (Central Standard Time)",
          "httpOnly": true,
          "domain": "uipath.com",
          "path": "/",
          "secure": true,
          "value": "d3b89a558feb68050f4b847c971f595771513704902",
          "key": "__cfduid"
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/odata/QueueProcessingRecords",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/api/RobotsService",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/odata/Processes",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/odata/Settings",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/odata/Robots",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/odata/Queues",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/odata/Assets",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/api/Account",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/odata/Users",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/odata/Jobs",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/api/Logs",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/Account",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/odata",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/api",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/",
          "secure": false,
          "value": "",
          "key": ""
        },
        {
          "expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
          "httpOnly": false,
          "domain": "platform.uipath.com",
          "path": "/",
          "secure": false,
          "value": "GC-osp2U-YDhoXTOqXnUp3DaN1cN_siVCaNVue_jljOcqJLYHQrRk5msz52KHL8XauydRYx_3JyjLtLDpItypCPdEL20jFnxlF2g-f86Qk41",
          "key": "__RequestVerificationToken"
        }
      ],
      "body": "{\"@odata.context\":\"https://platform.uipath.com/odata/$metadata#queueItem/$entity\",\"QueueDefinitionId\":33196,\"OutputData\":null,\"Status\":\"New\",\"ReviewStatus\":\"None\",\"ReviewerUserId\":null,\"Key\":\"7aa9a82d-781b-45e5-ba14-d1758825e314\",\"Reference\":null,\"ProcessingExceptionType\":null,\"DueDate\":null,\"Priority\":\"Normal\",\"DeferDate\":null,\"StartProcessing\":null,\"EndProcessing\":null,\"SecondsInPreviousAttempts\":0,\"AncestorId\":null,\"RetryNumber\":0,\"SpecificData\":\"{\\\"DynamicProperties\\\":{\\\"Type\\\":\\\"Customer\\\",\\\"Name\\\":\\\"Some Guy\\\"}}\",\"CreationTime\":\"2018-07-31T12:39:07.6923552Z\",\"Progress\":null,\"RowVersion\":\"AAAAAADu9Mg=\",\"Id\":3888968,\"ProcessingException\":null,\"SpecificContent\":{\"Type\":\"Customer\",\"Name\":\"Some Guy\"},\"Output\":null}"
    }
  ]
}