Save Configurable Screen Delta
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Configuration/SaveConfigurableScreenDelta");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"ConfigurableScreenDeltaId\": 123,\n \"Name\": \"<string>\",\n \"Description\": \"<string>\",\n \"DeltaJson\": \"<string>\",\n \"RecipeId\": \"<string>\",\n \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\n \"CreatedDate\": \"2023-11-07T05:31:56Z\",\n \"UpdatedBy\": {\n \"AssociateId\": 123,\n \"Name\": \"<string>\",\n \"PersonId\": 123,\n \"Rank\": 123,\n \"Tooltip\": \"<string>\",\n \"GroupIdx\": 123,\n \"FullName\": \"<string>\",\n \"FormalName\": \"<string>\",\n \"Deleted\": true,\n \"EjUserId\": 123,\n \"UserName\": \"<string>\",\n \"ExtraFields\": {},\n \"CustomFields\": {},\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"CreatedBy\": {\n \"AssociateId\": 123,\n \"Name\": \"<string>\",\n \"PersonId\": 123,\n \"Rank\": 123,\n \"Tooltip\": \"<string>\",\n \"GroupIdx\": 123,\n \"FullName\": \"<string>\",\n \"FormalName\": \"<string>\",\n \"Deleted\": true,\n \"EjUserId\": 123,\n \"UserName\": \"<string>\",\n \"ExtraFields\": {},\n \"CustomFields\": {},\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"AppliesToIds\": [\n 123\n ],\n \"AppliesToKey\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\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({
ConfigurableScreenDeltaId: 123,
Name: '<string>',
Description: '<string>',
DeltaJson: '<string>',
RecipeId: '<string>',
UpdatedDate: '2023-11-07T05:31:56Z',
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedBy: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
CreatedBy: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
AppliesToIds: [123],
AppliesToKey: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
})
};
fetch('http://localhost:56350/api/v1/Agents/Configuration/SaveConfigurableScreenDelta', 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/Configuration/SaveConfigurableScreenDelta",
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([
'ConfigurableScreenDeltaId' => 123,
'Name' => '<string>',
'Description' => '<string>',
'DeltaJson' => '<string>',
'RecipeId' => '<string>',
'UpdatedDate' => '2023-11-07T05:31:56Z',
'CreatedDate' => '2023-11-07T05:31:56Z',
'UpdatedBy' => [
'AssociateId' => 123,
'Name' => '<string>',
'PersonId' => 123,
'Rank' => 123,
'Tooltip' => '<string>',
'GroupIdx' => 123,
'FullName' => '<string>',
'FormalName' => '<string>',
'Deleted' => true,
'EjUserId' => 123,
'UserName' => '<string>',
'ExtraFields' => [
],
'CustomFields' => [
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'CreatedBy' => [
'AssociateId' => 123,
'Name' => '<string>',
'PersonId' => 123,
'Rank' => 123,
'Tooltip' => '<string>',
'GroupIdx' => 123,
'FullName' => '<string>',
'FormalName' => '<string>',
'Deleted' => true,
'EjUserId' => 123,
'UserName' => '<string>',
'ExtraFields' => [
],
'CustomFields' => [
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'AppliesToIds' => [
123
],
'AppliesToKey' => '<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/Configuration/SaveConfigurableScreenDelta"
payload = {
"ConfigurableScreenDeltaId": 123,
"Name": "<string>",
"Description": "<string>",
"DeltaJson": "<string>",
"RecipeId": "<string>",
"UpdatedDate": "2023-11-07T05:31:56Z",
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": True,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"CreatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": True,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"AppliesToIds": [123],
"AppliesToKey": "<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({
ConfigurableScreenDeltaId: 123,
Name: '<string>',
Description: '<string>',
DeltaJson: '<string>',
RecipeId: '<string>',
UpdatedDate: '2023-11-07T05:31:56Z',
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedBy: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
CreatedBy: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
AppliesToIds: [123],
AppliesToKey: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
})
};
fetch('http://localhost:56350/api/v1/Agents/Configuration/SaveConfigurableScreenDelta', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"ConfigurableScreenDeltaId": 123,
"Name": "<string>",
"Description": "<string>",
"DeltaJson": "<string>",
"DeltaType": "Unknown",
"DeltaState": "Unknown",
"RecipeId": "<string>",
"UpdatedDate": "2023-11-07T05:31:56Z",
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"Type": "Unknown",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": true,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"CreatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"Type": "Unknown",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": true,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"AppliesToIds": [
123
],
"AppliesToKey": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Save Configurable Screen Delta
Updates the existing ConfigurableScreenDelta or creates a new ConfigurableScreenDelta if the id parameter is 0.
NsApiSlow threshold: 5000 ms.
Save Configurable Screen Delta
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Configuration/SaveConfigurableScreenDelta");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"ConfigurableScreenDeltaId\": 123,\n \"Name\": \"<string>\",\n \"Description\": \"<string>\",\n \"DeltaJson\": \"<string>\",\n \"RecipeId\": \"<string>\",\n \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\n \"CreatedDate\": \"2023-11-07T05:31:56Z\",\n \"UpdatedBy\": {\n \"AssociateId\": 123,\n \"Name\": \"<string>\",\n \"PersonId\": 123,\n \"Rank\": 123,\n \"Tooltip\": \"<string>\",\n \"GroupIdx\": 123,\n \"FullName\": \"<string>\",\n \"FormalName\": \"<string>\",\n \"Deleted\": true,\n \"EjUserId\": 123,\n \"UserName\": \"<string>\",\n \"ExtraFields\": {},\n \"CustomFields\": {},\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"CreatedBy\": {\n \"AssociateId\": 123,\n \"Name\": \"<string>\",\n \"PersonId\": 123,\n \"Rank\": 123,\n \"Tooltip\": \"<string>\",\n \"GroupIdx\": 123,\n \"FullName\": \"<string>\",\n \"FormalName\": \"<string>\",\n \"Deleted\": true,\n \"EjUserId\": 123,\n \"UserName\": \"<string>\",\n \"ExtraFields\": {},\n \"CustomFields\": {},\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"AppliesToIds\": [\n 123\n ],\n \"AppliesToKey\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\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({
ConfigurableScreenDeltaId: 123,
Name: '<string>',
Description: '<string>',
DeltaJson: '<string>',
RecipeId: '<string>',
UpdatedDate: '2023-11-07T05:31:56Z',
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedBy: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
CreatedBy: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
AppliesToIds: [123],
AppliesToKey: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
})
};
fetch('http://localhost:56350/api/v1/Agents/Configuration/SaveConfigurableScreenDelta', 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/Configuration/SaveConfigurableScreenDelta",
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([
'ConfigurableScreenDeltaId' => 123,
'Name' => '<string>',
'Description' => '<string>',
'DeltaJson' => '<string>',
'RecipeId' => '<string>',
'UpdatedDate' => '2023-11-07T05:31:56Z',
'CreatedDate' => '2023-11-07T05:31:56Z',
'UpdatedBy' => [
'AssociateId' => 123,
'Name' => '<string>',
'PersonId' => 123,
'Rank' => 123,
'Tooltip' => '<string>',
'GroupIdx' => 123,
'FullName' => '<string>',
'FormalName' => '<string>',
'Deleted' => true,
'EjUserId' => 123,
'UserName' => '<string>',
'ExtraFields' => [
],
'CustomFields' => [
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'CreatedBy' => [
'AssociateId' => 123,
'Name' => '<string>',
'PersonId' => 123,
'Rank' => 123,
'Tooltip' => '<string>',
'GroupIdx' => 123,
'FullName' => '<string>',
'FormalName' => '<string>',
'Deleted' => true,
'EjUserId' => 123,
'UserName' => '<string>',
'ExtraFields' => [
],
'CustomFields' => [
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'AppliesToIds' => [
123
],
'AppliesToKey' => '<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/Configuration/SaveConfigurableScreenDelta"
payload = {
"ConfigurableScreenDeltaId": 123,
"Name": "<string>",
"Description": "<string>",
"DeltaJson": "<string>",
"RecipeId": "<string>",
"UpdatedDate": "2023-11-07T05:31:56Z",
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": True,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"CreatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": True,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"AppliesToIds": [123],
"AppliesToKey": "<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({
ConfigurableScreenDeltaId: 123,
Name: '<string>',
Description: '<string>',
DeltaJson: '<string>',
RecipeId: '<string>',
UpdatedDate: '2023-11-07T05:31:56Z',
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedBy: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
CreatedBy: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
AppliesToIds: [123],
AppliesToKey: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
})
};
fetch('http://localhost:56350/api/v1/Agents/Configuration/SaveConfigurableScreenDelta', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"ConfigurableScreenDeltaId": 123,
"Name": "<string>",
"Description": "<string>",
"DeltaJson": "<string>",
"DeltaType": "Unknown",
"DeltaState": "Unknown",
"RecipeId": "<string>",
"UpdatedDate": "2023-11-07T05:31:56Z",
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"Type": "Unknown",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": true,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"CreatedBy": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"Type": "Unknown",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": true,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"AppliesToIds": [
123
],
"AppliesToKey": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Headers
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.
Body
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/json-patch+jsonapplication/merge-patch+json
The ConfigurableScreenDelta that is saved
Available options:
Unknown, System, WebPanel, CustomFields, Customized, CustomObjectArchivePanel Available options:
Unknown, Draft, Published Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Show child attributes
Show child attributes
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Show child attributes
Show child attributes
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Show child attributes
Show child attributes
Field property dictionary mapping field names to field access rights.
Show child attributes
Show child attributes
Response
OK
Available options:
Unknown, System, WebPanel, CustomFields, Customized, CustomObjectArchivePanel Available options:
Unknown, Draft, Published Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Show child attributes
Show child attributes
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Show child attributes
Show child attributes
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Show child attributes
Show child attributes
Field property dictionary mapping field names to field access rights.
Show child attributes
Show child attributes
Related topics
Get Configurable Screen Deltas By DeltaDelete Configurable Screen DeltaGet Configurable Screen DeltaConfigurableScreenDelta tableCreate Default Configurable Screen DeltaGet Configurable Screen Deltas By Query⌘I