Save Actor Type Mapping
using RestSharp;
var options = new RestClientOptions("http://localhost:49843/api/v1/Agents/ErpSync/SaveActorTypeMapping");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"Mapping\": {\n \"ErpConnectionId\": 123,\n \"IsActive\": true,\n \"FieldMappings\": [\n {\n \"ErpFieldId\": 123,\n \"CrmFieldKey\": \"<string>\",\n \"CrmDisplayName\": \"<string>\",\n \"CrmDisplayTooltip\": \"<string>\",\n \"ErpFieldKey\": \"<string>\",\n \"ErpDisplayName\": \"<string>\",\n \"ErpDisplayTooltip\": \"<string>\",\n \"SyncToCrm\": true,\n \"SyncToErp\": true,\n \"ShowInGui\": true,\n \"ShowInSearch\": true,\n \"AlreadyMapped\": true,\n \"MissingInERP\": true,\n \"MissingInCRM\": true,\n \"ListReference\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\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({
Mapping: {
ErpConnectionId: 123,
IsActive: true,
FieldMappings: [
{
ErpFieldId: 123,
CrmFieldKey: '<string>',
CrmDisplayName: '<string>',
CrmDisplayTooltip: '<string>',
ErpFieldKey: '<string>',
ErpDisplayName: '<string>',
ErpDisplayTooltip: '<string>',
SyncToCrm: true,
SyncToErp: true,
ShowInGui: true,
ShowInSearch: true,
AlreadyMapped: true,
MissingInERP: true,
MissingInCRM: true,
ListReference: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:49843/api/v1/Agents/ErpSync/SaveActorTypeMapping', 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 => "49843",
CURLOPT_URL => "http://localhost:49843/api/v1/Agents/ErpSync/SaveActorTypeMapping",
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([
'Mapping' => [
'ErpConnectionId' => 123,
'IsActive' => true,
'FieldMappings' => [
[
'ErpFieldId' => 123,
'CrmFieldKey' => '<string>',
'CrmDisplayName' => '<string>',
'CrmDisplayTooltip' => '<string>',
'ErpFieldKey' => '<string>',
'ErpDisplayName' => '<string>',
'ErpDisplayTooltip' => '<string>',
'SyncToCrm' => true,
'SyncToErp' => true,
'ShowInGui' => true,
'ShowInSearch' => true,
'AlreadyMapped' => true,
'MissingInERP' => true,
'MissingInCRM' => true,
'ListReference' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'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:49843/api/v1/Agents/ErpSync/SaveActorTypeMapping"
payload = { "Mapping": {
"ErpConnectionId": 123,
"IsActive": True,
"FieldMappings": [
{
"ErpFieldId": 123,
"CrmFieldKey": "<string>",
"CrmDisplayName": "<string>",
"CrmDisplayTooltip": "<string>",
"ErpFieldKey": "<string>",
"ErpDisplayName": "<string>",
"ErpDisplayTooltip": "<string>",
"SyncToCrm": True,
"SyncToErp": True,
"ShowInGui": True,
"ShowInSearch": True,
"AlreadyMapped": True,
"MissingInERP": True,
"MissingInCRM": True,
"ListReference": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"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({
Mapping: {
ErpConnectionId: 123,
IsActive: true,
FieldMappings: [
{
ErpFieldId: 123,
CrmFieldKey: '<string>',
CrmDisplayName: '<string>',
CrmDisplayTooltip: '<string>',
ErpFieldKey: '<string>',
ErpDisplayName: '<string>',
ErpDisplayTooltip: '<string>',
SyncToCrm: true,
SyncToErp: true,
ShowInGui: true,
ShowInSearch: true,
AlreadyMapped: true,
MissingInERP: true,
MissingInCRM: true,
ListReference: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:49843/api/v1/Agents/ErpSync/SaveActorTypeMapping', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"ErpConnectionId": 123,
"IsActive": true,
"FieldMappings": [
{
"ErpFieldId": 123,
"CrmFieldKey": "<string>",
"CrmDisplayName": "<string>",
"CrmDisplayTooltip": "<string>",
"ErpFieldKey": "<string>",
"FieldType": "Checkbox",
"ErpDisplayName": "<string>",
"ErpDisplayTooltip": "<string>",
"SyncToCrm": true,
"SyncToErp": true,
"ShowInGui": true,
"ShowInSearch": true,
"AlreadyMapped": true,
"MissingInERP": true,
"MissingInCRM": true,
"Access": "Normal",
"ListReference": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"ActorTypeErp": "Unknown",
"ActorTypeCrm": "Unknown",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Save Actor Type Mapping
Save mappings for a connection/actor
NsApiSlow threshold: 5000 ms.
Save Actor Type Mapping
using RestSharp;
var options = new RestClientOptions("http://localhost:49843/api/v1/Agents/ErpSync/SaveActorTypeMapping");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"Mapping\": {\n \"ErpConnectionId\": 123,\n \"IsActive\": true,\n \"FieldMappings\": [\n {\n \"ErpFieldId\": 123,\n \"CrmFieldKey\": \"<string>\",\n \"CrmDisplayName\": \"<string>\",\n \"CrmDisplayTooltip\": \"<string>\",\n \"ErpFieldKey\": \"<string>\",\n \"ErpDisplayName\": \"<string>\",\n \"ErpDisplayTooltip\": \"<string>\",\n \"SyncToCrm\": true,\n \"SyncToErp\": true,\n \"ShowInGui\": true,\n \"ShowInSearch\": true,\n \"AlreadyMapped\": true,\n \"MissingInERP\": true,\n \"MissingInCRM\": true,\n \"ListReference\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\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({
Mapping: {
ErpConnectionId: 123,
IsActive: true,
FieldMappings: [
{
ErpFieldId: 123,
CrmFieldKey: '<string>',
CrmDisplayName: '<string>',
CrmDisplayTooltip: '<string>',
ErpFieldKey: '<string>',
ErpDisplayName: '<string>',
ErpDisplayTooltip: '<string>',
SyncToCrm: true,
SyncToErp: true,
ShowInGui: true,
ShowInSearch: true,
AlreadyMapped: true,
MissingInERP: true,
MissingInCRM: true,
ListReference: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:49843/api/v1/Agents/ErpSync/SaveActorTypeMapping', 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 => "49843",
CURLOPT_URL => "http://localhost:49843/api/v1/Agents/ErpSync/SaveActorTypeMapping",
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([
'Mapping' => [
'ErpConnectionId' => 123,
'IsActive' => true,
'FieldMappings' => [
[
'ErpFieldId' => 123,
'CrmFieldKey' => '<string>',
'CrmDisplayName' => '<string>',
'CrmDisplayTooltip' => '<string>',
'ErpFieldKey' => '<string>',
'ErpDisplayName' => '<string>',
'ErpDisplayTooltip' => '<string>',
'SyncToCrm' => true,
'SyncToErp' => true,
'ShowInGui' => true,
'ShowInSearch' => true,
'AlreadyMapped' => true,
'MissingInERP' => true,
'MissingInCRM' => true,
'ListReference' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'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:49843/api/v1/Agents/ErpSync/SaveActorTypeMapping"
payload = { "Mapping": {
"ErpConnectionId": 123,
"IsActive": True,
"FieldMappings": [
{
"ErpFieldId": 123,
"CrmFieldKey": "<string>",
"CrmDisplayName": "<string>",
"CrmDisplayTooltip": "<string>",
"ErpFieldKey": "<string>",
"ErpDisplayName": "<string>",
"ErpDisplayTooltip": "<string>",
"SyncToCrm": True,
"SyncToErp": True,
"ShowInGui": True,
"ShowInSearch": True,
"AlreadyMapped": True,
"MissingInERP": True,
"MissingInCRM": True,
"ListReference": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"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({
Mapping: {
ErpConnectionId: 123,
IsActive: true,
FieldMappings: [
{
ErpFieldId: 123,
CrmFieldKey: '<string>',
CrmDisplayName: '<string>',
CrmDisplayTooltip: '<string>',
ErpFieldKey: '<string>',
ErpDisplayName: '<string>',
ErpDisplayTooltip: '<string>',
SyncToCrm: true,
SyncToErp: true,
ShowInGui: true,
ShowInSearch: true,
AlreadyMapped: true,
MissingInERP: true,
MissingInCRM: true,
ListReference: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:49843/api/v1/Agents/ErpSync/SaveActorTypeMapping', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"ErpConnectionId": 123,
"IsActive": true,
"FieldMappings": [
{
"ErpFieldId": 123,
"CrmFieldKey": "<string>",
"CrmDisplayName": "<string>",
"CrmDisplayTooltip": "<string>",
"ErpFieldKey": "<string>",
"FieldType": "Checkbox",
"ErpDisplayName": "<string>",
"ErpDisplayTooltip": "<string>",
"SyncToCrm": true,
"SyncToErp": true,
"ShowInGui": true,
"ShowInSearch": true,
"AlreadyMapped": true,
"MissingInERP": true,
"MissingInCRM": true,
"Access": "Normal",
"ListReference": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"ActorTypeErp": "Unknown",
"ActorTypeCrm": "Unknown",
"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.
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
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/json-patch+jsonapplication/merge-patch+json
Mapping
SaveActorTypeMapping: Save mappings for a connection/actor
Mapping information for one Actor, contains array of field mappings (ERP <-> SuperOffice) Carrier object for ErpSyncActorTypeMapping. Services for the ErpSyncActorTypeMapping Carrier is available from the ErpSync Agent.
Show child attributes
Show child attributes
Response
OK
Mapping information for one Actor, contains array of field mappings (ERP <-> SuperOffice) Carrier object for ErpSyncActorTypeMapping. Services for the ErpSyncActorTypeMapping Carrier is available from the ErpSync Agent.
Primary key
Is this sync mapping active
Array of individual field mappings; explicitly map to empty CrmFieldKey to indicate non-sync
Show child attributes
Show child attributes
The actor type (ERP side)
Available options:
Unknown, Customer, Supplier, Partner, Person, Project, Employee, Sale The actor type (CRM side)
Available options:
Unknown, Contact, Person, Project, Sale 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