Chilkat Online Tools

Objective-C / Orchestrator / Robot Service - Get Robot Mappings

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <CkoJsonArray.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"licenseKey" value: @"86753095683"];
[queryParams UpdateString: @"machineName" value: @"TESTLAPTOP"];

[http SetRequestHeader: @"Content-Type" value: @"application/json"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"X-UIPATH-OrganizationUnitId" value: @"{{folderId}}"];
[http SetRequestHeader: @"X-UIPATH-TenantName" value: @"{{tenantName}}"];

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://domain.com/api/RobotsService/GetRobotMappings" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonArray *jarrResp = [[CkoJsonArray alloc] init];
[jarrResp LoadSb: sbResponseBody];
jarrResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jarrResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

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

// [
//   {
//     "robotKey": "1234567-abcd-890p-a67b-6d5b987dj",
//     "user": "dean",
//     "machineName": "TESTLAPTOP",
//     "machineId": 20000,
//     "robotName": "joe",
//     "robotType": 3,
//     "hasLicense": false,
//     "tenantId": 1234,
//     "organizationUnitId": 5678,
//     "executionSettings": null,
//     "id": 33445
//   }
// ]

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

CkoJsonObject *json = 0;
NSString *robotKey = 0;
NSString *user = 0;
NSString *machineName = 0;
int machineId;
NSString *robotName = 0;
int robotType;
BOOL hasLicense;
int tenantId;
int organizationUnitId;
NSString *executionSettings = 0;
int id;

int i = 0;
int count_i = [jarrResp.Size intValue];
while (i < count_i) {
    json = [jarrResp ObjectAt: [NSNumber numberWithInt: i]];
    robotKey = [json StringOf: @"robotKey"];
    user = [json StringOf: @"user"];
    machineName = [json StringOf: @"machineName"];
    machineId = [[json IntOf: @"machineId"] intValue];
    robotName = [json StringOf: @"robotName"];
    robotType = [[json IntOf: @"robotType"] intValue];
    hasLicense = [json BoolOf: @"hasLicense"];
    tenantId = [[json IntOf: @"tenantId"] intValue];
    organizationUnitId = [[json IntOf: @"organizationUnitId"] intValue];
    executionSettings = [json StringOf: @"executionSettings"];
    id = [[json IntOf: @"id"] intValue];

    i = i + 1;
}

Curl Command

curl -G -d "licenseKey=86753095683"
	-d "machineName=TESTLAPTOP"
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "X-UIPATH-TenantName: {{tenantName}}"
	-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/api/RobotsService/GetRobotMappings

Postman Collection Item JSON

{
  "name": "Robot Service - Get Robot Mappings",
  "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}}/api/RobotsService/GetRobotMappings?licenseKey=86753095683&machineName=TESTLAPTOP",
      "host": [
        "{{url}}"
      ],
      "path": [
        "api",
        "RobotsService",
        "GetRobotMappings"
      ],
      "query": [
        {
          "key": "licenseKey",
          "value": "86753095683"
        },
        {
          "key": "machineName",
          "value": "TESTLAPTOP"
        }
      ]
    }
  },
  "response": [
    {
      "name": "Robot Service - Get Robot Service Mappings",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{url}}/api/RobotsService/GetRobotMappings?licenseKey=86753095683&machineName=TESTLAPTOP",
          "host": [
            "{{url}}"
          ],
          "path": [
            "api",
            "RobotsService",
            "GetRobotMappings"
          ],
          "query": [
            {
              "key": "licenseKey",
              "value": "86753095683"
            },
            {
              "key": "machineName",
              "value": "TESTLAPTOP"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 28 Jan 2019 23:05:37 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "122"
        },
        {
          "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": "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": "4a071ad5fc4a247a-IAD"
        }
      ],
      "cookie": [
      ],
      "body": "[\n    {\n        \"robotKey\": \"1234567-abcd-890p-a67b-6d5b987dj\",\n        \"user\": \"dean\",\n        \"machineName\": \"TESTLAPTOP\",\n        \"machineId\": 20000,\n        \"robotName\": \"joe\",\n        \"robotType\": 3,\n        \"hasLicense\": false,\n        \"tenantId\": 1234,\n        \"organizationUnitId\": 5678,\n        \"executionSettings\": null,\n        \"id\": 33445\n    }\n]"
    }
  ]
}