Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "$filter" "Name eq 'Add a pet to pet store by queue item'"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "X-UIPATH-OrganizationUnitId" "{{folderId}}"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://domain.com/odata/Releases" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $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
set odata_context [CkJsonObject_stringOf $jResp "\"@odata.context\""]
set odata_count [CkJsonObject_IntOf $jResp "\"@odata.count\""]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "value"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set Key [CkJsonObject_stringOf $jResp "value[i].Key"]
set ProcessKey [CkJsonObject_stringOf $jResp "value[i].ProcessKey"]
set ProcessVersion [CkJsonObject_stringOf $jResp "value[i].ProcessVersion"]
set IsLatestVersion [CkJsonObject_BoolOf $jResp "value[i].IsLatestVersion"]
set IsProcessDeleted [CkJsonObject_BoolOf $jResp "value[i].IsProcessDeleted"]
set Description [CkJsonObject_stringOf $jResp "value[i].Description"]
set Name [CkJsonObject_stringOf $jResp "value[i].Name"]
set EnvironmentId [CkJsonObject_stringOf $jResp "value[i].EnvironmentId"]
set EnvironmentName [CkJsonObject_stringOf $jResp "value[i].EnvironmentName"]
set EntryPointId [CkJsonObject_stringOf $jResp "value[i].EntryPointId"]
set InputArguments [CkJsonObject_stringOf $jResp "value[i].InputArguments"]
set ProcessType [CkJsonObject_stringOf $jResp "value[i].ProcessType"]
set SupportsMultipleEntryPoints [CkJsonObject_BoolOf $jResp "value[i].SupportsMultipleEntryPoints"]
set RequiresUserInteraction [CkJsonObject_BoolOf $jResp "value[i].RequiresUserInteraction"]
set AutoUpdate [CkJsonObject_BoolOf $jResp "value[i].AutoUpdate"]
set FeedId [CkJsonObject_stringOf $jResp "value[i].FeedId"]
set JobPriority [CkJsonObject_stringOf $jResp "value[i].JobPriority"]
set CreationTime [CkJsonObject_stringOf $jResp "value[i].CreationTime"]
set OrganizationUnitId [CkJsonObject_IntOf $jResp "value[i].OrganizationUnitId"]
set OrganizationUnitFullyQualifiedName [CkJsonObject_stringOf $jResp "value[i].OrganizationUnitFullyQualifiedName"]
set Id [CkJsonObject_IntOf $jResp "value[i].Id"]
set Input [CkJsonObject_stringOf $jResp "value[i].Arguments.Input"]
set Output [CkJsonObject_stringOf $jResp "value[i].Arguments.Output"]
set ProcessSettings [CkJsonObject_stringOf $jResp "value[i].ProcessSettings"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $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}"
}
]
}
