Chilkat Online Tools

PureBasic / Orchestrator / Machines - Create

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "Name": "SomeMachine",
    ;   "Type": "Standard"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"Name","SomeMachine")
    CkJsonObject::ckUpdateString(json,"Type","Standard")

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

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/odata/Machines","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; {
    ;   "@odata.context": "https://platform.uipath.com/odata/$metadata#Machines/$entity",
    ;   "LicenseKey": "765asd90-1c32-1b54-b6ed-d8f73jdk8",
    ;   "Name": "SomeMachine",
    ;   "Type": "Standard",
    ;   "NonProductionSlots": 0,
    ;   "UnattendedSlots": 0,
    ;   "Id": 84312,
    ;   "RobotVersions": [
    ;   ]
    ; }

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

    odata_context.s = CkJsonObject::ckStringOf(jResp,Chr(34) + "@odata.context" + Chr(34))
    LicenseKey.s = CkJsonObject::ckStringOf(jResp,"LicenseKey")
    Name.s = CkJsonObject::ckStringOf(jResp,"Name")
    v_Type.s = CkJsonObject::ckStringOf(jResp,"Type")
    NonProductionSlots.i = CkJsonObject::ckIntOf(jResp,"NonProductionSlots")
    UnattendedSlots.i = CkJsonObject::ckIntOf(jResp,"UnattendedSlots")
    Id.i = CkJsonObject::ckIntOf(jResp,"Id")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"RobotVersions")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "X-UIPATH-TenantName: {{tenantName}}"
	-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
	-d '{
  "Name": "SomeMachine",
  "Type": "Standard"
}'
https://domain.com/odata/Machines

Postman Collection Item JSON

{
  "name": "Machines - Create",
  "request": {
    "method": "POST",
    "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"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n  \"Name\": \"SomeMachine\",\r\n  \"Type\": \"Standard\"\r\n}"
    },
    "url": {
      "raw": "{{url}}/odata/Machines",
      "host": [
        "{{url}}"
      ],
      "path": [
        "odata",
        "Machines"
      ]
    }
  },
  "response": [
    {
      "name": "Machines - Create",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\r\n  \"Name\": \"SomeMachine\",\r\n  \"Type\": \"Standard\"\r\n}"
        },
        "url": {
          "raw": "{{url}}/odata/Machines",
          "host": [
            "{{url}}"
          ],
          "path": [
            "odata",
            "Machines"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Tue, 29 Jan 2019 13:47:03 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; odata.metadata=minimal"
        },
        {
          "key": "Content-Length",
          "value": "245"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Cache-Control",
          "value": "no-store, must-revalidate, no-cache, max-age=0"
        },
        {
          "key": "Location",
          "value": "https://platform.uipath.com/odata/Machines(84414)"
        },
        {
          "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": "4a0c25f50cb92468-IAD"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://platform.uipath.com/odata/$metadata#Machines/$entity\",\n    \"LicenseKey\": \"765asd90-1c32-1b54-b6ed-d8f73jdk8\",\n    \"Name\": \"SomeMachine\",\n    \"Type\": \"Standard\",\n    \"NonProductionSlots\": 0,\n    \"UnattendedSlots\": 0,\n    \"Id\": 84312,\n    \"RobotVersions\": []\n}"
    }
  ]
}