Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Key
string ls_ProcessKey
string ls_ProcessVersion
integer li_IsLatestVersion
integer li_IsProcessDeleted
string ls_Description
string ls_Name
string ls_EnvironmentId
string ls_EnvironmentName
string ls_EntryPointId
string ls_InputArguments
string ls_ProcessType
integer li_SupportsMultipleEntryPoints
integer li_RequiresUserInteraction
integer li_AutoUpdate
string ls_FeedId
string ls_JobPriority
string ls_CreationTime
integer li_OrganizationUnitId
string ls_OrganizationUnitFullyQualifiedName
integer li_Id
string ls_Input
string ls_Output
string ls_ProcessSettings
string ls_Odata_context
integer li_Odata_count
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("$filter","Name eq 'Add a pet to pet store by queue item'")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("X-UIPATH-OrganizationUnitId","{{folderId}}")
loo_Resp = loo_Http.QuickRequestParams("GET","https://domain.com/odata/Releases",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.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_QueryParams
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://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Releases",
// "@odata.count": 1,
// "value": [
// {
// "Key": "6f459380-1b98-4f33-9682-6f8a7457490f",
// "ProcessKey": "PetStore_AddPet_byQueueItem",
// "ProcessVersion": "1.0.13",
// "IsLatestVersion": false,
// "IsProcessDeleted": false,
// "Description": "Gets a queue item and adds a pet with item name",
// "Name": "Add a pet to pet store by queue item",
// "EnvironmentId": null,
// "EnvironmentName": "",
// "EntryPointId": null,
// "InputArguments": null,
// "ProcessType": "Process",
// "SupportsMultipleEntryPoints": true,
// "RequiresUserInteraction": true,
// "AutoUpdate": false,
// "FeedId": "ef94e92f-5f58-474b-963c-c3ef46391ca7",
// "JobPriority": "Normal",
// "CreationTime": "2021-03-16T09:04:00.607Z",
// "OrganizationUnitId": 515128,
// "OrganizationUnitFullyQualifiedName": "UnattendedProcesses",
// "Id": 31025,
// "Arguments": {
// "Input": null,
// "Output": null
// },
// "ProcessSettings": 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_Odata_count = loo_JResp.IntOf("~"@odata.count~"")
i = 0
li_Count_i = loo_JResp.SizeOfArray("value")
do while i < li_Count_i
loo_JResp.I = i
ls_Key = loo_JResp.StringOf("value[i].Key")
ls_ProcessKey = loo_JResp.StringOf("value[i].ProcessKey")
ls_ProcessVersion = loo_JResp.StringOf("value[i].ProcessVersion")
li_IsLatestVersion = loo_JResp.BoolOf("value[i].IsLatestVersion")
li_IsProcessDeleted = loo_JResp.BoolOf("value[i].IsProcessDeleted")
ls_Description = loo_JResp.StringOf("value[i].Description")
ls_Name = loo_JResp.StringOf("value[i].Name")
ls_EnvironmentId = loo_JResp.StringOf("value[i].EnvironmentId")
ls_EnvironmentName = loo_JResp.StringOf("value[i].EnvironmentName")
ls_EntryPointId = loo_JResp.StringOf("value[i].EntryPointId")
ls_InputArguments = loo_JResp.StringOf("value[i].InputArguments")
ls_ProcessType = loo_JResp.StringOf("value[i].ProcessType")
li_SupportsMultipleEntryPoints = loo_JResp.BoolOf("value[i].SupportsMultipleEntryPoints")
li_RequiresUserInteraction = loo_JResp.BoolOf("value[i].RequiresUserInteraction")
li_AutoUpdate = loo_JResp.BoolOf("value[i].AutoUpdate")
ls_FeedId = loo_JResp.StringOf("value[i].FeedId")
ls_JobPriority = loo_JResp.StringOf("value[i].JobPriority")
ls_CreationTime = loo_JResp.StringOf("value[i].CreationTime")
li_OrganizationUnitId = loo_JResp.IntOf("value[i].OrganizationUnitId")
ls_OrganizationUnitFullyQualifiedName = loo_JResp.StringOf("value[i].OrganizationUnitFullyQualifiedName")
li_Id = loo_JResp.IntOf("value[i].Id")
ls_Input = loo_JResp.StringOf("value[i].Arguments.Input")
ls_Output = loo_JResp.StringOf("value[i].Arguments.Output")
ls_ProcessSettings = loo_JResp.StringOf("value[i].ProcessSettings")
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -G -d "$filter=Name%20eq%20%27Add%20a%20pet%20to%20pet%20store%20by%20queue%20item%27"
-H "Authorization: Bearer <access_token>"
-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/odata/Releases
Postman Collection Item JSON
{
"name": "Get Releases by Name",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 200\", function () {\r",
" pm.response.to.have.status(200);\r",
"});\r",
"\r",
"//set release key\r",
"var myResponse = pm.response.json();\r",
"pm.collectionVariables.set(\"releaseKey\", myResponse.value[0].Key);\r",
"console.log(pm.collectionVariables.get(\"releaseKey\"));"
],
"type": "text/javascript"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "X-UIPATH-OrganizationUnitId",
"value": "{{folderId}}",
"type": "text"
}
],
"url": {
"raw": "{{url}}/odata/Releases?$filter=Name eq 'Add a pet to pet store by queue item'",
"host": [
"{{url}}"
],
"path": [
"odata",
"Releases"
],
"query": [
{
"key": "$filter",
"value": "Name eq 'Add a pet to pet store by queue item'"
}
]
},
"description": "So you've created a **Process** in UiPath Studio and published it to Orchestrator. Here's where you specify that process, by name, in order to start it remotely.\n\nWithin the URL, simply replace the string in the filter parameter with the name of your process and this call will return the `ReleaseKey` that you will need in step 3 to start the process."
},
"response": [
{
"name": "Get Releases by Name Copy",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X-UIPATH-TenantName",
"value": "{{tenantName}}",
"type": "text"
},
{
"key": "X-UIPATH-OrganizationUnitId",
"value": "{{folderId}}",
"type": "text"
}
],
"url": {
"raw": "{{url}}/odata/Releases?$filter=Name eq 'Add a pet to pet store by queue item'",
"host": [
"{{url}}"
],
"path": [
"odata",
"Releases"
],
"query": [
{
"key": "$filter",
"value": "Name eq 'Add a pet to pet store by queue item'"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 31 Mar 2021 12:54:04 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": "d38b319c-dac3-46d0-bf60-a4b3b18902f1"
},
{
"key": "OData-Version",
"value": "4.0"
},
{
"key": "api-supported-versions",
"value": "12.0"
},
{
"key": "CF-Cache-Status",
"value": "DYNAMIC"
},
{
"key": "cf-request-id",
"value": "0929f232600000cba0252ce000000001"
},
{
"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": "6389b963ce2fcba0-VIE"
},
{
"key": "Content-Encoding",
"value": "br"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Releases\",\n \"@odata.count\": 1,\n \"value\": [\n {\n \"Key\": \"6f459380-1b98-4f33-9682-6f8a7457490f\",\n \"ProcessKey\": \"PetStore_AddPet_byQueueItem\",\n \"ProcessVersion\": \"1.0.13\",\n \"IsLatestVersion\": false,\n \"IsProcessDeleted\": false,\n \"Description\": \"Gets a queue item and adds a pet with item name\",\n \"Name\": \"Add a pet to pet store by queue item\",\n \"EnvironmentId\": null,\n \"EnvironmentName\": \"\",\n \"EntryPointId\": null,\n \"InputArguments\": null,\n \"ProcessType\": \"Process\",\n \"SupportsMultipleEntryPoints\": true,\n \"RequiresUserInteraction\": true,\n \"AutoUpdate\": false,\n \"FeedId\": \"ef94e92f-5f58-474b-963c-c3ef46391ca7\",\n \"JobPriority\": \"Normal\",\n \"CreationTime\": \"2021-03-16T09:04:00.607Z\",\n \"OrganizationUnitId\": 515128,\n \"OrganizationUnitFullyQualifiedName\": \"UnattendedProcesses\",\n \"Id\": 31025,\n \"Arguments\": {\n \"Input\": null,\n \"Output\": null\n },\n \"ProcessSettings\": null\n }\n ]\n}"
}
]
}
