using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/ForeignSystem/DeleteForeignKey");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"ForeignKey\": {\n \"Key\": \"<string>\",\n \"Value\": \"<string>\",\n \"RecordId\": 123,\n \"CreatedDate\": \"2023-11-07T05:31:56Z\",\n \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\n \"UpdatedBy\": \"<string>\",\n \"CreatedBy\": \"<string>\",\n \"TableName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"ApplicationName\": \"<string>\",\n \"DeviceName\": \"<string>\",\n \"DeviceIdentifier\": \"<string>\",\n \"TableName\": \"<string>\",\n \"RecordId\": 123\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({
ForeignKey: {
Key: '<string>',
Value: '<string>',
RecordId: 123,
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedDate: '2023-11-07T05:31:56Z',
UpdatedBy: '<string>',
CreatedBy: '<string>',
TableName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
ApplicationName: '<string>',
DeviceName: '<string>',
DeviceIdentifier: '<string>',
TableName: '<string>',
RecordId: 123
})
};
fetch('http://localhost:56350/api/v1/Agents/ForeignSystem/DeleteForeignKey', 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/ForeignSystem/DeleteForeignKey",
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([
'ForeignKey' => [
'Key' => '<string>',
'Value' => '<string>',
'RecordId' => 123,
'CreatedDate' => '2023-11-07T05:31:56Z',
'UpdatedDate' => '2023-11-07T05:31:56Z',
'UpdatedBy' => '<string>',
'CreatedBy' => '<string>',
'TableName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'ApplicationName' => '<string>',
'DeviceName' => '<string>',
'DeviceIdentifier' => '<string>',
'TableName' => '<string>',
'RecordId' => 123
]),
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/ForeignSystem/DeleteForeignKey"
payload = {
"ForeignKey": {
"Key": "<string>",
"Value": "<string>",
"RecordId": 123,
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedDate": "2023-11-07T05:31:56Z",
"UpdatedBy": "<string>",
"CreatedBy": "<string>",
"TableName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"ApplicationName": "<string>",
"DeviceName": "<string>",
"DeviceIdentifier": "<string>",
"TableName": "<string>",
"RecordId": 123
}
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({
ForeignKey: {
Key: '<string>',
Value: '<string>',
RecordId: 123,
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedDate: '2023-11-07T05:31:56Z',
UpdatedBy: '<string>',
CreatedBy: '<string>',
TableName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
ApplicationName: '<string>',
DeviceName: '<string>',
DeviceIdentifier: '<string>',
TableName: '<string>',
RecordId: 123
})
};
fetch('http://localhost:56350/api/v1/Agents/ForeignSystem/DeleteForeignKey', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Delete Foreign Key
Deletes all specified occurrences of a key, belonging to the ForeignApp and ForeignDevice, table and record specified.
Specifying a blank table name will delete ALL keys of the given name; specifying a recordId of 0 will delete ALL keys of the given name for the given table. NsApiSlow threshold: 5000 ms.
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/ForeignSystem/DeleteForeignKey");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"ForeignKey\": {\n \"Key\": \"<string>\",\n \"Value\": \"<string>\",\n \"RecordId\": 123,\n \"CreatedDate\": \"2023-11-07T05:31:56Z\",\n \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\n \"UpdatedBy\": \"<string>\",\n \"CreatedBy\": \"<string>\",\n \"TableName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"ApplicationName\": \"<string>\",\n \"DeviceName\": \"<string>\",\n \"DeviceIdentifier\": \"<string>\",\n \"TableName\": \"<string>\",\n \"RecordId\": 123\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({
ForeignKey: {
Key: '<string>',
Value: '<string>',
RecordId: 123,
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedDate: '2023-11-07T05:31:56Z',
UpdatedBy: '<string>',
CreatedBy: '<string>',
TableName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
ApplicationName: '<string>',
DeviceName: '<string>',
DeviceIdentifier: '<string>',
TableName: '<string>',
RecordId: 123
})
};
fetch('http://localhost:56350/api/v1/Agents/ForeignSystem/DeleteForeignKey', 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/ForeignSystem/DeleteForeignKey",
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([
'ForeignKey' => [
'Key' => '<string>',
'Value' => '<string>',
'RecordId' => 123,
'CreatedDate' => '2023-11-07T05:31:56Z',
'UpdatedDate' => '2023-11-07T05:31:56Z',
'UpdatedBy' => '<string>',
'CreatedBy' => '<string>',
'TableName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'ApplicationName' => '<string>',
'DeviceName' => '<string>',
'DeviceIdentifier' => '<string>',
'TableName' => '<string>',
'RecordId' => 123
]),
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/ForeignSystem/DeleteForeignKey"
payload = {
"ForeignKey": {
"Key": "<string>",
"Value": "<string>",
"RecordId": 123,
"CreatedDate": "2023-11-07T05:31:56Z",
"UpdatedDate": "2023-11-07T05:31:56Z",
"UpdatedBy": "<string>",
"CreatedBy": "<string>",
"TableName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"ApplicationName": "<string>",
"DeviceName": "<string>",
"DeviceIdentifier": "<string>",
"TableName": "<string>",
"RecordId": 123
}
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({
ForeignKey: {
Key: '<string>',
Value: '<string>',
RecordId: 123,
CreatedDate: '2023-11-07T05:31:56Z',
UpdatedDate: '2023-11-07T05:31:56Z',
UpdatedBy: '<string>',
CreatedBy: '<string>',
TableName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
ApplicationName: '<string>',
DeviceName: '<string>',
DeviceIdentifier: '<string>',
TableName: '<string>',
RecordId: 123
})
};
fetch('http://localhost:56350/api/v1/Agents/ForeignSystem/DeleteForeignKey', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Headers
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
ForeignKey, ApplicationName, DeviceName, DeviceIdentifier, TableName, RecordId
DeleteForeignKey: Deletes all specified occurrences of a key, belonging to the ForeignApp and ForeignDevice, table and record specified. Specifying a blank table name will delete ALL keys of the given name; specifying a recordId of 0 will delete ALL keys of the given name for the given table.
Response
No Content
Related topics
Delete Foreign Key On NameNSForeignSystemAgentDelete Foreign DeviceForeign keysDelete Foreign App Entity