Chilkat Online Tools

Swift / Orchestrator API Documentation / Get Queue Item by ID

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>"
    http.SetRequestHeader("X-UIPATH-OrganizationUnitId", value: "{{folderId}}")

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://domain.com/odata/QueueItems({{queueItemId}})", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

    // 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.44Z",
    //   "RiskSlaDate": null,
    //   "Priority": "Normal",
    //   "DeferDate": "2021-03-11T14:19:56.44Z",
    //   "StartProcessing": null,
    //   "EndProcessing": null,
    //   "SecondsInPreviousAttempts": 0,
    //   "AncestorId": null,
    //   "RetryNumber": 0,
    //   "SpecificData": "{\"DynamicProperties\":{\"Name\":\"Testymonika2000\"}}",
    //   "CreationTime": "2021-03-31T12:55:21.783Z",
    //   "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

    var odata_context: String? = jResp.StringOf("\"@odata.context\"")
    var QueueDefinitionId: Int = jResp.IntOf("QueueDefinitionId").intValue
    var OutputData: String? = jResp.StringOf("OutputData")
    var AnalyticsData: String? = jResp.StringOf("AnalyticsData")
    var Status: String? = jResp.StringOf("Status")
    var ReviewStatus: String? = jResp.StringOf("ReviewStatus")
    var ReviewerUserId: String? = jResp.StringOf("ReviewerUserId")
    var Key: String? = jResp.StringOf("Key")
    var Reference: String? = jResp.StringOf("Reference")
    var ProcessingExceptionType: String? = jResp.StringOf("ProcessingExceptionType")
    var DueDate: String? = jResp.StringOf("DueDate")
    var RiskSlaDate: String? = jResp.StringOf("RiskSlaDate")
    var Priority: String? = jResp.StringOf("Priority")
    var DeferDate: String? = jResp.StringOf("DeferDate")
    var StartProcessing: String? = jResp.StringOf("StartProcessing")
    var EndProcessing: String? = jResp.StringOf("EndProcessing")
    var SecondsInPreviousAttempts: Int = jResp.IntOf("SecondsInPreviousAttempts").intValue
    var AncestorId: String? = jResp.StringOf("AncestorId")
    var RetryNumber: Int = jResp.IntOf("RetryNumber").intValue
    var SpecificData: String? = jResp.StringOf("SpecificData")
    var CreationTime: String? = jResp.StringOf("CreationTime")
    var Progress: String? = jResp.StringOf("Progress")
    var RowVersion: String? = jResp.StringOf("RowVersion")
    var OrganizationUnitId: Int = jResp.IntOf("OrganizationUnitId").intValue
    var OrganizationUnitFullyQualifiedName: String? = jResp.StringOf("OrganizationUnitFullyQualifiedName")
    var Id: Int = jResp.IntOf("Id").intValue
    var ProcessingException: String? = jResp.StringOf("ProcessingException")
    var Name: String? = jResp.StringOf("SpecificContent.Name")
    var Output: String? = jResp.StringOf("Output")
    var Analytics: String? = jResp.StringOf("Analytics")

}

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/odata/QueueItems({{queueItemId}})

Postman Collection Item JSON

{
  "name": "Get Queue Item by ID",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "//test status code\r",
          "pm.test(\"Status code is 200\", function () {\r",
          "    pm.response.to.have.status(200);\r",
          "});\r",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "description": "Folder/OrganizationUnit Id",
        "key": "X-UIPATH-OrganizationUnitId",
        "value": "{{folderId}}"
      }
    ],
    "url": {
      "raw": "{{url}}/odata/QueueItems({{queueItemId}})",
      "host": [
        "{{url}}"
      ],
      "path": [
        "odata",
        "QueueItems({{queueItemId}})"
      ],
      "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.Read.\r\n\r\nRequired permissions: Queues.View and Transactions.View."
  },
  "response": [
    {
      "name": "Get Queue Item by ID",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Folder/OrganizationUnit Id",
            "key": "X-UIPATH-OrganizationUnitId",
            "value": "{{folderId}}"
          }
        ],
        "url": {
          "raw": "{{url}}/odata/QueueItems({{queueItemId}})",
          "host": [
            "{{url}}"
          ],
          "path": [
            "odata",
            "QueueItems({{queueItemId}})"
          ],
          "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": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 31 Mar 2021 12:55:30 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": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "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": "b293055b-0924-4b58-bcaf-c4e6c7622b30"
        },
        {
          "key": "OData-Version",
          "value": "4.0"
        },
        {
          "key": "api-supported-versions",
          "value": "12.0"
        },
        {
          "key": "CF-Cache-Status",
          "value": "DYNAMIC"
        },
        {
          "key": "cf-request-id",
          "value": "0929f383d20000cba029166000000001"
        },
        {
          "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": "6389bb7fbf77cba0-VIE"
        },
        {
          "key": "Content-Encoding",
          "value": "br"
        }
      ],
      "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.44Z\",\n    \"RiskSlaDate\": null,\n    \"Priority\": \"Normal\",\n    \"DeferDate\": \"2021-03-11T14:19:56.44Z\",\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.783Z\",\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}"
    }
  ]
}