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.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, '$Filter', 'ProcessKey eq ''PetStore_AddPet_byQueueItem'''
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-UIPATH-OrganizationUnitId', '{{folderId}}'
DECLARE @resp int
EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT
EXEC sp_OAMethod @http, 'HttpParams', @success OUT, 'GET', 'https://domain.com/orchestrator_/odata/Releases', @queryParams, @resp
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @resp
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat.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 @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @resp
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://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Releases",
-- "@odata.count": 1,
-- "value": [
-- {
-- "Key": "6f459380-1b98-4f33-9682-6f8a7457490f",
-- "ProcessKey": "PetStore_AddPet_byQueueItem",
-- "ProcessVersion": "1.0.13",
-- "IsLatestVersion": false,
-- "IsProcessDeleted": false,
-- "Description": "Gets a queue item and adds a pet with item name",
-- "Name": "Add a pet to pet store by queue item",
-- "EnvironmentId": null,
-- "EnvironmentName": "",
-- "EntryPointId": null,
-- "InputArguments": null,
-- "ProcessType": "Process",
-- "SupportsMultipleEntryPoints": true,
-- "RequiresUserInteraction": true,
-- "AutoUpdate": false,
-- "FeedId": "ef94e92f-5f58-474b-963c-c3ef46391ca7",
-- "JobPriority": "Normal",
-- "CreationTime": "2021-03-16T09:04:00.607Z",
-- "OrganizationUnitId": 515128,
-- "OrganizationUnitFullyQualifiedName": "UnattendedProcesses",
-- "Id": 31025,
-- "Arguments": {
-- "Input": null,
-- "Output": null
-- },
-- "ProcessSettings": null
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @Key nvarchar(4000)
DECLARE @ProcessKey nvarchar(4000)
DECLARE @ProcessVersion nvarchar(4000)
DECLARE @IsLatestVersion int
DECLARE @IsProcessDeleted int
DECLARE @Description nvarchar(4000)
DECLARE @Name nvarchar(4000)
DECLARE @EnvironmentId nvarchar(4000)
DECLARE @EnvironmentName nvarchar(4000)
DECLARE @EntryPointId nvarchar(4000)
DECLARE @InputArguments nvarchar(4000)
DECLARE @ProcessType nvarchar(4000)
DECLARE @SupportsMultipleEntryPoints int
DECLARE @RequiresUserInteraction int
DECLARE @AutoUpdate int
DECLARE @FeedId nvarchar(4000)
DECLARE @JobPriority nvarchar(4000)
DECLARE @CreationTime nvarchar(4000)
DECLARE @OrganizationUnitId int
DECLARE @OrganizationUnitFullyQualifiedName nvarchar(4000)
DECLARE @Id int
DECLARE @Input nvarchar(4000)
DECLARE @Output nvarchar(4000)
DECLARE @ProcessSettings 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', @Key OUT, 'value[i].Key'
EXEC sp_OAMethod @jResp, 'StringOf', @ProcessKey OUT, 'value[i].ProcessKey'
EXEC sp_OAMethod @jResp, 'StringOf', @ProcessVersion OUT, 'value[i].ProcessVersion'
EXEC sp_OAMethod @jResp, 'BoolOf', @IsLatestVersion OUT, 'value[i].IsLatestVersion'
EXEC sp_OAMethod @jResp, 'BoolOf', @IsProcessDeleted OUT, 'value[i].IsProcessDeleted'
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'value[i].Description'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'value[i].Name'
EXEC sp_OAMethod @jResp, 'StringOf', @EnvironmentId OUT, 'value[i].EnvironmentId'
EXEC sp_OAMethod @jResp, 'StringOf', @EnvironmentName OUT, 'value[i].EnvironmentName'
EXEC sp_OAMethod @jResp, 'StringOf', @EntryPointId OUT, 'value[i].EntryPointId'
EXEC sp_OAMethod @jResp, 'StringOf', @InputArguments OUT, 'value[i].InputArguments'
EXEC sp_OAMethod @jResp, 'StringOf', @ProcessType OUT, 'value[i].ProcessType'
EXEC sp_OAMethod @jResp, 'BoolOf', @SupportsMultipleEntryPoints OUT, 'value[i].SupportsMultipleEntryPoints'
EXEC sp_OAMethod @jResp, 'BoolOf', @RequiresUserInteraction OUT, 'value[i].RequiresUserInteraction'
EXEC sp_OAMethod @jResp, 'BoolOf', @AutoUpdate OUT, 'value[i].AutoUpdate'
EXEC sp_OAMethod @jResp, 'StringOf', @FeedId OUT, 'value[i].FeedId'
EXEC sp_OAMethod @jResp, 'StringOf', @JobPriority OUT, 'value[i].JobPriority'
EXEC sp_OAMethod @jResp, 'StringOf', @CreationTime OUT, 'value[i].CreationTime'
EXEC sp_OAMethod @jResp, 'IntOf', @OrganizationUnitId OUT, 'value[i].OrganizationUnitId'
EXEC sp_OAMethod @jResp, 'StringOf', @OrganizationUnitFullyQualifiedName OUT, 'value[i].OrganizationUnitFullyQualifiedName'
EXEC sp_OAMethod @jResp, 'IntOf', @Id OUT, 'value[i].Id'
EXEC sp_OAMethod @jResp, 'StringOf', @Input OUT, 'value[i].Arguments.Input'
EXEC sp_OAMethod @jResp, 'StringOf', @Output OUT, 'value[i].Arguments.Output'
EXEC sp_OAMethod @jResp, 'StringOf', @ProcessSettings OUT, 'value[i].ProcessSettings'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -G -d "$Filter=ProcessKey%20eq%20%27PetStore_AddPet_byQueueItem%27"
-H "Authorization: Bearer <access_token>"
-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/orchestrator_/odata/Releases
Postman Collection Item JSON
{
"name": "Get Releases by Name",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 200\", function () {\r",
" pm.response.to.have.status(200);\r",
"});\r",
"\r",
"//set release key\r",
"var myResponse = pm.response.json();\r",
"pm.collectionVariables.set(\"releaseKey\", myResponse.value[0].Key);\r",
"console.log(pm.collectionVariables.get(\"releaseKey\"));"
],
"type": "text/javascript"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "X-UIPATH-OrganizationUnitId",
"value": "{{folderId}}",
"type": "text"
}
],
"url": {
"raw": "{{url}}/orchestrator_/odata/Releases?$Filter=ProcessKey eq 'PetStore_AddPet_byQueueItem'",
"host": [
"{{url}}"
],
"path": [
"orchestrator_",
"odata",
"Releases"
],
"query": [
{
"key": "$Filter",
"value": "ProcessKey eq 'PetStore_AddPet_byQueueItem'"
}
]
},
"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 string in the filter parameter with the name of your process and this call will return the `ReleaseKey` that you will need in step 3 to start the process."
},
"response": [
{
"name": "Get Releases by Name Copy",
"originalRequest": {
"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=Name eq 'Add a pet to pet store by queue item'",
"host": [
"{{url}}"
],
"path": [
"odata",
"Releases"
],
"query": [
{
"key": "$filter",
"value": "Name eq 'Add a pet to pet store by queue item'"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 31 Mar 2021 12:54:04 GMT"
},
{
"key": "Content-Type",
"value": "application/json; odata.metadata=minimal; odata.streaming=true"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, must-revalidate"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Expires",
"value": "-1"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Request-Context",
"value": "appId=cid-v1:04884d99-0742-441b-a23c-847133cb0130"
},
{
"key": "X-Robots-Tag",
"value": "noindex,nofollow"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-XSS-Protection",
"value": "1"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Frame-Options",
"value": "Deny"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains"
},
{
"key": "Content-Security-Policy",
"value": "default-src 'self';script-src 'self';style-src 'self' 'unsafe-inline';img-src 'self' data: https://*.blob.core.windows.net https://*.amazonaws.com blob:;font-src 'self' data:;connect-src 'self' wss: https://sentry.io https://studio-feedback.azure-api.net https://storage.googleapis.com https://*.service.signalr.net https://*.blob.core.windows.net https://*.amazonaws.com dc.services.visualstudio.com;worker-src 'self' blob:"
},
{
"key": "X-Correlation-ID",
"value": "d38b319c-dac3-46d0-bf60-a4b3b18902f1"
},
{
"key": "OData-Version",
"value": "4.0"
},
{
"key": "api-supported-versions",
"value": "12.0"
},
{
"key": "CF-Cache-Status",
"value": "DYNAMIC"
},
{
"key": "cf-request-id",
"value": "0929f232600000cba0252ce000000001"
},
{
"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": "6389b963ce2fcba0-VIE"
},
{
"key": "Content-Encoding",
"value": "br"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Releases\",\n \"@odata.count\": 1,\n \"value\": [\n {\n \"Key\": \"6f459380-1b98-4f33-9682-6f8a7457490f\",\n \"ProcessKey\": \"PetStore_AddPet_byQueueItem\",\n \"ProcessVersion\": \"1.0.13\",\n \"IsLatestVersion\": false,\n \"IsProcessDeleted\": false,\n \"Description\": \"Gets a queue item and adds a pet with item name\",\n \"Name\": \"Add a pet to pet store by queue item\",\n \"EnvironmentId\": null,\n \"EnvironmentName\": \"\",\n \"EntryPointId\": null,\n \"InputArguments\": null,\n \"ProcessType\": \"Process\",\n \"SupportsMultipleEntryPoints\": true,\n \"RequiresUserInteraction\": true,\n \"AutoUpdate\": false,\n \"FeedId\": \"ef94e92f-5f58-474b-963c-c3ef46391ca7\",\n \"JobPriority\": \"Normal\",\n \"CreationTime\": \"2021-03-16T09:04:00.607Z\",\n \"OrganizationUnitId\": 515128,\n \"OrganizationUnitFullyQualifiedName\": \"UnattendedProcesses\",\n \"Id\": 31025,\n \"Arguments\": {\n \"Input\": null,\n \"Output\": null\n },\n \"ProcessSettings\": null\n }\n ]\n}"
}
]
}
