PowerBuilder / Orchestrator / Queue Items - Create
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Odata_context
integer li_QueueDefinitionId
string ls_OutputData
string ls_Status
string ls_ReviewStatus
string ls_ReviewerUserId
string ls_Key
string ls_Reference
string ls_ProcessingExceptionType
string ls_DueDate
string ls_Priority
string ls_DeferDate
string ls_StartProcessing
string ls_EndProcessing
integer li_SecondsInPreviousAttempts
string ls_AncestorId
integer li_RetryNumber
string ls_SpecificData
string ls_CreationTime
string ls_Progress
string ls_RowVersion
integer li_Id
string ls_ProcessingException
string ls_V_Type
string ls_Name
string ls_Output
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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
// }
// }
// }
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_Json.UpdateString("itemData.Name","TestQueue")
loo_Json.UpdateString("itemData.Priority","Normal")
loo_Json.UpdateString("itemData.SpecificContent.First","Some String Value Here")
loo_Json.UpdateString("itemData.SpecificContent.~"First@odata.type~"","#String")
loo_Json.UpdateInt("itemData.SpecificContent.Second",516)
loo_Json.UpdateString("itemData.SpecificContent.Fourth","Did I skip the Third value?")
loo_Json.UpdateBool("itemData.SpecificContent.AnotherKey",1)
loo_Http.SetRequestHeader("Content-Type","application/json")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("X-UIPATH-OrganizationUnitId","{{folderId}}")
loo_Http.SetRequestHeader("X-UIPATH-TenantName","{{tenantName}}")
loo_Resp = loo_Http.PostJson3("https://domain.com/odata/Queues/UiPathODataSvc.AddQueueItem","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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
ls_Odata_context = loo_JResp.StringOf("~"@odata.context~"")
li_QueueDefinitionId = loo_JResp.IntOf("QueueDefinitionId")
ls_OutputData = loo_JResp.StringOf("OutputData")
ls_Status = loo_JResp.StringOf("Status")
ls_ReviewStatus = loo_JResp.StringOf("ReviewStatus")
ls_ReviewerUserId = loo_JResp.StringOf("ReviewerUserId")
ls_Key = loo_JResp.StringOf("Key")
ls_Reference = loo_JResp.StringOf("Reference")
ls_ProcessingExceptionType = loo_JResp.StringOf("ProcessingExceptionType")
ls_DueDate = loo_JResp.StringOf("DueDate")
ls_Priority = loo_JResp.StringOf("Priority")
ls_DeferDate = loo_JResp.StringOf("DeferDate")
ls_StartProcessing = loo_JResp.StringOf("StartProcessing")
ls_EndProcessing = loo_JResp.StringOf("EndProcessing")
li_SecondsInPreviousAttempts = loo_JResp.IntOf("SecondsInPreviousAttempts")
ls_AncestorId = loo_JResp.StringOf("AncestorId")
li_RetryNumber = loo_JResp.IntOf("RetryNumber")
ls_SpecificData = loo_JResp.StringOf("SpecificData")
ls_CreationTime = loo_JResp.StringOf("CreationTime")
ls_Progress = loo_JResp.StringOf("Progress")
ls_RowVersion = loo_JResp.StringOf("RowVersion")
li_Id = loo_JResp.IntOf("Id")
ls_ProcessingException = loo_JResp.StringOf("ProcessingException")
ls_V_Type = loo_JResp.StringOf("SpecificContent.Type")
ls_Name = loo_JResp.StringOf("SpecificContent.Name")
ls_Output = loo_JResp.StringOf("Output")
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
