Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sKey
String sProcessKey
String sProcessVersion
Boolean iIsLatestVersion
Boolean iIsProcessDeleted
String sDescription
String sName
String sEnvironmentId
String sEnvironmentName
String sEntryPointId
String sInputArguments
String sProcessType
Boolean iSupportsMultipleEntryPoints
Boolean iRequiresUserInteraction
Boolean iAutoUpdate
String sFeedId
String sJobPriority
String sCreationTime
Integer iOrganizationUnitId
String sOrganizationUnitFullyQualifiedName
Integer iId
String sInput
String sOutput
String sProcessSettings
String sOdata_context
Integer iOdata_count
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "$Filter" "ProcessKey eq 'PetStore_AddPet_byQueueItem'" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "X-UIPATH-OrganizationUnitId" "{{folderId}}"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://domain.com/orchestrator_/odata/Releases" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp '"@odata.context"' To sOdata_context
Get ComIntOf Of hoJResp '"@odata.count"' To iOdata_count
Move 0 To i
Get ComSizeOfArray Of hoJResp "value" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "value[i].Key" To sKey
Get ComStringOf Of hoJResp "value[i].ProcessKey" To sProcessKey
Get ComStringOf Of hoJResp "value[i].ProcessVersion" To sProcessVersion
Get ComBoolOf Of hoJResp "value[i].IsLatestVersion" To iIsLatestVersion
Get ComBoolOf Of hoJResp "value[i].IsProcessDeleted" To iIsProcessDeleted
Get ComStringOf Of hoJResp "value[i].Description" To sDescription
Get ComStringOf Of hoJResp "value[i].Name" To sName
Get ComStringOf Of hoJResp "value[i].EnvironmentId" To sEnvironmentId
Get ComStringOf Of hoJResp "value[i].EnvironmentName" To sEnvironmentName
Get ComStringOf Of hoJResp "value[i].EntryPointId" To sEntryPointId
Get ComStringOf Of hoJResp "value[i].InputArguments" To sInputArguments
Get ComStringOf Of hoJResp "value[i].ProcessType" To sProcessType
Get ComBoolOf Of hoJResp "value[i].SupportsMultipleEntryPoints" To iSupportsMultipleEntryPoints
Get ComBoolOf Of hoJResp "value[i].RequiresUserInteraction" To iRequiresUserInteraction
Get ComBoolOf Of hoJResp "value[i].AutoUpdate" To iAutoUpdate
Get ComStringOf Of hoJResp "value[i].FeedId" To sFeedId
Get ComStringOf Of hoJResp "value[i].JobPriority" To sJobPriority
Get ComStringOf Of hoJResp "value[i].CreationTime" To sCreationTime
Get ComIntOf Of hoJResp "value[i].OrganizationUnitId" To iOrganizationUnitId
Get ComStringOf Of hoJResp "value[i].OrganizationUnitFullyQualifiedName" To sOrganizationUnitFullyQualifiedName
Get ComIntOf Of hoJResp "value[i].Id" To iId
Get ComStringOf Of hoJResp "value[i].Arguments.Input" To sInput
Get ComStringOf Of hoJResp "value[i].Arguments.Output" To sOutput
Get ComStringOf Of hoJResp "value[i].ProcessSettings" To sProcessSettings
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -G -d "$Filter=ProcessKey%20eq%20%27PetStore_AddPet_byQueueItem%27"
-H "Authorization: Bearer <access_token>"
-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/orchestrator_/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}}/orchestrator_/odata/Releases?$Filter=ProcessKey eq 'PetStore_AddPet_byQueueItem'",
"host": [
"{{url}}"
],
"path": [
"orchestrator_",
"odata",
"Releases"
],
"query": [
{
"key": "$Filter",
"value": "ProcessKey eq 'PetStore_AddPet_byQueueItem'"
}
]
},
"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}"
}
]
}
