Chilkat Online Tools

Delphi (DLL) / Orchestrator / 2. Releases - Get by name

Back to Collection Items

var

begin
CkJsonObject_UpdateString(queryParams,'$filter','ProcessKey eq ''Hello''');CkHttp_putAuthToken(http,'<access_token>');CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);Key := CkJsonObject__stringOf(jResp,'value[i].Key');ProcessKey := CkJsonObject__stringOf(jResp,'value[i].ProcessKey');ProcessVersion := CkJsonObject__stringOf(jResp,'value[i].ProcessVersion');IsLatestVersion := CkJsonObject_BoolOf(jResp,'value[i].IsLatestVersion');IsProcessDeleted := CkJsonObject_BoolOf(jResp,'value[i].IsProcessDeleted');Description := CkJsonObject__stringOf(jResp,'value[i].Description');Name := CkJsonObject__stringOf(jResp,'value[i].Name');EnvironmentId := CkJsonObject_IntOf(jResp,'value[i].EnvironmentId');EnvironmentName := CkJsonObject__stringOf(jResp,'value[i].EnvironmentName');InputArguments := CkJsonObject__stringOf(jResp,'value[i].InputArguments');QueueDefinitionId := CkJsonObject__stringOf(jResp,'value[i].QueueDefinitionId');QueueDefinitionName := CkJsonObject__stringOf(jResp,'value[i].QueueDefinitionName');Id := CkJsonObject_IntOf(jResp,'value[i].Id');Input := CkJsonObject__stringOf(jResp,'value[i].Arguments.Input');Output := CkJsonObject__stringOf(jResp,'value[i].Arguments.Output');ProcessSettings := CkJsonObject__stringOf(jResp,'value[i].ProcessSettings');i := i + 1;

Curl Command

curl -G -d "$filter=ProcessKey%20eq%20%27Hello%27"
	-H "Authorization: Bearer <access_token>"
	-H "X-UIPATH-TenantName: {{tenantName}}"
	-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/odata/Releases

Postman Collection Item JSON

{
  "name": "2. Releases - Get by name",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "X-UIPATH-TenantName",
        "value": "{{tenantName}}",
        "type": "text"
      },
      {
        "key": "X-UIPATH-OrganizationUnitId",
        "value": "{{folderId}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{url}}/odata/Releases?$filter=ProcessKey eq 'Hello'",
      "host": [
        "{{url}}"
      ],
      "path": [
        "odata",
        "Releases"
      ],
      "query": [
        {
          "key": "$filter",
          "value": "ProcessKey eq 'Hello'"
        }
      ]
    },
    "description": "So you've created a **Process** in UiPath Studio and published it to Orchestrator. Here's where you specify that process, by name, in order to start it remotely.\n\nWithin the URL, simply replace the word `Hello` with the name of your process and this call will return the `ReleaseKey` that will identify your process in step 4."
  },
  "response": [
    {
      "name": "2. Get the Process",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{url}}/odata/Releases?$filter=ProcessKey eq 'Hello'",
          "host": [
            "{{url}}"
          ],
          "path": [
            "odata",
            "Releases"
          ],
          "query": [
            {
              "key": "$filter",
              "value": "ProcessKey eq 'Hello'"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 03 Jul 2019 23:08:51 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; odata.metadata=minimal"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "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": "api-supported-versions",
          "value": "8.0"
        },
        {
          "key": "OData-Version",
          "value": "4.0"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Frame-Options",
          "value": "DENY"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains"
        },
        {
          "key": "Set-Cookie",
          "value": "; SameSite=lax"
        },
        {
          "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": "4f0c85eb7e8c3892-ATL"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://platform.uipath.com/odata/$metadata#Releases\",\n    \"@odata.count\": 1,\n    \"value\": [\n        {\n            \"Key\": \"0764f4a-2ce0-41b9-r738-4575566f3756\",\n            \"ProcessKey\": \"Hello\",\n            \"ProcessVersion\": \"1.0.6913.24377\",\n            \"IsLatestVersion\": false,\n            \"IsProcessDeleted\": false,\n            \"Description\": null,\n            \"Name\": \"Hello_playground\",\n            \"EnvironmentId\": 3210,\n            \"EnvironmentName\": \"playground\",\n            \"InputArguments\": \"{}\",\n            \"QueueDefinitionId\": null,\n            \"QueueDefinitionName\": null,\n            \"Id\": 12345,\n            \"Arguments\": {\n                \"Input\": \"[{\\\"name\\\":\\\"greeting\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":false},{\\\"name\\\":\\\"url\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":false},{\\\"name\\\":\\\"username\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":true},{\\\"name\\\":\\\"password\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":true}]\",\n                \"Output\": \"[{\\\"name\\\":\\\"greeting\\\",\\\"type\\\":\\\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\\\",\\\"required\\\":false,\\\"hasDefault\\\":false}]\"\n            },\n            \"ProcessSettings\": null\n        }\n    ]\n}"
    }
  ]
}