Retrieve an item group

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/item_groups/131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.settings.getSettingsItemGroup('131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d');
console.log(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;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsItemGroups> response = client.settings().getSettingsItemGroup("131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Settings.GetSettingsItemGroupAsync("131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d");

Console.WriteLine(response.Json);

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().GetSettingsItemGroup(context.Background(), "131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", nil, 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
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

GET

settings

item_groups

{item_group_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/item_groups/131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.settings.getSettingsItemGroup('131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d');
console.log(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;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsItemGroups> response = client.settings().getSettingsItemGroup("131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Settings.GetSettingsItemGroupAsync("131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d");

Console.WriteLine(response.Json);

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().GetSettingsItemGroup(context.Background(), "131b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", nil, 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
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Reads the item group with this id. The record includes its accounting_code and billing_preferences.

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.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

item_group_id

string

required

The item group's id, as a listing or a create returns it.

Response

The item group, under item_group.

item_group

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Response