Chilkat Online Tools

Ruby / Orchestrator / Robot Service - Get Robot Mappings

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("licenseKey","86753095683")
queryParams.UpdateString("machineName","TESTLAPTOP")

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

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/api/RobotsService/GetRobotMappings",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jarrResp = Chilkat::CkJsonArray.new()
jarrResp.LoadSb(sbResponseBody)
jarrResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jarrResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

i = 0
count_i = jarrResp.get_Size()
while i < count_i
    # json is a CkJsonObject
    json = jarrResp.ObjectAt(i)
    robotKey = json.stringOf("robotKey")
    user = json.stringOf("user")
    machineName = json.stringOf("machineName")
    machineId = json.IntOf("machineId")
    robotName = json.stringOf("robotName")
    robotType = json.IntOf("robotType")
    hasLicense = json.BoolOf("hasLicense")
    tenantId = json.IntOf("tenantId")
    organizationUnitId = json.IntOf("organizationUnitId")
    executionSettings = json.stringOf("executionSettings")
    id = json.IntOf("id")

    i = i + 1
end

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]"
    }
  ]
}