Chilkat Online Tools

SQL Server / Orchestrator / Machines - Get All

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-UIPATH-OrganizationUnitId', '{{folderId}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-UIPATH-TenantName', '{{tenantName}}'

    DECLARE @sbResponseBody int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://domain.com/odata/Machines', @sbResponseBody
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END

    DECLARE @jResp int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END

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

    -- {
    --   "@odata.context": "https://platform.uipath.com/odata/$metadata#Machines",
    --   "@odata.count": 2,
    --   "value": [
    --     {
    --       "LicenseKey": null,
    --       "Name": "FAKEMACHINE",
    --       "Type": "Standard",
    --       "NonProductionSlots": 0,
    --       "UnattendedSlots": 0,
    --       "Id": 20979,
    --       "RobotVersions": [
    --         {
    --           "Count": 1,
    --           "Version": null
    --         }
    --       ]
    --     },
    --     {
    --       "LicenseKey": null,
    --       "Name": "AnotherFakeOne",
    --       "Type": "Standard",
    --       "NonProductionSlots": 0,
    --       "UnattendedSlots": 0,
    --       "Id": 20967,
    --       "RobotVersions": [
    --         {
    --           "Count": 1,
    --           "Version": null
    --         }
    --       ]
    --     }
    --   ]
    -- }

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

    DECLARE @LicenseKey nvarchar(4000)

    DECLARE @Name nvarchar(4000)

    DECLARE @v_Type nvarchar(4000)

    DECLARE @NonProductionSlots int

    DECLARE @UnattendedSlots int

    DECLARE @Id int

    DECLARE @j int

    DECLARE @count_j int

    DECLARE @Count int

    DECLARE @Version nvarchar(4000)

    DECLARE @odata_context nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @odata_context OUT, '"@odata.context"'
    DECLARE @odata_count int
    EXEC sp_OAMethod @jResp, 'IntOf', @odata_count OUT, '"@odata.count"'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'value'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @LicenseKey OUT, 'value[i].LicenseKey'
        EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'value[i].Name'
        EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'value[i].Type'
        EXEC sp_OAMethod @jResp, 'IntOf', @NonProductionSlots OUT, 'value[i].NonProductionSlots'
        EXEC sp_OAMethod @jResp, 'IntOf', @UnattendedSlots OUT, 'value[i].UnattendedSlots'
        EXEC sp_OAMethod @jResp, 'IntOf', @Id OUT, 'value[i].Id'
        SELECT @j = 0
        EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'value[i].RobotVersions'
        WHILE @j < @count_j
          BEGIN
            EXEC sp_OASetProperty @jResp, 'J', @j
            EXEC sp_OAMethod @jResp, 'IntOf', @Count OUT, 'value[i].RobotVersions[j].Count'
            EXEC sp_OAMethod @jResp, 'StringOf', @Version OUT, 'value[i].RobotVersions[j].Version'
            SELECT @j = @j + 1
          END
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO

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/Machines

Postman Collection Item JSON

{
  "name": "Machines - Get All",
  "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/Machines",
      "host": [
        "{{url}}"
      ],
      "path": [
        "odata",
        "Machines"
      ]
    }
  },
  "response": [
    {
      "name": "Machines - Get All",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{url}}/odata/Machines",
          "host": [
            "{{url}}"
          ],
          "path": [
            "odata",
            "Machines"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 10 Dec 2018 20:49:05 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; odata.metadata=minimal"
        },
        {
          "key": "Content-Length",
          "value": "347"
        },
        {
          "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": "487293786b66c5f2-EWR"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://platform.uipath.com/odata/$metadata#Machines\",\n    \"@odata.count\": 2,\n    \"value\": [\n        {\n            \"LicenseKey\": null,\n            \"Name\": \"FAKEMACHINE\",\n            \"Type\": \"Standard\",\n            \"NonProductionSlots\": 0,\n            \"UnattendedSlots\": 0,\n            \"Id\": 20979,\n            \"RobotVersions\": [\n                {\n                    \"Count\": 1,\n                    \"Version\": null\n                }\n            ]\n        },\n        {\n            \"LicenseKey\": null,\n            \"Name\": \"AnotherFakeOne\",\n            \"Type\": \"Standard\",\n            \"NonProductionSlots\": 0,\n            \"UnattendedSlots\": 0,\n            \"Id\": 20967,\n            \"RobotVersions\": [\n                {\n                    \"Count\": 1,\n                    \"Version\": null\n                }\n            ]\n        }\n    ]\n}"
    }
  ]
}