Chilkat Online Tools

Swift3 / Orchestrator / Process Versions - Get single

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

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

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://domain.com/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='Heyyo')", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = http.lastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.lastHeader!)")
        print("Failed.")
        return
    }

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

    var IsActive: Bool
    var Title: String?
    var Version: String?
    var Key: String?
    var Description: String?
    var Published: String?
    var IsLatestVersion: Bool
    var OldVersion: String?
    var ReleaseNotes: String?
    var Authors: String?
    var Id: String?
    var Input: String?
    var Output: String?

    var odata_context: String? = jResp.string(of: "\"@odata.context\"")
    var odata_count: Int = jResp.int(of: "\"@odata.count\"").intValue
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "value").intValue
    while i < count_i {
        jResp.i = i
        IsActive = jResp.bool(of: "value[i].IsActive")
        Title = jResp.string(of: "value[i].Title")
        Version = jResp.string(of: "value[i].Version")
        Key = jResp.string(of: "value[i].Key")
        Description = jResp.string(of: "value[i].Description")
        Published = jResp.string(of: "value[i].Published")
        IsLatestVersion = jResp.bool(of: "value[i].IsLatestVersion")
        OldVersion = jResp.string(of: "value[i].OldVersion")
        ReleaseNotes = jResp.string(of: "value[i].ReleaseNotes")
        Authors = jResp.string(of: "value[i].Authors")
        Id = jResp.string(of: "value[i].Id")
        Input = jResp.string(of: "value[i].Arguments.Input")
        Output = jResp.string(of: "value[i].Arguments.Output")
        i = i + 1
    }


}

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