cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/component?limit=20" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.custom_components.get_component({"limit": 20})
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.customComponents.getComponent({limit: 20});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->customComponents->getComponent(['limit' => 20]);
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.ComponentList;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<ComponentList> response = client.customComponents().getComponent(Map.of("limit", 20));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.CustomComponents.GetComponentAsync(new Dictionary<string, object?> { ["limit"] = 20 });
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.customComponents.getComponent(
queryParams: {'limit': 20},
);
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().GetComponent(context.Background(), map[string]any{"limit": 20}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"object": "<string>",
"url": "<string>",
"data": [
{
"object": "<string>",
"id": "<string>",
"status": "<string>",
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"use_in": "<string>",
"relation": "<string>",
"custom_component": "<unknown>",
"custom_objects": [
{}
],
"custom_forms": [
{
"column_count": 123,
"data": {
"firstColumnAttribute": [
{
"canEncrypt": true,
"description": "<string>",
"displayName": "<string>",
"enabled": true,
"encryptData": true,
"entity": "<unknown>",
"fieldRequired": true,
"formMaxLengthInputed": true,
"formMinLengthInputed": true,
"id": 123,
"ids": 123,
"isRequired": true,
"isUnique": true,
"maxLength": "<unknown>",
"metaData": "<string>",
"minLength": "<unknown>",
"name": "<string>",
"options": [
{
"id": "<string>",
"name": "<string>"
}
],
"position": "<string>",
"showInListView": true,
"timeFormat": "<unknown>",
"type": "<string>",
"typeValue": "<string>",
"validationMessage": "<string>",
"validationMessageRequired": true,
"value": "<string>"
}
],
"secondColumnAttribute": [
{
"displayName": "<string>",
"fieldEnabled": true,
"fieldRequired": true,
"ids": 123,
"name": "<string>",
"showInListView": true,
"type": "<string>",
"typeActual": {
"key": "<string>",
"value": "<string>"
},
"validationMessageRequired": true
}
],
"thirdColumnAttribute": [
{}
]
},
"id": "<string>",
"object": "<string>",
"template_name": "<string>"
}
],
"child_custom_components": [
{}
],
"activity_logs": [
{}
],
"created_on": "<string>",
"last_updated_on": "<string>",
"created_by": "<unknown>",
"last_updated_by": "<unknown>",
"version": 123,
"href": "<string>"
}
],
"pagination": {
"limit": 123,
"has_more": true,
"next_cursor": "<string>",
"prev_cursor": "<string>",
"links": {
"next": "<string>",
"prev": "<string>"
}
}
}Custom components
List component definitions
Returns one page of the custom component definitions.
GET
/
component
cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/component?limit=20" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.custom_components.get_component({"limit": 20})
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.customComponents.getComponent({limit: 20});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->customComponents->getComponent(['limit' => 20]);
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.ComponentList;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<ComponentList> response = client.customComponents().getComponent(Map.of("limit", 20));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.CustomComponents.GetComponentAsync(new Dictionary<string, object?> { ["limit"] = 20 });
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.customComponents.getComponent(
queryParams: {'limit': 20},
);
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().GetComponent(context.Background(), map[string]any{"limit": 20}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"object": "<string>",
"url": "<string>",
"data": [
{
"object": "<string>",
"id": "<string>",
"status": "<string>",
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"use_in": "<string>",
"relation": "<string>",
"custom_component": "<unknown>",
"custom_objects": [
{}
],
"custom_forms": [
{
"column_count": 123,
"data": {
"firstColumnAttribute": [
{
"canEncrypt": true,
"description": "<string>",
"displayName": "<string>",
"enabled": true,
"encryptData": true,
"entity": "<unknown>",
"fieldRequired": true,
"formMaxLengthInputed": true,
"formMinLengthInputed": true,
"id": 123,
"ids": 123,
"isRequired": true,
"isUnique": true,
"maxLength": "<unknown>",
"metaData": "<string>",
"minLength": "<unknown>",
"name": "<string>",
"options": [
{
"id": "<string>",
"name": "<string>"
}
],
"position": "<string>",
"showInListView": true,
"timeFormat": "<unknown>",
"type": "<string>",
"typeValue": "<string>",
"validationMessage": "<string>",
"validationMessageRequired": true,
"value": "<string>"
}
],
"secondColumnAttribute": [
{
"displayName": "<string>",
"fieldEnabled": true,
"fieldRequired": true,
"ids": 123,
"name": "<string>",
"showInListView": true,
"type": "<string>",
"typeActual": {
"key": "<string>",
"value": "<string>"
},
"validationMessageRequired": true
}
],
"thirdColumnAttribute": [
{}
]
},
"id": "<string>",
"object": "<string>",
"template_name": "<string>"
}
],
"child_custom_components": [
{}
],
"activity_logs": [
{}
],
"created_on": "<string>",
"last_updated_on": "<string>",
"created_by": "<unknown>",
"last_updated_by": "<unknown>",
"version": 123,
"href": "<string>"
}
],
"pagination": {
"limit": 123,
"has_more": true,
"next_cursor": "<string>",
"prev_cursor": "<string>",
"links": {
"next": "<string>",
"prev": "<string>"
}
}
}Lists the component definitions with each one’s
cmp_ id, name, where it is used, its relation and its forms. Records are under data and paging details under pagination. Fields filter as filter_<field>.
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
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Query Parameters
The most records to return on one page.
Example:
20
The next_cursor from the previous page, to read the page after it.
A field to sort by, such as created_on, or -created_on for newest first.
Example:
"-created_on"