Delete a component instance

cURL

curl -X DELETE "$EXSITED_BASE_URL/api/v4/component/5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b/a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.custom_components.delete_component_by_id(
    "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b", "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e"
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customComponents.deleteComponentById(
    '5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

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

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.customComponents().deleteComponentById(
        "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b",
        "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomComponents.DeleteComponentByIdAsync(
    "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customComponents.deleteComponentById(
  '5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b',
  'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
);
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().DeleteComponentByID(context.Background(), "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b", "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

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

DELETE

component

{component_uuid}

{component_object_id}

cURL

curl -X DELETE "$EXSITED_BASE_URL/api/v4/component/5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b/a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.custom_components.delete_component_by_id(
    "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b", "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e"
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customComponents.deleteComponentById(
    '5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b',
    'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

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

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.customComponents().deleteComponentById(
        "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b",
        "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomComponents.DeleteComponentByIdAsync(
    "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b",
    "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customComponents.deleteComponentById(
  '5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b',
  'a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e',
);
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().DeleteComponentByID(context.Background(), "5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b", "a1c3e5f7b9d24f6a8c0e2b4d6f8a0c2e", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

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

Removes the instance with this id from the component with this dashed uuid. A successful call returns 204 with an empty body; reading or deleting the instance again returns 404.

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

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.

Response

The instance is deleted. No body.

Guides

API reference

Authorizations

Path Parameters

Response