Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("$filter","ProcessKey eq 'PetStore_UpdatePet'")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("X-UIPATH-OrganizationUnitId","{{folderId}}")
loResp = loHttp.QuickRequestParams("GET","https://domain.com/odata/Releases",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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": "ecde643a-3ec1-4a5c-b4ea-381759ee620a",
// "ProcessKey": "PetStore_UpdatePet",
// "ProcessVersion": "1.0.11",
// "IsLatestVersion": false,
// "IsProcessDeleted": false,
// "Description": "Blank Process",
// "Name": "Update existsing pet by ID",
// "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-11T13:11:38.837Z",
// "OrganizationUnitId": 515128,
// "OrganizationUnitFullyQualifiedName": "UnattendedProcesses",
// "Id": 30155,
// "Arguments": {
// "Input": "[{\"name\":\"status\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
// "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
lcOdata_context = loJResp.StringOf('"@odata.context"')
lnOdata_count = loJResp.IntOf('"@odata.count"')
i = 0
lnCount_i = loJResp.SizeOfArray("value")
do while i < lnCount_i
loJResp.I = i
lcKey = loJResp.StringOf("value[i].Key")
lcProcessKey = loJResp.StringOf("value[i].ProcessKey")
lcProcessVersion = loJResp.StringOf("value[i].ProcessVersion")
llIsLatestVersion = loJResp.BoolOf("value[i].IsLatestVersion")
llIsProcessDeleted = loJResp.BoolOf("value[i].IsProcessDeleted")
lcDescription = loJResp.StringOf("value[i].Description")
lcName = loJResp.StringOf("value[i].Name")
lcEnvironmentId = loJResp.StringOf("value[i].EnvironmentId")
lcEnvironmentName = loJResp.StringOf("value[i].EnvironmentName")
lcEntryPointId = loJResp.StringOf("value[i].EntryPointId")
lcInputArguments = loJResp.StringOf("value[i].InputArguments")
lcProcessType = loJResp.StringOf("value[i].ProcessType")
llSupportsMultipleEntryPoints = loJResp.BoolOf("value[i].SupportsMultipleEntryPoints")
llRequiresUserInteraction = loJResp.BoolOf("value[i].RequiresUserInteraction")
llAutoUpdate = loJResp.BoolOf("value[i].AutoUpdate")
lcFeedId = loJResp.StringOf("value[i].FeedId")
lcJobPriority = loJResp.StringOf("value[i].JobPriority")
lcCreationTime = loJResp.StringOf("value[i].CreationTime")
lnOrganizationUnitId = loJResp.IntOf("value[i].OrganizationUnitId")
lcOrganizationUnitFullyQualifiedName = loJResp.StringOf("value[i].OrganizationUnitFullyQualifiedName")
lnId = loJResp.IntOf("value[i].Id")
lcInput = loJResp.StringOf("value[i].Arguments.Input")
lcOutput = loJResp.StringOf("value[i].Arguments.Output")
lcProcessSettings = loJResp.StringOf("value[i].ProcessSettings")
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
Curl Command
curl -G -d "$filter=ProcessKey%20eq%20%27PetStore_UpdatePet%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",
"disabled": true
}
],
"url": {
"raw": "{{url}}/odata/Releases?$filter=ProcessKey eq 'PetStore_UpdatePet'",
"host": [
"{{url}}"
],
"path": [
"odata",
"Releases"
],
"query": [
{
"key": "$filter",
"value": "ProcessKey eq 'PetStore_UpdatePet'"
}
]
},
"description": "The process arguments listed in the response property `Arguments` can be used to render a user interface. This allows to dyamically render a process user interface.\n\nIn this example we are using a simple `string`: status as process input argument. Simple input arguments are listed as key value pairs."
},
"response": [
{
"name": "Get Releases by Name",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X-UIPATH-OrganizationUnitId",
"value": "{{folderId}}",
"type": "text",
"disabled": true
}
],
"url": {
"raw": "{{url}}/odata/Releases?$filter=Name eq 'Update existsing pet by ID'",
"host": [
"{{url}}"
],
"path": [
"odata",
"Releases"
],
"query": [
{
"key": "$filter",
"value": "Name eq 'Update existsing pet by ID'"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Tue, 20 Apr 2021 09:04:25 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": "0ba95b3d-3dc2-4a8c-9160-a014ad0b48ac"
},
{
"key": "OData-Version",
"value": "4.0"
},
{
"key": "api-supported-versions",
"value": "12.0"
},
{
"key": "CF-Cache-Status",
"value": "DYNAMIC"
},
{
"key": "cf-request-id",
"value": "09901f22a800000fae6bb4e000000001"
},
{
"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": "642d347ddb3b0fae-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\": \"ecde643a-3ec1-4a5c-b4ea-381759ee620a\",\n \"ProcessKey\": \"PetStore_UpdatePet\",\n \"ProcessVersion\": \"1.0.11\",\n \"IsLatestVersion\": false,\n \"IsProcessDeleted\": false,\n \"Description\": \"Blank Process\",\n \"Name\": \"Update existsing pet by ID\",\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-11T13:11:38.837Z\",\n \"OrganizationUnitId\": 515128,\n \"OrganizationUnitFullyQualifiedName\": \"UnattendedProcesses\",\n \"Id\": 30155,\n \"Arguments\": {\n \"Input\": \"[{\\\"name\\\":\\\"status\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":true}]\",\n \"Output\": null\n },\n \"ProcessSettings\": null\n }\n ]\n}"
}
]
}
