SQL Server / Orchestrator / Jobs - Start job with inputs
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
DECLARE @iTmp0 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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "startInfo": {
-- "ReleaseKey": "5b754c63-5d1a-4c37-bb9b-74b69e4934bf",
-- "Strategy": "Specific",
-- "RobotIds": [
-- 1553
-- ],
-- "NoOfRobots": 0,
-- "Source": "Manual",
-- "InputArguments": "{\"greeting\":\"Aloha\"}"
-- }
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'startInfo.ReleaseKey', '5b754c63-5d1a-4c37-bb9b-74b69e4934bf'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'startInfo.Strategy', 'Specific'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'startInfo.RobotIds[0]', 1553
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'startInfo.NoOfRobots', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'startInfo.Source', 'Manual'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'startInfo.InputArguments', '{"greeting":"Aloha"}'
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 @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
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 @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "@odata.context": "https://beta.uipath.com/odata/$metadata#Jobs",
-- "value": [
-- {
-- "Key": "b618cdfd-8714-4dbf-9a00-0586a8953c90",
-- "StartTime": null,
-- "EndTime": null,
-- "State": "Pending",
-- "Source": "Manual",
-- "SourceType": "Manual",
-- "BatchExecutionKey": "abbbb5de-d46a-4b9b-8f73-8a3247be0a0e",
-- "Info": null,
-- "CreationTime": "2018-09-21T13:28:31.1449691Z",
-- "StartingScheduleId": null,
-- "ReleaseName": "Heyyo_playground",
-- "Type": "Unattended",
-- "InputArguments": "{\"message\":\"Aloha\"}",
-- "OutputArguments": null,
-- "Id": 160856
-- }
-- ]
-- }
-- 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 @StartTime nvarchar(4000)
DECLARE @EndTime nvarchar(4000)
DECLARE @State nvarchar(4000)
DECLARE @Source nvarchar(4000)
DECLARE @SourceType nvarchar(4000)
DECLARE @BatchExecutionKey nvarchar(4000)
DECLARE @Info nvarchar(4000)
DECLARE @CreationTime nvarchar(4000)
DECLARE @StartingScheduleId nvarchar(4000)
DECLARE @ReleaseName nvarchar(4000)
DECLARE @v_Type nvarchar(4000)
DECLARE @InputArguments nvarchar(4000)
DECLARE @OutputArguments nvarchar(4000)
DECLARE @Id int
DECLARE @odata_context nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @odata_context OUT, '"@odata.context"'
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', @StartTime OUT, 'value[i].StartTime'
EXEC sp_OAMethod @jResp, 'StringOf', @EndTime OUT, 'value[i].EndTime'
EXEC sp_OAMethod @jResp, 'StringOf', @State OUT, 'value[i].State'
EXEC sp_OAMethod @jResp, 'StringOf', @Source OUT, 'value[i].Source'
EXEC sp_OAMethod @jResp, 'StringOf', @SourceType OUT, 'value[i].SourceType'
EXEC sp_OAMethod @jResp, 'StringOf', @BatchExecutionKey OUT, 'value[i].BatchExecutionKey'
EXEC sp_OAMethod @jResp, 'StringOf', @Info OUT, 'value[i].Info'
EXEC sp_OAMethod @jResp, 'StringOf', @CreationTime OUT, 'value[i].CreationTime'
EXEC sp_OAMethod @jResp, 'StringOf', @StartingScheduleId OUT, 'value[i].StartingScheduleId'
EXEC sp_OAMethod @jResp, 'StringOf', @ReleaseName OUT, 'value[i].ReleaseName'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'value[i].Type'
EXEC sp_OAMethod @jResp, 'StringOf', @InputArguments OUT, 'value[i].InputArguments'
EXEC sp_OAMethod @jResp, 'StringOf', @OutputArguments OUT, 'value[i].OutputArguments'
EXEC sp_OAMethod @jResp, 'IntOf', @Id OUT, 'value[i].Id'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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 '{ "startInfo":
{ "ReleaseKey": "5b754c63-5d1a-4c37-bb9b-74b69e4934bf",
"Strategy": "Specific",
"RobotIds": [ 1553 ],
"NoOfRobots": 0,
"Source": "Manual",
"InputArguments": "{\"greeting\":\"Aloha\"}"
}
}'
https://domain.com/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
Postman Collection Item JSON
{
"name": "Jobs - Start job with inputs",
"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": "{ \"startInfo\":\r\n { \"ReleaseKey\": \"5b754c63-5d1a-4c37-bb9b-74b69e4934bf\",\r\n \"Strategy\": \"Specific\",\r\n \"RobotIds\": [ 1553 ],\r\n \"NoOfRobots\": 0,\r\n \"Source\": \"Manual\",\r\n \"InputArguments\": \"{\\\"greeting\\\":\\\"Aloha\\\"}\"\r\n } \r\n}"
},
"url": {
"raw": "{{url}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs",
"host": [
"{{url}}"
],
"path": [
"odata",
"Jobs",
"UiPath.Server.Configuration.OData.StartJobs"
]
},
"description": "Starting in v2018.3, jobs can accept input parameters."
},
"response": [
{
"name": "Jobs - Start job with inputs",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{ \"startInfo\":\r\n { \"ReleaseKey\": \"5b754c63-5d1a-4c37-bb9b-74b69e4934bf\",\r\n \"Strategy\": \"Specific\",\r\n \"RobotIds\": [ 1553 ],\r\n \"NoOfRobots\": 0,\r\n \"Source\": \"Manual\",\r\n \"InputArguments\": \"{\\\"message\\\":\\\"Aloha\\\"}\"\r\n } \r\n}"
},
"url": {
"raw": "{{url}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs",
"host": [
"{{url}}"
],
"path": [
"odata",
"Jobs",
"UiPath.Server.Configuration.OData.StartJobs"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "",
"header": [
{
"key": "CF-RAY",
"value": "43b31c105eefbf07-FRA",
"name": "CF-RAY",
"description": "",
"type": "text"
},
{
"key": "Cache-Control",
"value": "no-store, must-revalidate, no-cache, max-age=0",
"name": "Cache-Control",
"description": "",
"type": "text"
},
{
"key": "Connection",
"value": "keep-alive",
"name": "Connection",
"description": "",
"type": "text"
},
{
"key": "Content-Length",
"value": "425",
"name": "Content-Length",
"description": "",
"type": "text"
},
{
"key": "Content-Type",
"value": "application/json; odata.metadata=minimal",
"name": "Content-Type",
"description": "",
"type": "text"
},
{
"key": "Date",
"value": "Mon, 16 Sep 2018 08:30:56 GMT",
"name": "Date",
"description": "",
"type": "text"
},
{
"key": "Expect-CT",
"value": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"",
"name": "Expect-CT",
"description": "",
"type": "text"
},
{
"key": "OData-Version",
"value": "4.0",
"name": "OData-Version",
"description": "",
"type": "text"
},
{
"key": "Server",
"value": "cloudflare",
"name": "Server",
"description": "",
"type": "text"
},
{
"key": "Set-Cookie",
"value": "; SameSite=lax",
"name": "Set-Cookie",
"description": "",
"type": "text"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains",
"name": "Strict-Transport-Security",
"description": "",
"type": "text"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff",
"name": "X-Content-Type-Options",
"description": "",
"type": "text"
},
{
"key": "X-Frame-Options",
"value": "DENY",
"name": "X-Frame-Options",
"description": "",
"type": "text"
},
{
"key": "api-supported-versions",
"value": "5.0",
"name": "api-supported-versions",
"description": "",
"type": "text"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://beta.uipath.com/odata/$metadata#Jobs\",\n \"value\": [\n {\n \"Key\": \"b618cdfd-8714-4dbf-9a00-0586a8953c90\",\n \"StartTime\": null,\n \"EndTime\": null,\n \"State\": \"Pending\",\n \"Source\": \"Manual\",\n \"SourceType\": \"Manual\",\n \"BatchExecutionKey\": \"abbbb5de-d46a-4b9b-8f73-8a3247be0a0e\",\n \"Info\": null,\n \"CreationTime\": \"2018-09-21T13:28:31.1449691Z\",\n \"StartingScheduleId\": null,\n \"ReleaseName\": \"Heyyo_playground\",\n \"Type\": \"Unattended\",\n \"InputArguments\": \"{\\\"message\\\":\\\"Aloha\\\"}\",\n \"OutputArguments\": null,\n \"Id\": 160856\n }\n ]\n}"
}
]
}
