using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Batch/StartBatchJob");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"BatchTaskInfo\": {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"AssociateId\": 123,\n \"DetailsTable\": 123,\n \"DetailsRecord\": 123,\n \"IsSystemTask\": true,\n \"IsInternalTask\": true,\n \"ParameterObject\": {},\n \"LastStarted\": \"2023-11-07T05:31:56Z\",\n \"Created\": \"2023-11-07T05:31:56Z\",\n \"StartCount\": 123,\n \"DatabaseSerialNumber\": \"<string>\",\n \"Context\": \"<string>\",\n \"Result\": \"<string>\",\n \"Description\": \"<string>\",\n \"Response\": \"<string>\",\n \"Request\": \"<string>\",\n \"ProgressDescription\": \"<string>\",\n \"ProgressPercent\": 123,\n \"FileName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
BatchTaskInfo: {
Id: 123,
Name: '<string>',
AssociateId: 123,
DetailsTable: 123,
DetailsRecord: 123,
IsSystemTask: true,
IsInternalTask: true,
ParameterObject: {},
LastStarted: '2023-11-07T05:31:56Z',
Created: '2023-11-07T05:31:56Z',
StartCount: 123,
DatabaseSerialNumber: '<string>',
Context: '<string>',
Result: '<string>',
Description: '<string>',
Response: '<string>',
Request: '<string>',
ProgressDescription: '<string>',
ProgressPercent: 123,
FileName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Batch/StartBatchJob', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Batch/StartBatchJob",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'BatchTaskInfo' => [
'Id' => 123,
'Name' => '<string>',
'AssociateId' => 123,
'DetailsTable' => 123,
'DetailsRecord' => 123,
'IsSystemTask' => true,
'IsInternalTask' => true,
'ParameterObject' => [
],
'LastStarted' => '2023-11-07T05:31:56Z',
'Created' => '2023-11-07T05:31:56Z',
'StartCount' => 123,
'DatabaseSerialNumber' => '<string>',
'Context' => '<string>',
'Result' => '<string>',
'Description' => '<string>',
'Response' => '<string>',
'Request' => '<string>',
'ProgressDescription' => '<string>',
'ProgressPercent' => 123,
'FileName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/Batch/StartBatchJob"
payload = { "BatchTaskInfo": {
"Id": 123,
"Name": "<string>",
"AssociateId": 123,
"DetailsTable": 123,
"DetailsRecord": 123,
"IsSystemTask": True,
"IsInternalTask": True,
"ParameterObject": {},
"LastStarted": "2023-11-07T05:31:56Z",
"Created": "2023-11-07T05:31:56Z",
"StartCount": 123,
"DatabaseSerialNumber": "<string>",
"Context": "<string>",
"Result": "<string>",
"Description": "<string>",
"Response": "<string>",
"Request": "<string>",
"ProgressDescription": "<string>",
"ProgressPercent": 123,
"FileName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
BatchTaskInfo: {
Id: 123,
Name: '<string>',
AssociateId: 123,
DetailsTable: 123,
DetailsRecord: 123,
IsSystemTask: true,
IsInternalTask: true,
ParameterObject: {},
LastStarted: '2023-11-07T05:31:56Z',
Created: '2023-11-07T05:31:56Z',
StartCount: 123,
DatabaseSerialNumber: '<string>',
Context: '<string>',
Result: '<string>',
Description: '<string>',
Response: '<string>',
Request: '<string>',
ProgressDescription: '<string>',
ProgressPercent: 123,
FileName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Batch/StartBatchJob', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));123Start a batch job based on BatchTaskInfo.
NsApiSlow threshold: 3000 ms.
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Batch/StartBatchJob");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"BatchTaskInfo\": {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"AssociateId\": 123,\n \"DetailsTable\": 123,\n \"DetailsRecord\": 123,\n \"IsSystemTask\": true,\n \"IsInternalTask\": true,\n \"ParameterObject\": {},\n \"LastStarted\": \"2023-11-07T05:31:56Z\",\n \"Created\": \"2023-11-07T05:31:56Z\",\n \"StartCount\": 123,\n \"DatabaseSerialNumber\": \"<string>\",\n \"Context\": \"<string>\",\n \"Result\": \"<string>\",\n \"Description\": \"<string>\",\n \"Response\": \"<string>\",\n \"Request\": \"<string>\",\n \"ProgressDescription\": \"<string>\",\n \"ProgressPercent\": 123,\n \"FileName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
BatchTaskInfo: {
Id: 123,
Name: '<string>',
AssociateId: 123,
DetailsTable: 123,
DetailsRecord: 123,
IsSystemTask: true,
IsInternalTask: true,
ParameterObject: {},
LastStarted: '2023-11-07T05:31:56Z',
Created: '2023-11-07T05:31:56Z',
StartCount: 123,
DatabaseSerialNumber: '<string>',
Context: '<string>',
Result: '<string>',
Description: '<string>',
Response: '<string>',
Request: '<string>',
ProgressDescription: '<string>',
ProgressPercent: 123,
FileName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Batch/StartBatchJob', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Batch/StartBatchJob",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'BatchTaskInfo' => [
'Id' => 123,
'Name' => '<string>',
'AssociateId' => 123,
'DetailsTable' => 123,
'DetailsRecord' => 123,
'IsSystemTask' => true,
'IsInternalTask' => true,
'ParameterObject' => [
],
'LastStarted' => '2023-11-07T05:31:56Z',
'Created' => '2023-11-07T05:31:56Z',
'StartCount' => 123,
'DatabaseSerialNumber' => '<string>',
'Context' => '<string>',
'Result' => '<string>',
'Description' => '<string>',
'Response' => '<string>',
'Request' => '<string>',
'ProgressDescription' => '<string>',
'ProgressPercent' => 123,
'FileName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/Batch/StartBatchJob"
payload = { "BatchTaskInfo": {
"Id": 123,
"Name": "<string>",
"AssociateId": 123,
"DetailsTable": 123,
"DetailsRecord": 123,
"IsSystemTask": True,
"IsInternalTask": True,
"ParameterObject": {},
"LastStarted": "2023-11-07T05:31:56Z",
"Created": "2023-11-07T05:31:56Z",
"StartCount": 123,
"DatabaseSerialNumber": "<string>",
"Context": "<string>",
"Result": "<string>",
"Description": "<string>",
"Response": "<string>",
"Request": "<string>",
"ProgressDescription": "<string>",
"ProgressPercent": 123,
"FileName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
BatchTaskInfo: {
Id: 123,
Name: '<string>',
AssociateId: 123,
DetailsTable: 123,
DetailsRecord: 123,
IsSystemTask: true,
IsInternalTask: true,
ParameterObject: {},
LastStarted: '2023-11-07T05:31:56Z',
Created: '2023-11-07T05:31:56Z',
StartCount: 123,
DatabaseSerialNumber: '<string>',
Context: '<string>',
Result: '<string>',
Description: '<string>',
Response: '<string>',
Request: '<string>',
ProgressDescription: '<string>',
ProgressPercent: 123,
FileName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Batch/StartBatchJob', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));123Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
BatchTaskInfo
StartBatchJob: Start a batch job based on BatchTaskInfo.
BatchTaskInfo contains information about one batch task. Carrier object for BatchTaskInfo. Services for the BatchTaskInfo Carrier is available from the Batch Agent.
Show child attributes
Show child attributes
Response
OK
The response is of type integer<int32>.