Update a component instance

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/component/5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b/a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "service_contract": {
      "attributes": []
    }
  }'

from exsited import build_client

client = build_client()

response = client.custom_components.update_component_by_id(
    "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    {"service_contract": {"attributes": []}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customComponents.updateComponentById(
    '5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    {service_contract: {attributes: []}},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customComponents->updateComponentById(
    '5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    ['service_contract' => ['attributes' => []]],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.custom_components.custom_components_dto.CustomComponentsDto.ComponentByUuid;
import java.util.List;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ComponentByUuid> response = client.customComponents().updateComponentById(
        "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b",
        "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
        Map.of("service_contract", Map.of("attributes", List.of())));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomComponents.UpdateComponentByIdAsync(
    "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    new Dictionary<string, object?>
    {
        ["service_contract"] = 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.updateComponentById(
  '5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b',
  'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
  {
    'service_contract': {'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().UpdateComponentByID(context.Background(), "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b", "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e", map[string]any{
	"service_contract": map[string]any{"attributes": []any{}},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{}

PATCH

component

{component_uuid}

{component_object_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/component/5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b/a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "service_contract": {
      "attributes": []
    }
  }'

from exsited import build_client

client = build_client()

response = client.custom_components.update_component_by_id(
    "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    {"service_contract": {"attributes": []}},
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customComponents.updateComponentById(
    '5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    {service_contract: {attributes: []}},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customComponents->updateComponentById(
    '5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
    ['service_contract' => ['attributes' => []]],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.custom_components.custom_components_dto.CustomComponentsDto.ComponentByUuid;
import java.util.List;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<ComponentByUuid> response = client.customComponents().updateComponentById(
        "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b",
        "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
        Map.of("service_contract", Map.of("attributes", List.of())));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomComponents.UpdateComponentByIdAsync(
    "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e",
    new Dictionary<string, object?>
    {
        ["service_contract"] = 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.updateComponentById(
  '5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b',
  'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
  {
    'service_contract': {'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().UpdateComponentByID(context.Background(), "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b", "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e", map[string]any{
	"service_contract": map[string]any{"attributes": []any{}},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{}

Updates the instance with this id in the component with this dashed uuid. The body has one key, the component’s name, holding the fields to change, such as attributes. The updated instance comes back under the same key with a new version.

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's dashed uuid, not its cmp_ id. It is the uuid the component has in the GET /settings/components listing.

component_object_id

string

required

The component instance's id, as returned when it is created.

Body

application/json

One key, the component's name, holding the fields to change.

{key}

object

Show child attributes

Response

202 - application/json

The updated instance, under the component's name.

One key, the component's name, holding the instance.

{key}

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response