Save Foreign App Entity
using RestSharp;
var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/ForeignSystem/SaveForeignAppEntity");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"ForeignAppId\": 123,\n \"Name\": \"<string>\",\n \"CreatedDate\": \"2023-11-07T05:31:56Z\",\n \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\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 \"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 \"Devices\": [\n {\n \"ForeignDeviceId\": 123,\n \"Name\": \"<string>\",\n \"CreatedDate\": \"2023-11-07T05:31:56Z\",\n \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\n \"AssociateFullName\": \"<string>\",\n \"CreatedBy\": \"<string>\",\n \"UpdatedBy\": \"<string>\",\n \"DeviceIdentifier\": \"<string>\",\n \"ForeignAppId\": 123,\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}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ForeignAppId: 123,
Name: '<string>',
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedDate: '2023-11-07T05:31:56Z',
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: {}
},
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: {}
},
Devices: [
{
ForeignDeviceId: 123,
Name: '<string>',
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedDate: '2023-11-07T05:31:56Z',
AssociateFullName: '<string>',
CreatedBy: '<string>',
UpdatedBy: '<string>',
DeviceIdentifier: '<string>',
ForeignAppId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
})
};
fetch('http://localhost:53294/api/v1/Agents/ForeignSystem/SaveForeignAppEntity', 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 => "53294",
CURLOPT_URL => "http://localhost:53294/api/v1/Agents/ForeignSystem/SaveForeignAppEntity",
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([
'ForeignAppId' => 123,
'Name' => '<string>',
'CreatedDate' => '2023-11-07T05:31:56Z',
'UpdatedDate' => '2023-11-07T05:31:56Z',
'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' => [
]
],
'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' => [
]
],
'Devices' => [
[
'ForeignDeviceId' => 123,
'Name' => '<string>',
'CreatedDate' => '2023-11-07T05:31:56Z',
'UpdatedDate' => '2023-11-07T05:31:56Z',
'AssociateFullName' => '<string>',
'CreatedBy' => '<string>',
'UpdatedBy' => '<string>',
'DeviceIdentifier' => '<string>',
'ForeignAppId' => 123,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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:53294/api/v1/Agents/ForeignSystem/SaveForeignAppEntity"
payload = {
"ForeignAppId": 123,
"Name": "<string>",
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedDate": "2023-11-07T05:31:56Z",
"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": {}
},
"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": {}
},
"Devices": [
{
"ForeignDeviceId": 123,
"Name": "<string>",
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedDate": "2023-11-07T05:31:56Z",
"AssociateFullName": "<string>",
"CreatedBy": "<string>",
"UpdatedBy": "<string>",
"DeviceIdentifier": "<string>",
"ForeignAppId": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ForeignAppId: 123,
Name: '<string>',
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedDate: '2023-11-07T05:31:56Z',
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: {}
},
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: {}
},
Devices: [
{
ForeignDeviceId: 123,
Name: '<string>',
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedDate: '2023-11-07T05:31:56Z',
AssociateFullName: '<string>',
CreatedBy: '<string>',
UpdatedBy: '<string>',
DeviceIdentifier: '<string>',
ForeignAppId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
})
};
fetch('http://localhost:53294/api/v1/Agents/ForeignSystem/SaveForeignAppEntity', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"ForeignAppId": 123,
"Name": "<string>",
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedDate": "2023-11-07T05:31:56Z",
"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": {}
},
"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": {}
},
"Devices": [
{
"ForeignDeviceId": 123,
"Name": "<string>",
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedDate": "2023-11-07T05:31:56Z",
"AssociateFullName": "<string>",
"CreatedBy": "<string>",
"UpdatedBy": "<string>",
"DeviceIdentifier": "<string>",
"ForeignAppId": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Save Foreign App Entity
Updates the existing ForeignAppEntity or creates a new ForeignAppEntity if the id parameter is 0.
NsApiSlow threshold: 5000 ms.
Save Foreign App Entity
using RestSharp;
var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/ForeignSystem/SaveForeignAppEntity");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"ForeignAppId\": 123,\n \"Name\": \"<string>\",\n \"CreatedDate\": \"2023-11-07T05:31:56Z\",\n \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\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 \"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 \"Devices\": [\n {\n \"ForeignDeviceId\": 123,\n \"Name\": \"<string>\",\n \"CreatedDate\": \"2023-11-07T05:31:56Z\",\n \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\n \"AssociateFullName\": \"<string>\",\n \"CreatedBy\": \"<string>\",\n \"UpdatedBy\": \"<string>\",\n \"DeviceIdentifier\": \"<string>\",\n \"ForeignAppId\": 123,\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}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ForeignAppId: 123,
Name: '<string>',
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedDate: '2023-11-07T05:31:56Z',
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: {}
},
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: {}
},
Devices: [
{
ForeignDeviceId: 123,
Name: '<string>',
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedDate: '2023-11-07T05:31:56Z',
AssociateFullName: '<string>',
CreatedBy: '<string>',
UpdatedBy: '<string>',
DeviceIdentifier: '<string>',
ForeignAppId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
})
};
fetch('http://localhost:53294/api/v1/Agents/ForeignSystem/SaveForeignAppEntity', 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 => "53294",
CURLOPT_URL => "http://localhost:53294/api/v1/Agents/ForeignSystem/SaveForeignAppEntity",
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([
'ForeignAppId' => 123,
'Name' => '<string>',
'CreatedDate' => '2023-11-07T05:31:56Z',
'UpdatedDate' => '2023-11-07T05:31:56Z',
'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' => [
]
],
'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' => [
]
],
'Devices' => [
[
'ForeignDeviceId' => 123,
'Name' => '<string>',
'CreatedDate' => '2023-11-07T05:31:56Z',
'UpdatedDate' => '2023-11-07T05:31:56Z',
'AssociateFullName' => '<string>',
'CreatedBy' => '<string>',
'UpdatedBy' => '<string>',
'DeviceIdentifier' => '<string>',
'ForeignAppId' => 123,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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:53294/api/v1/Agents/ForeignSystem/SaveForeignAppEntity"
payload = {
"ForeignAppId": 123,
"Name": "<string>",
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedDate": "2023-11-07T05:31:56Z",
"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": {}
},
"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": {}
},
"Devices": [
{
"ForeignDeviceId": 123,
"Name": "<string>",
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedDate": "2023-11-07T05:31:56Z",
"AssociateFullName": "<string>",
"CreatedBy": "<string>",
"UpdatedBy": "<string>",
"DeviceIdentifier": "<string>",
"ForeignAppId": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ForeignAppId: 123,
Name: '<string>',
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedDate: '2023-11-07T05:31:56Z',
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: {}
},
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: {}
},
Devices: [
{
ForeignDeviceId: 123,
Name: '<string>',
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedDate: '2023-11-07T05:31:56Z',
AssociateFullName: '<string>',
CreatedBy: '<string>',
UpdatedBy: '<string>',
DeviceIdentifier: '<string>',
ForeignAppId: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
})
};
fetch('http://localhost:53294/api/v1/Agents/ForeignSystem/SaveForeignAppEntity', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"ForeignAppId": 123,
"Name": "<string>",
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedDate": "2023-11-07T05:31:56Z",
"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": {}
},
"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": {}
},
"Devices": [
{
"ForeignDeviceId": 123,
"Name": "<string>",
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedDate": "2023-11-07T05:31:56Z",
"AssociateFullName": "<string>",
"CreatedBy": "<string>",
"UpdatedBy": "<string>",
"DeviceIdentifier": "<string>",
"ForeignAppId": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Authorizations
SuperOffice username:password are passed in Base64-encoded.
You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.
SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/
passing in the application id and redirect URL.
SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)
https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f
You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.
FlowImplicit
- Authorization URL
- https://online.superoffice.com/login/common/oauth/authorize
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 ForeignAppEntity that is saved
Carrier object for ForeignAppEntity. Services for the ForeignAppEntity Carrier is available from the ForeignSystem Agent.
Primary key
Name of foreign application
Registered when in UTC.
Last updated when in UTC.
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
The devices that belong to this foreign app.
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
Carrier object for ForeignAppEntity. Services for the ForeignAppEntity Carrier is available from the ForeignSystem Agent.
Primary key
Name of foreign application
Registered when in UTC.
Last updated when in UTC.
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
The devices that belong to this foreign app.
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