cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/external_databases/acmedb/update_records" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"table_name": "contacts",
"update_fields": [
{
"field_name": "company",
"field_value": "Acme Group"
}
],
"where_condition": {
"field_name": "company",
"operator": "=",
"field_value": "Acme Pty Ltd"
}
}'from exsited import build_client
client = build_client()
response = client.external_databases.update_external_database_update_records(
"acmedb",
{
"table_name": "contacts",
"update_fields": [{"field_name": "company", "field_value": "Acme Group"}],
"where_condition": {
"field_name": "company",
"operator": "=",
"field_value": "Acme Pty Ltd",
},
},
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.externalDatabases.updateExternalDatabaseUpdateRecords('acmedb', {
table_name: 'contacts',
update_fields: [{field_name: 'company', field_value: 'Acme Group'}],
where_condition: {field_name: 'company', operator: '=', field_value: 'Acme Pty Ltd'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->externalDatabases->updateExternalDatabaseUpdateRecords('acmedb', [
'table_name' => 'contacts',
'update_fields' => [['field_name' => 'company', 'field_value' => 'Acme Group']],
'where_condition' => [
'field_name' => 'company',
'operator' => '=',
'field_value' => 'Acme Pty Ltd',
],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.external_databases.external_databases_dto.ExternalDatabasesDto.ExternalDatabaseUpdateRecordsUpdated;
import java.util.List;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<ExternalDatabaseUpdateRecordsUpdated> response = client.externalDatabases().updateExternalDatabaseUpdateRecords(
"acmedb",
Map.of(
"table_name", "contacts",
"update_fields", List.of(
Map.of("field_name", "company", "field_value", "Acme Group")),
"where_condition", Map.of(
"field_name", "company",
"operator", "=",
"field_value", "Acme Pty Ltd")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.ExternalDatabases.UpdateExternalDatabaseUpdateRecordsAsync(
"acmedb",
new Dictionary<string, object?>
{
["table_name"] = "contacts",
["update_fields"] = new List<object?>
{
new Dictionary<string, object?>
{
["field_name"] = "company",
["field_value"] = "Acme Group",
},
},
["where_condition"] = new Dictionary<string, object?>
{
["field_name"] = "company",
["operator"] = "=",
["field_value"] = "Acme Pty Ltd",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.externalDatabases
.updateExternalDatabaseUpdateRecords('acmedb', {
'table_name': 'contacts',
'update_fields': [
{'field_name': 'company', 'field_value': 'Acme Group'},
],
'where_condition': {
'field_name': 'company',
'operator': '=',
'field_value': 'Acme Pty Ltd',
},
});
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.ExternalDatabases().UpdateExternalDatabaseUpdateRecords(context.Background(), "acmedb", map[string]any{
"table_name": "contacts",
"update_fields": []any{
map[string]any{
"field_name": "company",
"field_value": "Acme Group",
},
},
"where_condition": map[string]any{
"field_name": "company",
"operator": "=",
"field_value": "Acme Pty Ltd",
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"external_database": {
"message": "<string>"
}
}External databases
Update records in an external database table
Changes column values in the rows of a table that match a condition, and returns a message.
PATCH
/
external_databases
/
{db_name}
/
update_records
cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/external_databases/acmedb/update_records" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"table_name": "contacts",
"update_fields": [
{
"field_name": "company",
"field_value": "Acme Group"
}
],
"where_condition": {
"field_name": "company",
"operator": "=",
"field_value": "Acme Pty Ltd"
}
}'from exsited import build_client
client = build_client()
response = client.external_databases.update_external_database_update_records(
"acmedb",
{
"table_name": "contacts",
"update_fields": [{"field_name": "company", "field_value": "Acme Group"}],
"where_condition": {
"field_name": "company",
"operator": "=",
"field_value": "Acme Pty Ltd",
},
},
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.externalDatabases.updateExternalDatabaseUpdateRecords('acmedb', {
table_name: 'contacts',
update_fields: [{field_name: 'company', field_value: 'Acme Group'}],
where_condition: {field_name: 'company', operator: '=', field_value: 'Acme Pty Ltd'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->externalDatabases->updateExternalDatabaseUpdateRecords('acmedb', [
'table_name' => 'contacts',
'update_fields' => [['field_name' => 'company', 'field_value' => 'Acme Group']],
'where_condition' => [
'field_name' => 'company',
'operator' => '=',
'field_value' => 'Acme Pty Ltd',
],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.external_databases.external_databases_dto.ExternalDatabasesDto.ExternalDatabaseUpdateRecordsUpdated;
import java.util.List;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<ExternalDatabaseUpdateRecordsUpdated> response = client.externalDatabases().updateExternalDatabaseUpdateRecords(
"acmedb",
Map.of(
"table_name", "contacts",
"update_fields", List.of(
Map.of("field_name", "company", "field_value", "Acme Group")),
"where_condition", Map.of(
"field_name", "company",
"operator", "=",
"field_value", "Acme Pty Ltd")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.ExternalDatabases.UpdateExternalDatabaseUpdateRecordsAsync(
"acmedb",
new Dictionary<string, object?>
{
["table_name"] = "contacts",
["update_fields"] = new List<object?>
{
new Dictionary<string, object?>
{
["field_name"] = "company",
["field_value"] = "Acme Group",
},
},
["where_condition"] = new Dictionary<string, object?>
{
["field_name"] = "company",
["operator"] = "=",
["field_value"] = "Acme Pty Ltd",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.externalDatabases
.updateExternalDatabaseUpdateRecords('acmedb', {
'table_name': 'contacts',
'update_fields': [
{'field_name': 'company', 'field_value': 'Acme Group'},
],
'where_condition': {
'field_name': 'company',
'operator': '=',
'field_value': 'Acme Pty Ltd',
},
});
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.ExternalDatabases().UpdateExternalDatabaseUpdateRecords(context.Background(), "acmedb", map[string]any{
"table_name": "contacts",
"update_fields": []any{
map[string]any{
"field_name": "company",
"field_value": "Acme Group",
},
},
"where_condition": map[string]any{
"field_name": "company",
"operator": "=",
"field_value": "Acme Pty Ltd",
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"external_database": {
"message": "<string>"
}
}Send the
table_name, an update_fields array of field_name and field_value pairs, and a where_condition with a field_name, an operator such as = and a field_value, all at the top level of the body. The response holds a message under external_database.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Path Parameters
The database's name, as given when it is created, such as acmedb.
Body
application/json
Response
200 - application/json
The rows are changed; a message under external_database.
Show child attributes
Show child attributes