Update Batch Task

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/BatchTask/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\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}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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/BatchTask/{id}', 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/BatchTask/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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/BatchTask/{id}"

payload = {
    "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.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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/BatchTask/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>",
  "State": "Unknown",
  "Description": "<string>",
  "Response": "<string>",
  "Request": "<string>",
  "ProgressDescription": "<string>",
  "ProgressPercent": 123,
  "FileName": "<string>",
  "CancellationBehaviour": "CanCancel",
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Update Batch Task

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/BatchTask/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\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}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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/BatchTask/{id}', 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/BatchTask/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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/BatchTask/{id}"

payload = {
    "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.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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/BatchTask/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>",
  "State": "Unknown",
  "Description": "<string>",
  "Response": "<string>",
  "Request": "<string>",
  "ProgressDescription": "<string>",
  "ProgressPercent": 123,
  "FileName": "<string>",
  "CancellationBehaviour": "CanCancel",
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

string

required

Body

The updated information to save.

BatchTaskInfo contains information about one batch task. Carrier object for BatchTaskInfo. Services for the BatchTaskInfo Carrier is available from the Batch Agent.

integer<int32>

Id of the task.

Name

string

Name of the task.

AssociateId

integer<int32>

Task owner. If it is a System task, AssociateId = 0.

DetailsTable

integer<int32>

Id of table with more information about the task.

DetailsRecord

integer<int32>

Record Id of a row in the DetailsTable containing more info about the task.

IsSystemTask

boolean

If IsSystemTask is true, the task is not initiated by an associate.

IsInternalTask

boolean

If IsInternalTask is true, this task will not add a trace to the database.

ParameterObject

object

ParameterObject will be serialized to a binary blob and saved in the BinaryObject table. The link to the BinaryObject will be set using DetailsTable and DetailsRecord.

Show child attributes

LastStarted

string<date-time>

When was the task last started.

Created

string<date-time>

Task creation time.

StartCount

integer<int32>

Maps to the startcount field in the batchtask table.

DatabaseSerialNumber

string

Serial number of the database the task is to run on.

Context

string

Context for the executing task.

Result

string

Maps to the result field in the batchtask table.

State

enum<string>

BatchTaskState of the task.

Available options:

Unknown,

New,

Aquired,

Started,

Succeeded,

Failed,

SucceededManualCleanup,

All

Description

string

Description of the task.

Response

string

Maps to the response field in the batchtask table.

Request

string

Maps to the request field in the batchtask table.

ProgressDescription

string

Descriptive text for the current stage

ProgressPercent

integer<int32>

Task progress, in percent of estimated total

FileName

string

The filename related to the batchtask.

CancellationBehaviour

enum<string>

Indicate if the task can be stopped.

Available options:

CanCancel,

CancelWithWarning,

CannotCancel

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes

Response

BatchTaskInfo contains information about one batch task. Carrier object for BatchTaskInfo. Services for the BatchTaskInfo Carrier is available from the Batch Agent.

integer<int32>

Id of the task.

Name

string

Name of the task.

AssociateId

integer<int32>

Task owner. If it is a System task, AssociateId = 0.

DetailsTable

integer<int32>

Id of table with more information about the task.

DetailsRecord

integer<int32>

Record Id of a row in the DetailsTable containing more info about the task.

IsSystemTask

boolean

If IsSystemTask is true, the task is not initiated by an associate.

IsInternalTask

boolean

If IsInternalTask is true, this task will not add a trace to the database.

ParameterObject

object

ParameterObject will be serialized to a binary blob and saved in the BinaryObject table. The link to the BinaryObject will be set using DetailsTable and DetailsRecord.

Show child attributes

LastStarted

string<date-time>

When was the task last started.

Created

string<date-time>

Task creation time.

StartCount

integer<int32>

Maps to the startcount field in the batchtask table.

DatabaseSerialNumber

string

Serial number of the database the task is to run on.

Context

string

Context for the executing task.

Result

string

Maps to the result field in the batchtask table.

State

enum<string>

BatchTaskState of the task.

Available options:

Unknown,

New,

Aquired,

Started,

Succeeded,

Failed,

SucceededManualCleanup,

All

Description

string

Description of the task.

Response

string

Maps to the response field in the batchtask table.

Request

string

Maps to the request field in the batchtask table.

ProgressDescription

string

Descriptive text for the current stage

ProgressPercent

integer<int32>

Task progress, in percent of estimated total

FileName

string

The filename related to the batchtask.

CancellationBehaviour

enum<string>

Indicate if the task can be stopped.

Available options:

CanCancel,

CancelWithWarning,

CannotCancel

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes