Chilkat Online Tools

delphiAx / Orchestrator / Queues Items- Get all by queue id

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
QueueDefinitionId: Integer;
OutputData: WideString;
Status: WideString;
ReviewStatus: WideString;
ReviewerUserId: WideString;
Key: WideString;
Reference: WideString;
ProcessingExceptionType: WideString;
DueDate: WideString;
Priority: WideString;
DeferDate: WideString;
StartProcessing: WideString;
EndProcessing: WideString;
SecondsInPreviousAttempts: Integer;
AncestorId: WideString;
RetryNumber: Integer;
SpecificData: WideString;
CreationTime: WideString;
Progress: WideString;
RowVersion: WideString;
Id: Integer;
ProcessingException: WideString;
v_Type: WideString;
Name: WideString;
Output: WideString;
odata_context: WideString;
odata_count: Integer;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('$filter','QueueDefinitionId eq 33196');

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}}');

resp := http.QuickRequestParams('GET','https://domain.com/odata/QueueItems',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

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

// {
//   "@odata.context": "https://platform.uipath.com/odata/$metadata#QueueItems",
//   "@odata.count": 1,
//   "value": [
//     {
//       "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.693Z",
//       "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

odata_context := jResp.StringOf('"@odata.context"');
odata_count := jResp.IntOf('"@odata.count"');
i := 0;
count_i := jResp.SizeOfArray('value');
while i < count_i do
  begin
    jResp.I := i;
    QueueDefinitionId := jResp.IntOf('value[i].QueueDefinitionId');
    OutputData := jResp.StringOf('value[i].OutputData');
    Status := jResp.StringOf('value[i].Status');
    ReviewStatus := jResp.StringOf('value[i].ReviewStatus');
    ReviewerUserId := jResp.StringOf('value[i].ReviewerUserId');
    Key := jResp.StringOf('value[i].Key');
    Reference := jResp.StringOf('value[i].Reference');
    ProcessingExceptionType := jResp.StringOf('value[i].ProcessingExceptionType');
    DueDate := jResp.StringOf('value[i].DueDate');
    Priority := jResp.StringOf('value[i].Priority');
    DeferDate := jResp.StringOf('value[i].DeferDate');
    StartProcessing := jResp.StringOf('value[i].StartProcessing');
    EndProcessing := jResp.StringOf('value[i].EndProcessing');
    SecondsInPreviousAttempts := jResp.IntOf('value[i].SecondsInPreviousAttempts');
    AncestorId := jResp.StringOf('value[i].AncestorId');
    RetryNumber := jResp.IntOf('value[i].RetryNumber');
    SpecificData := jResp.StringOf('value[i].SpecificData');
    CreationTime := jResp.StringOf('value[i].CreationTime');
    Progress := jResp.StringOf('value[i].Progress');
    RowVersion := jResp.StringOf('value[i].RowVersion');
    Id := jResp.IntOf('value[i].Id');
    ProcessingException := jResp.StringOf('value[i].ProcessingException');
    v_Type := jResp.StringOf('value[i].SpecificContent.Type');
    Name := jResp.StringOf('value[i].SpecificContent.Name');
    Output := jResp.StringOf('value[i].Output');
    i := i + 1;
  end;

Curl Command

curl -G -d "$filter=QueueDefinitionId%20eq%2033196"
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "X-UIPATH-TenantName: {{tenantName}}"
	-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/odata/QueueItems

Postman Collection Item JSON

{
  "name": "Queues Items- Get all by queue id",
  "request": {
    "method": "GET",
    "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"
      }
    ],
    "url": {
      "raw": "{{url}}/odata/QueueItems?$filter=QueueDefinitionId eq 33196",
      "host": [
        "{{url}}"
      ],
      "path": [
        "odata",
        "QueueItems"
      ],
      "query": [
        {
          "key": "$filter",
          "value": "QueueDefinitionId eq 33196"
        }
      ]
    }
  },
  "response": [
    {
      "name": "Queues Items- Get all by queue id",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "disabled": false
          }
        ],
        "url": {
          "raw": "{{url}}/odata/QueueItems?$filter=QueueDefinitionId eq 33196",
          "host": [
            "{{url}}"
          ],
          "path": [
            "odata",
            "QueueItems"
          ],
          "query": [
            {
              "key": "$filter",
              "value": "QueueDefinitionId eq 33196"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "CF-RAY",
          "value": "44302246a9fb91fa-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-Encoding",
          "value": "gzip",
          "name": "Content-Encoding",
          "description": "The type of encoding used on the data."
        },
        {
          "key": "Content-Length",
          "value": "609",
          "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:40:30 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": "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": "Vary",
          "value": "Accept-Encoding",
          "name": "Vary",
          "description": "Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."
        },
        {
          "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#QueueItems\",\"@odata.count\":1,\"value\":[{\"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.693Z\",\"Progress\":null,\"RowVersion\":\"AAAAAADu9Mg=\",\"Id\":3888968,\"ProcessingException\":null,\"SpecificContent\":{\"Type\":\"Customer\",\"Name\":\"Some Guy\"},\"Output\":null}]}"
    }
  ]
}