Chilkat Tools

Ruby / Orchestrator API Documentation / Get Releases by Name

require 'chilkat'

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

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("$filter","ProcessKey eq 'PetStore_UpdatePet'")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("X-UIPATH-OrganizationUnitId","{{folderId}}")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/odata/Releases",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

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

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

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

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)
    Key = jResp.stringOf("value[i].Key")
    ProcessKey = jResp.stringOf("value[i].ProcessKey")
    ProcessVersion = jResp.stringOf("value[i].ProcessVersion")
    IsLatestVersion = jResp.BoolOf("value[i].IsLatestVersion")
    IsProcessDeleted = jResp.BoolOf("value[i].IsProcessDeleted")
    Description = jResp.stringOf("value[i].Description")
    Name = jResp.stringOf("value[i].Name")
    EnvironmentId = jResp.stringOf("value[i].EnvironmentId")
    EnvironmentName = jResp.stringOf("value[i].EnvironmentName")
    EntryPointId = jResp.stringOf("value[i].EntryPointId")
    InputArguments = jResp.stringOf("value[i].InputArguments")
    ProcessType = jResp.stringOf("value[i].ProcessType")
    SupportsMultipleEntryPoints = jResp.BoolOf("value[i].SupportsMultipleEntryPoints")
    RequiresUserInteraction = jResp.BoolOf("value[i].RequiresUserInteraction")
    AutoUpdate = jResp.BoolOf("value[i].AutoUpdate")
    FeedId = jResp.stringOf("value[i].FeedId")
    JobPriority = jResp.stringOf("value[i].JobPriority")
    CreationTime = jResp.stringOf("value[i].CreationTime")
    OrganizationUnitId = jResp.IntOf("value[i].OrganizationUnitId")
    OrganizationUnitFullyQualifiedName = jResp.stringOf("value[i].OrganizationUnitFullyQualifiedName")
    Id = jResp.IntOf("value[i].Id")
    Input = jResp.stringOf("value[i].Arguments.Input")
    Output = jResp.stringOf("value[i].Arguments.Output")
    ProcessSettings = jResp.stringOf("value[i].ProcessSettings")
    i = i + 1
end

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}"
    }
  ]
}

Chilkat Online Tools

Ruby / Orchestrator API Documentation / Get Releases by Name

Curl Command

Postman Collection Item JSON