Foxpro / Orchestrator / Queues - Create
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcOdata_context
LOCAL lcName
LOCAL lcDescription
LOCAL lnMaxNumberOfRetries
LOCAL lnAcceptAutomaticallyRetry
LOCAL lnEnforceUniqueReference
LOCAL lcCreationTime
LOCAL lnId
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("Name","NewQueue")
loJson.UpdateString("Description","A queue created with the Orchestrator API")
loJson.UpdateInt("MaxNumberOfRetries",1)
loJson.UpdateBool("AcceptAutomaticallyRetry",1)
loJson.UpdateBool("EnforceUniqueReference",0)
loHttp.SetRequestHeader("Content-Type","application/json")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("X-UIPATH-OrganizationUnitId","{{folderId}}")
loHttp.SetRequestHeader("X-UIPATH-TenantName","{{tenantName}}")
loResp = loHttp.PostJson3("https://domain.com/odata/QueueDefinitions","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcOdata_context = loJResp.StringOf('"@odata.context"')
lcName = loJResp.StringOf("Name")
lcDescription = loJResp.StringOf("Description")
lnMaxNumberOfRetries = loJResp.IntOf("MaxNumberOfRetries")
lnAcceptAutomaticallyRetry = loJResp.BoolOf("AcceptAutomaticallyRetry")
lnEnforceUniqueReference = loJResp.BoolOf("EnforceUniqueReference")
lcCreationTime = loJResp.StringOf("CreationTime")
lnId = loJResp.IntOf("Id")
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
