Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcKey
LOCAL lcDisplayName
LOCAL lcFullyQualifiedName
LOCAL lcFullyQualifiedNameOrderable
LOCAL lcDescription
LOCAL lcProvisionType
LOCAL lcPermissionModel
LOCAL lcParentId
LOCAL lcParentKey
LOCAL lnIsActive
LOCAL lcFeedType
LOCAL lnId
LOCAL lcOdata_context
LOCAL lnOdata_count
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateString("$Filter","DisplayName eq 'UnattendedProcesses'")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://domain.com/orchestrator_/odata/folders",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "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
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "@odata.context": "https://cloud.uipath.com/robertorg/modernDepartment/orchestrator_/odata/$metadata#Folders",
* "@odata.count": 1,
* "value": [
* {
* "Key": "0d521387-6fb2-4055-a22c-62b7225565b4",
* "DisplayName": "UnattendedProcesses",
* "FullyQualifiedName": "UnattendedProcesses",
* "FullyQualifiedNameOrderable": "UnattendedProcesses",
* "Description": null,
* "ProvisionType": "Automatic",
* "PermissionModel": "FineGrained",
* "ParentId": null,
* "ParentKey": null,
* "IsActive": true,
* "FeedType": "Processes",
* "Id": 515128
* }
* ]
* }
* 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")
lcDisplayName = loJResp.StringOf("value[i].DisplayName")
lcFullyQualifiedName = loJResp.StringOf("value[i].FullyQualifiedName")
lcFullyQualifiedNameOrderable = loJResp.StringOf("value[i].FullyQualifiedNameOrderable")
lcDescription = loJResp.StringOf("value[i].Description")
lcProvisionType = loJResp.StringOf("value[i].ProvisionType")
lcPermissionModel = loJResp.StringOf("value[i].PermissionModel")
lcParentId = loJResp.StringOf("value[i].ParentId")
lcParentKey = loJResp.StringOf("value[i].ParentKey")
lnIsActive = loJResp.BoolOf("value[i].IsActive")
lcFeedType = loJResp.StringOf("value[i].FeedType")
lnId = loJResp.IntOf("value[i].Id")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -G -d "$Filter=DisplayName%20eq%20%27UnattendedProcesses%27"
-H "Authorization: Bearer <access_token>"
https://domain.com/orchestrator_/odata/folders
Postman Collection Item JSON
{
"name": "GET Folders",
"event": [
{
"listen": "test",
"script": {
"exec": [
"//set folder ID\r",
"var myResponse = pm.response.json();\r",
"pm.collectionVariables.set(\"folderId\", myResponse.value[0].Id);\r",
"console.log(pm.collectionVariables.get(\"folderId\"));\r",
"\r",
"//test status code\r",
"pm.test(\"Status code is 200\", function () {\r",
" pm.response.to.have.status(200);\r",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{url}}/orchestrator_/odata/folders?$Filter=DisplayName eq 'UnattendedProcesses'",
"host": [
"{{url}}"
],
"path": [
"orchestrator_",
"odata",
"folders"
],
"query": [
{
"key": "$Filter",
"value": "DisplayName eq 'UnattendedProcesses'"
}
]
}
},
"response": [
{
"name": "Test",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{url}}/orchestrator_/odata/folders?$Filter=DisplayName eq 'UnattendedProcesses'",
"host": [
"{{url}}"
],
"path": [
"orchestrator_",
"odata",
"folders"
],
"query": [
{
"key": "$Filter",
"value": "DisplayName eq 'UnattendedProcesses'"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 29 Apr 2021 07:07:26 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": "b3389aa9-ce79-4516-8a18-88aaa1d750f2"
},
{
"key": "OData-Version",
"value": "4.0"
},
{
"key": "api-supported-versions",
"value": "12.0"
},
{
"key": "CF-Cache-Status",
"value": "DYNAMIC"
},
{
"key": "cf-request-id",
"value": "09be0d432000000d6ba1821000000001"
},
{
"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": "6476b17e9f840d6b-VIE"
},
{
"key": "Content-Encoding",
"value": "br"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://cloud.uipath.com/robertorg/modernDepartment/orchestrator_/odata/$metadata#Folders\",\n \"@odata.count\": 1,\n \"value\": [\n {\n \"Key\": \"0d521387-6fb2-4055-a22c-62b7225565b4\",\n \"DisplayName\": \"UnattendedProcesses\",\n \"FullyQualifiedName\": \"UnattendedProcesses\",\n \"FullyQualifiedNameOrderable\": \"UnattendedProcesses\",\n \"Description\": null,\n \"ProvisionType\": \"Automatic\",\n \"PermissionModel\": \"FineGrained\",\n \"ParentId\": null,\n \"ParentKey\": null,\n \"IsActive\": true,\n \"FeedType\": \"Processes\",\n \"Id\": 515128\n }\n ]\n}"
}
]
}
