autoit / Orchestrator / 2. Releases - Get by name
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat_9_5_0.JsonObject")
$oQueryParams.UpdateString("$filter","ProcessKey eq 'Hello'")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "X-UIPATH-OrganizationUnitId","{{folderId}}"
$oHttp.SetRequestHeader "X-UIPATH-TenantName","{{tenantName}}"
Local $oResp = $oHttp.QuickRequestParams("GET","https://domain.com/odata/Releases",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "@odata.context": "https://platform.uipath.com/odata/$metadata#Releases",
; "@odata.count": 1,
; "value": [
; {
; "Key": "0764f4a-2ce0-41b9-r738-4575566f3756",
; "ProcessKey": "Hello",
; "ProcessVersion": "1.0.6913.24377",
; "IsLatestVersion": false,
; "IsProcessDeleted": false,
; "Description": null,
; "Name": "Hello_playground",
; "EnvironmentId": 3210,
; "EnvironmentName": "playground",
; "InputArguments": "{}",
; "QueueDefinitionId": null,
; "QueueDefinitionName": null,
; "Id": 12345,
; "Arguments": {
; "Input": "[{\"name\":\"greeting\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"url\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"username\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"password\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
; "Output": "[{\"name\":\"greeting\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false}]"
; },
; "ProcessSettings": null
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sKey
Local $sProcessKey
Local $sProcessVersion
Local $bIsLatestVersion
Local $bIsProcessDeleted
Local $sDescription
Local $sName
Local $iEnvironmentId
Local $sEnvironmentName
Local $sInputArguments
Local $sQueueDefinitionId
Local $sQueueDefinitionName
Local $iId
Local $sInput
Local $sOutput
Local $sProcessSettings
Local $sOdata_context = $oJResp.StringOf("""@odata.context""")
Local $iOdata_count = $oJResp.IntOf("""@odata.count""")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("value")
While $i < $iCount_i
$oJResp.I = $i
$sKey = $oJResp.StringOf("value[i].Key")
$sProcessKey = $oJResp.StringOf("value[i].ProcessKey")
$sProcessVersion = $oJResp.StringOf("value[i].ProcessVersion")
$bIsLatestVersion = $oJResp.BoolOf("value[i].IsLatestVersion")
$bIsProcessDeleted = $oJResp.BoolOf("value[i].IsProcessDeleted")
$sDescription = $oJResp.StringOf("value[i].Description")
$sName = $oJResp.StringOf("value[i].Name")
$iEnvironmentId = $oJResp.IntOf("value[i].EnvironmentId")
$sEnvironmentName = $oJResp.StringOf("value[i].EnvironmentName")
$sInputArguments = $oJResp.StringOf("value[i].InputArguments")
$sQueueDefinitionId = $oJResp.StringOf("value[i].QueueDefinitionId")
$sQueueDefinitionName = $oJResp.StringOf("value[i].QueueDefinitionName")
$iId = $oJResp.IntOf("value[i].Id")
$sInput = $oJResp.StringOf("value[i].Arguments.Input")
$sOutput = $oJResp.StringOf("value[i].Arguments.Output")
$sProcessSettings = $oJResp.StringOf("value[i].ProcessSettings")
$i = $i + 1
Wend
Curl Command
curl -G -d "$filter=ProcessKey%20eq%20%27Hello%27"
-H "Authorization: Bearer <access_token>"
-H "X-UIPATH-TenantName: {{tenantName}}"
-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/odata/Releases
Postman Collection Item JSON
{
"name": "2. Releases - Get by name",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"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=ProcessKey eq 'Hello'",
"host": [
"{{url}}"
],
"path": [
"odata",
"Releases"
],
"query": [
{
"key": "$filter",
"value": "ProcessKey eq 'Hello'"
}
]
},
"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 word `Hello` with the name of your process and this call will return the `ReleaseKey` that will identify your process in step 4."
},
"response": [
{
"name": "2. Get the Process",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{url}}/odata/Releases?$filter=ProcessKey eq 'Hello'",
"host": [
"{{url}}"
],
"path": [
"odata",
"Releases"
],
"query": [
{
"key": "$filter",
"value": "ProcessKey eq 'Hello'"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 03 Jul 2019 23:08:51 GMT"
},
{
"key": "Content-Type",
"value": "application/json; odata.metadata=minimal"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Cache-Control",
"value": "no-store, must-revalidate, no-cache, max-age=0"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "api-supported-versions",
"value": "8.0"
},
{
"key": "OData-Version",
"value": "4.0"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains"
},
{
"key": "Set-Cookie",
"value": "; SameSite=lax"
},
{
"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": "4f0c85eb7e8c3892-ATL"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://platform.uipath.com/odata/$metadata#Releases\",\n \"@odata.count\": 1,\n \"value\": [\n {\n \"Key\": \"0764f4a-2ce0-41b9-r738-4575566f3756\",\n \"ProcessKey\": \"Hello\",\n \"ProcessVersion\": \"1.0.6913.24377\",\n \"IsLatestVersion\": false,\n \"IsProcessDeleted\": false,\n \"Description\": null,\n \"Name\": \"Hello_playground\",\n \"EnvironmentId\": 3210,\n \"EnvironmentName\": \"playground\",\n \"InputArguments\": \"{}\",\n \"QueueDefinitionId\": null,\n \"QueueDefinitionName\": null,\n \"Id\": 12345,\n \"Arguments\": {\n \"Input\": \"[{\\\"name\\\":\\\"greeting\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":false},{\\\"name\\\":\\\"url\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":false},{\\\"name\\\":\\\"username\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":true},{\\\"name\\\":\\\"password\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":true}]\",\n \"Output\": \"[{\\\"name\\\":\\\"greeting\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":false}]\"\n },\n \"ProcessSettings\": null\n }\n ]\n}"
}
]
}
