Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcOdata_context
LOCAL lnQueueDefinitionId
LOCAL lcOutputData
LOCAL lcAnalyticsData
LOCAL lcStatus
LOCAL lcReviewStatus
LOCAL lcReviewerUserId
LOCAL lcKey
LOCAL lcReference
LOCAL lcProcessingExceptionType
LOCAL lcDueDate
LOCAL lcRiskSlaDate
LOCAL lcPriority
LOCAL lcDeferDate
LOCAL lcStartProcessing
LOCAL lcEndProcessing
LOCAL lnSecondsInPreviousAttempts
LOCAL lcAncestorId
LOCAL lnRetryNumber
LOCAL lcSpecificData
LOCAL lcCreationTime
LOCAL lcProgress
LOCAL lcRowVersion
LOCAL lnOrganizationUnitId
LOCAL lcOrganizationUnitFullyQualifiedName
LOCAL lnId
LOCAL lcProcessingException
LOCAL lcName
LOCAL lcOutput
LOCAL lcAnalytics
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("X-UIPATH-OrganizationUnitId","{{folderId}}")
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/odata/QueueItems({{queueItemId}})",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* 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
lcOdata_context = loJResp.StringOf('"@odata.context"')
lnQueueDefinitionId = loJResp.IntOf("QueueDefinitionId")
lcOutputData = loJResp.StringOf("OutputData")
lcAnalyticsData = loJResp.StringOf("AnalyticsData")
lcStatus = loJResp.StringOf("Status")
lcReviewStatus = loJResp.StringOf("ReviewStatus")
lcReviewerUserId = loJResp.StringOf("ReviewerUserId")
lcKey = loJResp.StringOf("Key")
lcReference = loJResp.StringOf("Reference")
lcProcessingExceptionType = loJResp.StringOf("ProcessingExceptionType")
lcDueDate = loJResp.StringOf("DueDate")
lcRiskSlaDate = loJResp.StringOf("RiskSlaDate")
lcPriority = loJResp.StringOf("Priority")
lcDeferDate = loJResp.StringOf("DeferDate")
lcStartProcessing = loJResp.StringOf("StartProcessing")
lcEndProcessing = loJResp.StringOf("EndProcessing")
lnSecondsInPreviousAttempts = loJResp.IntOf("SecondsInPreviousAttempts")
lcAncestorId = loJResp.StringOf("AncestorId")
lnRetryNumber = loJResp.IntOf("RetryNumber")
lcSpecificData = loJResp.StringOf("SpecificData")
lcCreationTime = loJResp.StringOf("CreationTime")
lcProgress = loJResp.StringOf("Progress")
lcRowVersion = loJResp.StringOf("RowVersion")
lnOrganizationUnitId = loJResp.IntOf("OrganizationUnitId")
lcOrganizationUnitFullyQualifiedName = loJResp.StringOf("OrganizationUnitFullyQualifiedName")
lnId = loJResp.IntOf("Id")
lcProcessingException = loJResp.StringOf("ProcessingException")
lcName = loJResp.StringOf("SpecificContent.Name")
lcOutput = loJResp.StringOf("Output")
lcAnalytics = loJResp.StringOf("Analytics")
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
