Chilkat Online Tools

C++ / Orchestrator / 2. Releases - Get by name

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http;
    bool success;

    CkJsonObject queryParams;
    queryParams.UpdateString("$filter","ProcessKey eq 'Hello'");

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

    CkHttpResponse *resp = http.QuickRequestParams("GET","https://domain.com/odata/Releases",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

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

    // {
    //   "@odata.context": "https://platform.uipath.com/odata/$metadata#Releases",
    //   "@odata.count": 1,
    //   "value": [
    //     {
    //       "Key": "0764f4a-2ce0-41b9-r738-4575566f3756",
    //       "ProcessKey": "Hello",
    //       "ProcessVersion": "1.0.6913.24377",
    //       "IsLatestVersion": false,
    //       "IsProcessDeleted": false,
    //       "Description": null,
    //       "Name": "Hello_playground",
    //       "EnvironmentId": 3210,
    //       "EnvironmentName": "playground",
    //       "InputArguments": "{}",
    //       "QueueDefinitionId": null,
    //       "QueueDefinitionName": null,
    //       "Id": 12345,
    //       "Arguments": {
    //         "Input": "[{\"name\":\"greeting\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"url\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"username\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"password\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
    //         "Output": "[{\"name\":\"greeting\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false}]"
    //       },
    //       "ProcessSettings": null
    //     }
    //   ]
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *Key = 0;
    const char *ProcessKey = 0;
    const char *ProcessVersion = 0;
    bool IsLatestVersion;
    bool IsProcessDeleted;
    const char *Description = 0;
    const char *Name = 0;
    int EnvironmentId;
    const char *EnvironmentName = 0;
    const char *InputArguments = 0;
    const char *QueueDefinitionId = 0;
    const char *QueueDefinitionName = 0;
    int Id;
    const char *Input = 0;
    const char *Output = 0;
    const char *ProcessSettings = 0;

    const char *odata_context = jResp.stringOf("\"@odata.context\"");
    int odata_count = jResp.IntOf("\"@odata.count\"");
    int i = 0;
    int 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.IntOf("value[i].EnvironmentId");
        EnvironmentName = jResp.stringOf("value[i].EnvironmentName");
        InputArguments = jResp.stringOf("value[i].InputArguments");
        QueueDefinitionId = jResp.stringOf("value[i].QueueDefinitionId");
        QueueDefinitionName = jResp.stringOf("value[i].QueueDefinitionName");
        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;
    }
    }

Curl Command

curl -G -d "$filter=ProcessKey%20eq%20%27Hello%27"
	-H "Authorization: Bearer <access_token>"
	-H "X-UIPATH-TenantName: {{tenantName}}"
	-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/odata/Releases

Postman Collection Item JSON

{
  "name": "2. Releases - Get by name",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "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=ProcessKey eq 'Hello'",
      "host": [
        "{{url}}"
      ],
      "path": [
        "odata",
        "Releases"
      ],
      "query": [
        {
          "key": "$filter",
          "value": "ProcessKey eq 'Hello'"
        }
      ]
    },
    "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 word `Hello` with the name of your process and this call will return the `ReleaseKey` that will identify your process in step 4."
  },
  "response": [
    {
      "name": "2. Get the Process",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{url}}/odata/Releases?$filter=ProcessKey eq 'Hello'",
          "host": [
            "{{url}}"
          ],
          "path": [
            "odata",
            "Releases"
          ],
          "query": [
            {
              "key": "$filter",
              "value": "ProcessKey eq 'Hello'"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 03 Jul 2019 23:08:51 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; odata.metadata=minimal"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "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": "api-supported-versions",
          "value": "8.0"
        },
        {
          "key": "OData-Version",
          "value": "4.0"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Frame-Options",
          "value": "DENY"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains"
        },
        {
          "key": "Set-Cookie",
          "value": "; SameSite=lax"
        },
        {
          "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": "4f0c85eb7e8c3892-ATL"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://platform.uipath.com/odata/$metadata#Releases\",\n    \"@odata.count\": 1,\n    \"value\": [\n        {\n            \"Key\": \"0764f4a-2ce0-41b9-r738-4575566f3756\",\n            \"ProcessKey\": \"Hello\",\n            \"ProcessVersion\": \"1.0.6913.24377\",\n            \"IsLatestVersion\": false,\n            \"IsProcessDeleted\": false,\n            \"Description\": null,\n            \"Name\": \"Hello_playground\",\n            \"EnvironmentId\": 3210,\n            \"EnvironmentName\": \"playground\",\n            \"InputArguments\": \"{}\",\n            \"QueueDefinitionId\": null,\n            \"QueueDefinitionName\": null,\n            \"Id\": 12345,\n            \"Arguments\": {\n                \"Input\": \"[{\\\"name\\\":\\\"greeting\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":false},{\\\"name\\\":\\\"url\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":false},{\\\"name\\\":\\\"username\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":true},{\\\"name\\\":\\\"password\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":true}]\",\n                \"Output\": \"[{\\\"name\\\":\\\"greeting\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":false}]\"\n            },\n            \"ProcessSettings\": null\n        }\n    ]\n}"
    }
  ]
}