Create a custom object instance on a component object

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/components/cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d/objects/a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e/custom_objects/co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "custom_object_instances": {
      "attributes": []
    }
  }'

from exsited import build_client

client = build_client()

response = client.custom_components.create_component_object_custom_object_instance(
    "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    "co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f",
    {"custom_object_instances": {"attributes": []}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customComponents.createComponentObjectCustomObjectInstance(
    'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    'co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f',
    {custom_object_instances: {attributes: []}},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customComponents->createComponentObjectCustomObjectInstance(
    'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    'co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f',
    ['custom_object_instances' => ['attributes' => []]],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.List;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.customComponents().createComponentObjectCustomObjectInstance(
        "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
        "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
        "co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f",
        Map.of("custom_object_instances", Map.of("attributes", List.of())));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomComponents.CreateComponentObjectCustomObjectInstanceAsync(
    "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    "co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f",
    new Dictionary<string, object?>
    {
        ["custom_object_instances"] = new Dictionary<string, object?>
        {
            ["attributes"] = new List<object?>(),
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customComponents
    .createComponentObjectCustomObjectInstance(
      'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
      'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
      'co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f',
      {
        'custom_object_instances': {'attributes': []},
      },
    );
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.CustomComponents().CreateComponentObjectCustomObjectInstance(context.Background(), "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d", "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e", "co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f", map[string]any{
	"custom_object_instances": map[string]any{"attributes": []any{}},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

POST

components

{component_uuid}

objects

{component_object_id}

custom_objects

{custom_object_id}

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/components/cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d/objects/a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e/custom_objects/co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "custom_object_instances": {
      "attributes": []
    }
  }'

from exsited import build_client

client = build_client()

response = client.custom_components.create_component_object_custom_object_instance(
    "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    "co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f",
    {"custom_object_instances": {"attributes": []}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customComponents.createComponentObjectCustomObjectInstance(
    'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    'co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f',
    {custom_object_instances: {attributes: []}},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customComponents->createComponentObjectCustomObjectInstance(
    'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    'co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f',
    ['custom_object_instances' => ['attributes' => []]],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.List;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.customComponents().createComponentObjectCustomObjectInstance(
        "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
        "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
        "co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f",
        Map.of("custom_object_instances", Map.of("attributes", List.of())));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomComponents.CreateComponentObjectCustomObjectInstanceAsync(
    "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    "co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f",
    new Dictionary<string, object?>
    {
        ["custom_object_instances"] = new Dictionary<string, object?>
        {
            ["attributes"] = new List<object?>(),
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customComponents
    .createComponentObjectCustomObjectInstance(
      'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
      'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
      'co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f',
      {
        'custom_object_instances': {'attributes': []},
      },
    );
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.CustomComponents().CreateComponentObjectCustomObjectInstance(context.Background(), "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d", "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e", "co_7e9b1d3f5a2c4e6b8d0f2a4c6e8b1d3f", map[string]any{
	"custom_object_instances": map[string]any{"attributes": []any{}},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Creates a new instance of the custom object with this co_ id. The path ends at the custom object, with no instances segment. Send the instance’s attributes list under custom_object_instances, a plural key over one instance.

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

Authorization

string

header

required

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

Path Parameters

component_uuid

string

required

The component definition's id, which starts with cmp_.

component_object_id

string

required

The component object's id, as returned when it is created or listed.

custom_object_id

string

required

The custom object schema's id, which starts with co_.

Body

application/json

custom_object_instances

object

required

Show child attributes

Response

201

The new custom object instance.

Guides

API reference

Create a custom object instance on a component object

Authorizations

Path Parameters

Body

Response