Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "jobId": 123
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateInt(json,"jobId",123)
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"X-UIPATH-OrganizationUnitId","{{folderId}}")
CkHttp::ckSetRequestHeader(http,"X-UIPATH-TenantName","{{tenantName}}")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.RestartJob","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Jobs/$entity",
; "Key": "64eb533a-5b10-437f-8a16-c896419f1793",
; "StartTime": null,
; "EndTime": null,
; "State": "Pending",
; "JobPriority": "Normal",
; "Source": "Manual",
; "SourceType": "Manual",
; "BatchExecutionKey": "26918b13-2e8f-456f-85e1-f2d6a164427e",
; "Info": null,
; "CreationTime": "2021-03-31T12:55:07.273Z",
; "StartingScheduleId": null,
; "ReleaseName": "Add a pet to pet store by queue item",
; "Type": "Unattended",
; "InputArguments": null,
; "OutputArguments": null,
; "HostMachineName": null,
; "HasMediaRecorded": false,
; "PersistenceId": null,
; "ResumeVersion": null,
; "StopStrategy": null,
; "RuntimeType": "Unattended",
; "RequiresUserInteraction": true,
; "ReleaseVersionId": null,
; "EntryPointPath": null,
; "OrganizationUnitId": 515128,
; "OrganizationUnitFullyQualifiedName": null,
; "Reference": "",
; "ProcessType": "Process",
; "Id": 12764707
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
odata_context.s = CkJsonObject::ckStringOf(jResp,Chr(34) + "@odata.context" + Chr(34))
Key.s = CkJsonObject::ckStringOf(jResp,"Key")
StartTime.s = CkJsonObject::ckStringOf(jResp,"StartTime")
EndTime.s = CkJsonObject::ckStringOf(jResp,"EndTime")
State.s = CkJsonObject::ckStringOf(jResp,"State")
JobPriority.s = CkJsonObject::ckStringOf(jResp,"JobPriority")
Source.s = CkJsonObject::ckStringOf(jResp,"Source")
SourceType.s = CkJsonObject::ckStringOf(jResp,"SourceType")
BatchExecutionKey.s = CkJsonObject::ckStringOf(jResp,"BatchExecutionKey")
Info.s = CkJsonObject::ckStringOf(jResp,"Info")
CreationTime.s = CkJsonObject::ckStringOf(jResp,"CreationTime")
StartingScheduleId.s = CkJsonObject::ckStringOf(jResp,"StartingScheduleId")
ReleaseName.s = CkJsonObject::ckStringOf(jResp,"ReleaseName")
v_Type.s = CkJsonObject::ckStringOf(jResp,"Type")
InputArguments.s = CkJsonObject::ckStringOf(jResp,"InputArguments")
OutputArguments.s = CkJsonObject::ckStringOf(jResp,"OutputArguments")
HostMachineName.s = CkJsonObject::ckStringOf(jResp,"HostMachineName")
HasMediaRecorded.i = CkJsonObject::ckBoolOf(jResp,"HasMediaRecorded")
PersistenceId.s = CkJsonObject::ckStringOf(jResp,"PersistenceId")
ResumeVersion.s = CkJsonObject::ckStringOf(jResp,"ResumeVersion")
StopStrategy.s = CkJsonObject::ckStringOf(jResp,"StopStrategy")
RuntimeType.s = CkJsonObject::ckStringOf(jResp,"RuntimeType")
RequiresUserInteraction.i = CkJsonObject::ckBoolOf(jResp,"RequiresUserInteraction")
ReleaseVersionId.s = CkJsonObject::ckStringOf(jResp,"ReleaseVersionId")
EntryPointPath.s = CkJsonObject::ckStringOf(jResp,"EntryPointPath")
OrganizationUnitId.i = CkJsonObject::ckIntOf(jResp,"OrganizationUnitId")
OrganizationUnitFullyQualifiedName.s = CkJsonObject::ckStringOf(jResp,"OrganizationUnitFullyQualifiedName")
Reference.s = CkJsonObject::ckStringOf(jResp,"Reference")
ProcessType.s = CkJsonObject::ckStringOf(jResp,"ProcessType")
Id.i = CkJsonObject::ckIntOf(jResp,"Id")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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 '{
"jobId": {{lastJobId}}
}'
https://domain.com/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.RestartJob
Postman Collection Item JSON
{
"name": "Restart Process",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 200\", function () {\r",
" pm.response.to.have.status(200);\r",
"});\r",
"\r",
"//set JobId key\r",
"var myResponse = pm.response.json();\r",
"pm.collectionVariables.set(\"jobId\", myResponse.Id);\r",
"console.log(pm.collectionVariables.get(\"jobId\"));\r",
""
],
"type": "text/javascript"
}
}
],
"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 \"jobId\": {{lastJobId}}\r\n}"
},
"url": {
"raw": "{{url}}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.RestartJob",
"host": [
"{{url}}"
],
"path": [
"orchestrator_",
"odata",
"Jobs",
"UiPath.Server.Configuration.OData.RestartJob"
]
}
},
"response": [
{
"name": "Restart Process",
"originalRequest": {
"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 \"jobId\": {{lastJobId}}\r\n}"
},
"url": {
"raw": "{{url}}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.RestartJob",
"host": [
"{{url}}"
],
"path": [
"orchestrator_",
"odata",
"Jobs",
"UiPath.Server.Configuration.OData.RestartJob"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 31 Mar 2021 12:55:07 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": "8abd67df-6582-4561-a41f-a96ecce1cd89"
},
{
"key": "OData-Version",
"value": "4.0"
},
{
"key": "api-supported-versions",
"value": "12.0"
},
{
"key": "CF-Cache-Status",
"value": "DYNAMIC"
},
{
"key": "cf-request-id",
"value": "0929f328050000cba0ef84b000000001"
},
{
"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": "6389baecd807cba0-VIE"
},
{
"key": "Content-Encoding",
"value": "br"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Jobs/$entity\",\n \"Key\": \"64eb533a-5b10-437f-8a16-c896419f1793\",\n \"StartTime\": null,\n \"EndTime\": null,\n \"State\": \"Pending\",\n \"JobPriority\": \"Normal\",\n \"Source\": \"Manual\",\n \"SourceType\": \"Manual\",\n \"BatchExecutionKey\": \"26918b13-2e8f-456f-85e1-f2d6a164427e\",\n \"Info\": null,\n \"CreationTime\": \"2021-03-31T12:55:07.273Z\",\n \"StartingScheduleId\": null,\n \"ReleaseName\": \"Add a pet to pet store by queue item\",\n \"Type\": \"Unattended\",\n \"InputArguments\": null,\n \"OutputArguments\": null,\n \"HostMachineName\": null,\n \"HasMediaRecorded\": false,\n \"PersistenceId\": null,\n \"ResumeVersion\": null,\n \"StopStrategy\": null,\n \"RuntimeType\": \"Unattended\",\n \"RequiresUserInteraction\": true,\n \"ReleaseVersionId\": null,\n \"EntryPointPath\": null,\n \"OrganizationUnitId\": 515128,\n \"OrganizationUnitFullyQualifiedName\": null,\n \"Reference\": \"\",\n \"ProcessType\": \"Process\",\n \"Id\": 12764707\n}"
}
]
}
