Perl / Orchestrator / Jobs - Stop Job
Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "strategy": "2"
# }
$json = chilkat::CkJsonObject->new();
$json->UpdateString("strategy","2");
$http->SetRequestHeader("Content-Type","application/json");
# Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken("<access_token>");
$http->SetRequestHeader("X-UIPATH-OrganizationUnitId","{{folderId}}");
$http->SetRequestHeader("X-UIPATH-TenantName","{{tenantName}}");
# resp is a HttpResponse
$resp = $http->PostJson3("https://domain.com/odata/Jobs(/:jobId)/UiPath.Server.Configuration.OData.StopJob","application/json",$json);
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# 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
$odata_context = $jResp->stringOf('\'@odata.context\'');
$i = 0;
$count_i = $jResp->SizeOfArray("value");
while ($i < $count_i) {
$jResp->put_I($i);
$Key = $jResp->stringOf("value[i].Key");
$StartTime = $jResp->stringOf("value[i].StartTime");
$EndTime = $jResp->stringOf("value[i].EndTime");
$State = $jResp->stringOf("value[i].State");
$Source = $jResp->stringOf("value[i].Source");
$SourceType = $jResp->stringOf("value[i].SourceType");
$BatchExecutionKey = $jResp->stringOf("value[i].BatchExecutionKey");
$Info = $jResp->stringOf("value[i].Info");
$CreationTime = $jResp->stringOf("value[i].CreationTime");
$StartingScheduleId = $jResp->stringOf("value[i].StartingScheduleId");
$ReleaseName = $jResp->stringOf("value[i].ReleaseName");
$v_Type = $jResp->stringOf("value[i].Type");
$InputArguments = $jResp->stringOf("value[i].InputArguments");
$OutputArguments = $jResp->stringOf("value[i].OutputArguments");
$Id = $jResp->IntOf("value[i].Id");
$i = $i + 1;
}
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 '{
"strategy": "2"
}'
https://domain.com/odata/Jobs(/:jobId)/UiPath.Server.Configuration.OData.StopJob
Postman Collection Item JSON
{
"name": "Jobs - Stop Job",
"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\t\"strategy\": \"2\"\r\n}"
},
"url": {
"raw": "{{url}}/odata/Jobs(/:jobId)/UiPath.Server.Configuration.OData.StopJob",
"host": [
"{{url}}"
],
"path": [
"odata",
"Jobs(",
":jobId)",
"UiPath.Server.Configuration.OData.StopJob"
],
"variable": [
{
"key": "jobId)",
"value": "",
"type": "string"
}
]
},
"description": "Stops a running job.\n\nThe *jobId* path parameter is retrieved from the **Jobs - Start Job** or **Jobs - Get** calls.\nThe *strategy* body parameter may have a value of either 1 (meaning Soft Stop) or 2 (meaning Kill)."
},
"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}"
}
]
}
