Chilkat Online Tools

C / Orchestrator / Process Versions - Get single

Back to Collection Items

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

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    BOOL IsActive;
    const char *Title;
    const char *Version;
    const char *Key;
    const char *Description;
    const char *Published;
    BOOL IsLatestVersion;
    const char *OldVersion;
    const char *ReleaseNotes;
    const char *Authors;
    const char *Id;
    const char *Input;
    const char *Output;
    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();

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

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://domain.com/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='Heyyo')",sbResponseBody);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

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

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

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

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

    // {
    //   "@odata.context": "https://platform.uipath.com/odata/$metadata#Processes",
    //   "@odata.count": 1,
    //   "value": [
    //     {
    //       "IsActive": true,
    //       "Title": null,
    //       "Version": "1.0.6705.14383",
    //       "Key": "Heyyo:1.0.6705.14383",
    //       "Description": "Jobs for Orchestrator",
    //       "Published": "2019-01-31T17:54:39.9213054Z",
    //       "IsLatestVersion": true,
    //       "OldVersion": null,
    //       "ReleaseNotes": null,
    //       "Authors": "Dean",
    //       "Id": "Heyyo",
    //       "Arguments": {
    //         "Input": null,
    //         "Output": 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);
        IsActive = CkJsonObject_BoolOf(jResp,"value[i].IsActive");
        Title = CkJsonObject_stringOf(jResp,"value[i].Title");
        Version = CkJsonObject_stringOf(jResp,"value[i].Version");
        Key = CkJsonObject_stringOf(jResp,"value[i].Key");
        Description = CkJsonObject_stringOf(jResp,"value[i].Description");
        Published = CkJsonObject_stringOf(jResp,"value[i].Published");
        IsLatestVersion = CkJsonObject_BoolOf(jResp,"value[i].IsLatestVersion");
        OldVersion = CkJsonObject_stringOf(jResp,"value[i].OldVersion");
        ReleaseNotes = CkJsonObject_stringOf(jResp,"value[i].ReleaseNotes");
        Authors = CkJsonObject_stringOf(jResp,"value[i].Authors");
        Id = CkJsonObject_stringOf(jResp,"value[i].Id");
        Input = CkJsonObject_stringOf(jResp,"value[i].Arguments.Input");
        Output = CkJsonObject_stringOf(jResp,"value[i].Arguments.Output");
        i = i + 1;
    }



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

    }

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/UiPath.Server.Configuration.OData.GetProcessVersions(processId='Heyyo')

Postman Collection Item JSON

{
  "name": "Process Versions - Get single",
  "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/UiPath.Server.Configuration.OData.GetProcessVersions(processId='Heyyo')",
      "host": [
        "{{url}}"
      ],
      "path": [
        "odata",
        "Processes",
        "UiPath.Server.Configuration.OData.GetProcessVersions(processId='Heyyo')"
      ]
    }
  },
  "response": [
    {
      "name": "Process Versions - Get single",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{url}}/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='Heyyo')",
          "host": [
            "{{url}}"
          ],
          "path": [
            "odata",
            "Processes",
            "UiPath.Server.Configuration.OData.GetProcessVersions(processId='Heyyo')"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 31 Jan 2019 17:57:18 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; odata.metadata=minimal"
        },
        {
          "key": "Content-Length",
          "value": "401"
        },
        {
          "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": "4a1e0f552fcb2462-IAD"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://platform.uipath.com/odata/$metadata#Processes\",\n    \"@odata.count\": 1,\n    \"value\": [\n        {\n            \"IsActive\": true,\n            \"Title\": null,\n            \"Version\": \"1.0.6705.14383\",\n            \"Key\": \"Heyyo:1.0.6705.14383\",\n            \"Description\": \"Jobs for Orchestrator\",\n            \"Published\": \"2019-01-31T17:54:39.9213054Z\",\n            \"IsLatestVersion\": true,\n            \"OldVersion\": null,\n            \"ReleaseNotes\": null,\n            \"Authors\": \"Dean\",\n            \"Id\": \"Heyyo\",\n            \"Arguments\": {\n                \"Input\": null,\n                \"Output\": null\n            }\n        }\n    ]\n}"
    }
  ]
}