SQL Server / Orchestrator / Queues - Create
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.
-- {
-- "Name": "NewQueue",
-- "Description": "A queue created with the Orchestrator API",
-- "MaxNumberOfRetries": 1,
-- "AcceptAutomaticallyRetry": true,
-- "EnforceUniqueReference": false
-- }
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, 'Name', 'NewQueue'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'Description', 'A queue created with the Orchestrator API'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'MaxNumberOfRetries', 1
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'AcceptAutomaticallyRetry', 1
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'EnforceUniqueReference', 0
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/QueueDefinitions', '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://platform.uipath.com/odata/$metadata#QueueDefinitions/$entity",
-- "Name": "NewQueue",
-- "Description": "A queue created with the Orchestrator API",
-- "MaxNumberOfRetries": 1,
-- "AcceptAutomaticallyRetry": true,
-- "EnforceUniqueReference": false,
-- "CreationTime": "2018-12-01T10:31:22.176966Z",
-- "Id": 67671
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @odata_context nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @odata_context OUT, '"@odata.context"'
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'Name'
DECLARE @Description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'Description'
DECLARE @MaxNumberOfRetries int
EXEC sp_OAMethod @jResp, 'IntOf', @MaxNumberOfRetries OUT, 'MaxNumberOfRetries'
DECLARE @AcceptAutomaticallyRetry int
EXEC sp_OAMethod @jResp, 'BoolOf', @AcceptAutomaticallyRetry OUT, 'AcceptAutomaticallyRetry'
DECLARE @EnforceUniqueReference int
EXEC sp_OAMethod @jResp, 'BoolOf', @EnforceUniqueReference OUT, 'EnforceUniqueReference'
DECLARE @CreationTime nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CreationTime OUT, 'CreationTime'
DECLARE @Id int
EXEC sp_OAMethod @jResp, 'IntOf', @Id OUT, 'Id'
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 '{
"Name": "NewQueue",
"Description": "A queue created with the Orchestrator API",
"MaxNumberOfRetries": 1,
"AcceptAutomaticallyRetry": true,
"EnforceUniqueReference": false
}'
https://domain.com/odata/QueueDefinitions
Postman Collection Item JSON
{
"name": "Queues - 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\": \"NewQueue\",\r\n \"Description\": \"A queue created with the Orchestrator API\",\r\n \"MaxNumberOfRetries\": 1,\r\n \"AcceptAutomaticallyRetry\": true,\r\n \"EnforceUniqueReference\": false\r\n}"
},
"url": {
"raw": "{{url}}/odata/QueueDefinitions",
"host": [
"{{url}}"
],
"path": [
"odata",
"QueueDefinitions"
]
}
},
"response": [
{
"name": "Create New Queue",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"Name\": \"NewQueue\",\r\n \"Description\": \"A queue created with the Orchestrator API\",\r\n \"MaxNumberOfRetries\": 1,\r\n \"AcceptAutomaticallyRetry\": true,\r\n \"EnforceUniqueReference\": false\r\n}"
},
"url": {
"raw": "{{url}}/odata/QueueDefinitions",
"host": [
"{{url}}"
],
"path": [
"odata",
"QueueDefinitions"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Sat, 01 Dec 2018 10:31:22 GMT"
},
{
"key": "Content-Type",
"value": "application/json; odata.metadata=minimal"
},
{
"key": "Content-Length",
"value": "307"
},
{
"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/QueueDefinitions(67671)"
},
{
"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": "4824e23a39c4c297-FRA"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://platform.uipath.com/odata/$metadata#QueueDefinitions/$entity\",\n \"Name\": \"NewQueue\",\n \"Description\": \"A queue created with the Orchestrator API\",\n \"MaxNumberOfRetries\": 1,\n \"AcceptAutomaticallyRetry\": true,\n \"EnforceUniqueReference\": false,\n \"CreationTime\": \"2018-12-01T10:31:22.176966Z\",\n \"Id\": 67671\n}"
}
]
}
