Chilkat Online Tools

Ruby / Orchestrator / Processes - Get all

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

http.SetRequestHeader("Content-Type","application/json")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("X-UIPATH-OrganizationUnitId","{{folderId}}")
http.SetRequestHeader("X-UIPATH-TenantName","{{tenantName}}")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/odata/Processes",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "@odata.context": "https://platform.uipath.com/odata/$metadata#Processes",
#   "@odata.count": 2,
#   "value": [
#     {
#       "Title": null,
#       "Version": "1.0.6694.28691",
#       "Key": "Process1:1.0.6694.28691",
#       "Description": "Test Process 1",
#       "Published": "2018-04-30T19:56:28.8615393Z",
#       "IsLatestVersion": true,
#       "OldVersion": null,
#       "IsActive": false,
#       "Id": "Process1"
#     },
#     {
#       "Title": null,
#       "Version": "1.0.6737.25496",
#       "Key": "Process2:1.0.6737.25496",
#       "Description": "Test Process 2",
#       "Published": "2018-06-12T18:09:55.6098159Z",
#       "IsLatestVersion": true,
#       "OldVersion": null,
#       "IsActive": false,
#       "Id": "Process2"
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

odata_context = jResp.stringOf("\"@odata.context\"")
odata_count = jResp.IntOf("\"@odata.count\"")
i = 0
count_i = jResp.SizeOfArray("value")
while i < count_i
    jResp.put_I(i)
    Title = jResp.stringOf("value[i].Title")
    Version = jResp.stringOf("value[i].Version")
    Key = jResp.stringOf("value[i].Key")
    Description = jResp.stringOf("value[i].Description")
    Published = jResp.stringOf("value[i].Published")
    IsLatestVersion = jResp.BoolOf("value[i].IsLatestVersion")
    OldVersion = jResp.stringOf("value[i].OldVersion")
    IsActive = jResp.BoolOf("value[i].IsActive")
    Id = jResp.stringOf("value[i].Id")
    i = i + 1
end

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "X-UIPATH-TenantName: {{tenantName}}"
	-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/odata/Processes

Postman Collection Item JSON

{
  "name": "Processes - Get all",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      },
      {
        "key": "X-UIPATH-TenantName",
        "value": "{{tenantName}}",
        "type": "text"
      },
      {
        "key": "X-UIPATH-OrganizationUnitId",
        "value": "{{folderId}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{url}}/odata/Processes",
      "host": [
        "{{url}}"
      ],
      "path": [
        "odata",
        "Processes"
      ]
    }
  },
  "response": [
    {
      "name": "Processes - Get all",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{url}}/odata/Processes",
          "host": [
            "{{url}}"
          ],
          "path": [
            "odata",
            "Processes"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 31 Jan 2019 17:49:33 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; odata.metadata=minimal"
        },
        {
          "key": "Content-Length",
          "value": "201"
        },
        {
          "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": "Set-Cookie",
          "value": "; SameSite=lax"
        },
        {
          "key": "api-supported-versions",
          "value": "7.0"
        },
        {
          "key": "OData-Version",
          "value": "4.0"
        },
        {
          "key": "Request-Context",
          "value": "appId=cid-v1:d00ce63d-0891-41e4-a17c-25b2c5382e49"
        },
        {
          "key": "Access-Control-Expose-Headers",
          "value": "Request-Context"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Frame-Options",
          "value": "DENY"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains"
        },
        {
          "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": "4a1e03f878a92462-IAD"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://platform.uipath.com/odata/$metadata#Processes\",\n    \"@odata.count\": 2,\n    \"value\": [\n        {\n            \"Title\": null,\n            \"Version\": \"1.0.6694.28691\",\n            \"Key\": \"Process1:1.0.6694.28691\",\n            \"Description\": \"Test Process 1\",\n            \"Published\": \"2018-04-30T19:56:28.8615393Z\",\n            \"IsLatestVersion\": true,\n            \"OldVersion\": null,\n            \"IsActive\": false,\n            \"Id\": \"Process1\"\n        },\n        {\n            \"Title\": null,\n            \"Version\": \"1.0.6737.25496\",\n            \"Key\": \"Process2:1.0.6737.25496\",\n            \"Description\": \"Test Process 2\",\n            \"Published\": \"2018-06-12T18:09:55.6098159Z\",\n            \"IsLatestVersion\": true,\n            \"OldVersion\": null,\n            \"IsActive\": false,\n            \"Id\": \"Process2\"\n        }\n    ]\n}"
    }
  ]
}