Chilkat Online Tools

C / Orchestrator API Documentation / Get Releases by Name

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject queryParams;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *Key;
    const char *ProcessKey;
    const char *ProcessVersion;
    BOOL IsLatestVersion;
    BOOL IsProcessDeleted;
    const char *Description;
    const char *Name;
    const char *EnvironmentId;
    const char *EnvironmentName;
    const char *EntryPointId;
    const char *InputArguments;
    const char *ProcessType;
    BOOL SupportsMultipleEntryPoints;
    BOOL RequiresUserInteraction;
    BOOL AutoUpdate;
    const char *FeedId;
    const char *JobPriority;
    const char *CreationTime;
    int OrganizationUnitId;
    const char *OrganizationUnitFullyQualifiedName;
    int Id;
    const char *Input;
    const char *Output;
    const char *ProcessSettings;
    const char *odata_context;
    int odata_count;
    int i;
    int count_i;

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

    http = CkHttp_Create();

    queryParams = CkJsonObject_Create();
    CkJsonObject_UpdateString(queryParams,"$filter","Name eq 'Add a pet to pet store by queue item'");

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

    resp = CkHttp_QuickRequestParams(http,"GET","https://domain.com/odata/Releases",queryParams);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(resp);

    // 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": "6f459380-1b98-4f33-9682-6f8a7457490f",
    //       "ProcessKey": "PetStore_AddPet_byQueueItem",
    //       "ProcessVersion": "1.0.13",
    //       "IsLatestVersion": false,
    //       "IsProcessDeleted": false,
    //       "Description": "Gets a queue item and adds a pet with item name",
    //       "Name": "Add a pet to pet store by queue item",
    //       "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-16T09:04:00.607Z",
    //       "OrganizationUnitId": 515128,
    //       "OrganizationUnitFullyQualifiedName": "UnattendedProcesses",
    //       "Id": 31025,
    //       "Arguments": {
    //         "Input": null,
    //         "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

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

    odata_context = CkJsonObject_stringOf(jResp,"\"@odata.context\"");
    odata_count = CkJsonObject_IntOf(jResp,"\"@odata.count\"");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"value");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        Key = CkJsonObject_stringOf(jResp,"value[i].Key");
        ProcessKey = CkJsonObject_stringOf(jResp,"value[i].ProcessKey");
        ProcessVersion = CkJsonObject_stringOf(jResp,"value[i].ProcessVersion");
        IsLatestVersion = CkJsonObject_BoolOf(jResp,"value[i].IsLatestVersion");
        IsProcessDeleted = CkJsonObject_BoolOf(jResp,"value[i].IsProcessDeleted");
        Description = CkJsonObject_stringOf(jResp,"value[i].Description");
        Name = CkJsonObject_stringOf(jResp,"value[i].Name");
        EnvironmentId = CkJsonObject_stringOf(jResp,"value[i].EnvironmentId");
        EnvironmentName = CkJsonObject_stringOf(jResp,"value[i].EnvironmentName");
        EntryPointId = CkJsonObject_stringOf(jResp,"value[i].EntryPointId");
        InputArguments = CkJsonObject_stringOf(jResp,"value[i].InputArguments");
        ProcessType = CkJsonObject_stringOf(jResp,"value[i].ProcessType");
        SupportsMultipleEntryPoints = CkJsonObject_BoolOf(jResp,"value[i].SupportsMultipleEntryPoints");
        RequiresUserInteraction = CkJsonObject_BoolOf(jResp,"value[i].RequiresUserInteraction");
        AutoUpdate = CkJsonObject_BoolOf(jResp,"value[i].AutoUpdate");
        FeedId = CkJsonObject_stringOf(jResp,"value[i].FeedId");
        JobPriority = CkJsonObject_stringOf(jResp,"value[i].JobPriority");
        CreationTime = CkJsonObject_stringOf(jResp,"value[i].CreationTime");
        OrganizationUnitId = CkJsonObject_IntOf(jResp,"value[i].OrganizationUnitId");
        OrganizationUnitFullyQualifiedName = CkJsonObject_stringOf(jResp,"value[i].OrganizationUnitFullyQualifiedName");
        Id = CkJsonObject_IntOf(jResp,"value[i].Id");
        Input = CkJsonObject_stringOf(jResp,"value[i].Arguments.Input");
        Output = CkJsonObject_stringOf(jResp,"value[i].Arguments.Output");
        ProcessSettings = CkJsonObject_stringOf(jResp,"value[i].ProcessSettings");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkJsonObject_Dispose(queryParams);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

Curl Command

curl -G -d "$filter=Name%20eq%20%27Add%20a%20pet%20to%20pet%20store%20by%20queue%20item%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"
      }
    ],
    "url": {
      "raw": "{{url}}/odata/Releases?$filter=Name eq 'Add a pet to pet store by queue item'",
      "host": [
        "{{url}}"
      ],
      "path": [
        "odata",
        "Releases"
      ],
      "query": [
        {
          "key": "$filter",
          "value": "Name eq 'Add a pet to pet store by queue item'"
        }
      ]
    },
    "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 string in the filter parameter with the name of your process and this call will return the `ReleaseKey` that you will need in step 3 to start the process."
  },
  "response": [
    {
      "name": "Get Releases by Name Copy",
      "originalRequest": {
        "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=Name eq 'Add a pet to pet store by queue item'",
          "host": [
            "{{url}}"
          ],
          "path": [
            "odata",
            "Releases"
          ],
          "query": [
            {
              "key": "$filter",
              "value": "Name eq 'Add a pet to pet store by queue item'"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 31 Mar 2021 12:54:04 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": "d38b319c-dac3-46d0-bf60-a4b3b18902f1"
        },
        {
          "key": "OData-Version",
          "value": "4.0"
        },
        {
          "key": "api-supported-versions",
          "value": "12.0"
        },
        {
          "key": "CF-Cache-Status",
          "value": "DYNAMIC"
        },
        {
          "key": "cf-request-id",
          "value": "0929f232600000cba0252ce000000001"
        },
        {
          "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": "6389b963ce2fcba0-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\": \"6f459380-1b98-4f33-9682-6f8a7457490f\",\n            \"ProcessKey\": \"PetStore_AddPet_byQueueItem\",\n            \"ProcessVersion\": \"1.0.13\",\n            \"IsLatestVersion\": false,\n            \"IsProcessDeleted\": false,\n            \"Description\": \"Gets a queue item and adds a pet with item name\",\n            \"Name\": \"Add a pet to pet store by queue item\",\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-16T09:04:00.607Z\",\n            \"OrganizationUnitId\": 515128,\n            \"OrganizationUnitFullyQualifiedName\": \"UnattendedProcesses\",\n            \"Id\": 31025,\n            \"Arguments\": {\n                \"Input\": null,\n                \"Output\": null\n            },\n            \"ProcessSettings\": null\n        }\n    ]\n}"
    }
  ]
}