delphiDll / Orchestrator / Process Versions - Get single
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
IsActive: Boolean;
Title: PWideChar;
Version: PWideChar;
Key: PWideChar;
Description: PWideChar;
Published: PWideChar;
IsLatestVersion: Boolean;
OldVersion: PWideChar;
ReleaseNotes: PWideChar;
Authors: PWideChar;
Id: PWideChar;
Input: PWideChar;
Output: PWideChar;
odata_context: PWideChar;
odata_count: Integer;
i: Integer;
count_i: Integer;
begin
// 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) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttp__lastHeader(http));
Memo1.Lines.Add('Failed.');
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": 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
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 do
begin
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;
end;
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}"
}
]
}
