Delete a component definition

cURL

curl -X DELETE "$EXSITED_BASE_URL/api/v4/component/cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customComponents.deleteComponent('cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customComponents->deleteComponent('cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d');
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().deleteComponent("cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomComponents.DeleteComponentAsync("cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customComponents.deleteComponent(
  'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
);
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().DeleteComponent(context.Background(), "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d", 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}

cURL

curl -X DELETE "$EXSITED_BASE_URL/api/v4/component/cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customComponents.deleteComponent('cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customComponents->deleteComponent('cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d');
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().deleteComponent("cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomComponents.DeleteComponentAsync("cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customComponents.deleteComponent(
  'cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d',
);
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().DeleteComponent(context.Background(), "cmp_4b7d2e9a1c3f4e8a9b6d5c2e1f0a3b7d", 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 component definition with this cmp_ id. A successful call returns 204 with an empty body, and deleting it 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 definition's id, which starts with cmp_.

Response

The component definition is deleted. No body.

Guides

API reference

Authorizations

Path Parameters

Response