cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/item_groups/131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"item_group": {
"display_name": "Hardware",
"description": "Tools and fittings"
}
}'from exsited import build_client
client = build_client()
response = client.settings.update_settings_item_group(
"131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
{"item_group": {"display_name": "Hardware", "description": "Tools and fittings"}},
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.settings.updateSettingsItemGroup('131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
item_group: {display_name: 'Hardware', description: 'Tools and fittings'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->settings->updateSettingsItemGroup('131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', [
'item_group' => ['display_name' => 'Hardware', 'description' => 'Tools and fittings'],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.settings.settings_dto.SettingsDto.SettingsItemGroups;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<SettingsItemGroups> response = client.settings().updateSettingsItemGroup(
"131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
Map.of(
"item_group", Map.of(
"display_name", "Hardware",
"description", "Tools and fittings")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Settings.UpdateSettingsItemGroupAsync(
"131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
new Dictionary<string, object?>
{
["item_group"] = new Dictionary<string, object?>
{
["display_name"] = "Hardware",
["description"] = "Tools and fittings",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.settings.updateSettingsItemGroup(
'131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
{
'item_group': {
'display_name': 'Hardware',
'description': 'Tools and fittings',
},
},
);
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.Settings().UpdateSettingsItemGroup(context.Background(), "131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
"item_group": map[string]any{
"display_name": "Hardware",
"description": "Tools and fittings",
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"item_group": {
"accounting_code": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"billing_preferences": {},
"code": "<string>",
"created_by": "<string>",
"created_on": "<string>",
"custom_attributes": "<array>",
"description": "<string>",
"display_name": "<string>",
"href": "<string>",
"id": "<string>",
"image_uri": "<string>",
"last_updated_by": "<string>",
"last_updated_on": "<string>",
"manager": "<string>",
"name": "<string>",
"object": "<string>",
"status": "<string>",
"uuid": "<string>",
"version": 123
}
}Instance settings
Update an item group
Changes the fields you send on an item group and returns it under item_group.
PATCH
/
settings
/
item_groups
/
{item_group_id}
cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/item_groups/131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"item_group": {
"display_name": "Hardware",
"description": "Tools and fittings"
}
}'from exsited import build_client
client = build_client()
response = client.settings.update_settings_item_group(
"131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
{"item_group": {"display_name": "Hardware", "description": "Tools and fittings"}},
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.settings.updateSettingsItemGroup('131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
item_group: {display_name: 'Hardware', description: 'Tools and fittings'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->settings->updateSettingsItemGroup('131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', [
'item_group' => ['display_name' => 'Hardware', 'description' => 'Tools and fittings'],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.settings.settings_dto.SettingsDto.SettingsItemGroups;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<SettingsItemGroups> response = client.settings().updateSettingsItemGroup(
"131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
Map.of(
"item_group", Map.of(
"display_name", "Hardware",
"description", "Tools and fittings")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Settings.UpdateSettingsItemGroupAsync(
"131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
new Dictionary<string, object?>
{
["item_group"] = new Dictionary<string, object?>
{
["display_name"] = "Hardware",
["description"] = "Tools and fittings",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.settings.updateSettingsItemGroup(
'131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
{
'item_group': {
'display_name': 'Hardware',
'description': 'Tools and fittings',
},
},
);
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.Settings().UpdateSettingsItemGroup(context.Background(), "131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
"item_group": map[string]any{
"display_name": "Hardware",
"description": "Tools and fittings",
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"item_group": {
"accounting_code": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"billing_preferences": {},
"code": "<string>",
"created_by": "<string>",
"created_on": "<string>",
"custom_attributes": "<array>",
"description": "<string>",
"display_name": "<string>",
"href": "<string>",
"id": "<string>",
"image_uri": "<string>",
"last_updated_by": "<string>",
"last_updated_on": "<string>",
"manager": "<string>",
"name": "<string>",
"object": "<string>",
"status": "<string>",
"uuid": "<string>",
"version": 123
}
}Send the fields to change under
item_group, such as display_name and description.
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 item group's id, as a listing or a create returns it.
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
The updated item group, under item_group.
Show child attributes
Show child attributes