Create Custom Component: /component/{component_uuid}
Purpose
This API creates a new custom component in Exsited, identified by a unique component_uuid. It allows the inclusion of key configuration details such as the component name, parent entity information, associated form, form attributes, and custom objects with their respective attributes. The request payload defines the complete structure of the component, enabling the creation of a fully configured component in a single operation. This endpoint is useful for quickly setting up new components in Exsited with all necessary forms, attributes, and object configurations included, ensuring consistency and accuracy during creation.
Use Case
This API is useful when administrators or developers need to add a new custom component with its required forms, attributes, and custom objects to Exsited. It can be used to initialize complex components during environment setup, onboard new workflows, or programmatically replicate existing structures across multiple accounts. Developers may also use it to automate bulk component creation as part of integration scripts, while administrators can leverage it to ensure that each new component adheres to predefined configuration standards and links to the correct parent entity.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| component_uuid | String | Unique ID for the custom component. |
Query Parameters
No query parameters are required for this endpoint.
Request Body
The request body must contain the full definition of the component, including:
| Field | Type | Description |
|---|---|---|
| component_name | String | Name of the custom component. |
| parents | Array | Parent entities linked to this component, with type and id specified. |
| custom_form | String | Name of the form associated with the component. |
| attributes | Array | List of form attributes with their name and value. |
| custom_objects | Array | List of custom objects, each with its uuid and associated attributes. |
{
"Sample Component Name": {
"parents": [
{
"type": "sample_type",
"id": "sample-id-0001"
}
],
"custom_form": "Sample Form",
"attributes": [
{
"name": "Attribute_One",
"value": "Sample Value 1"
},
{
"name": "Attribute_Two",
"value": "Sample Value 2"
}
],
"custom_objects": [
{
"uuid": "sample-uuid-1234",
"attributes": [
{
"name": "Custom_Object_Field_One",
"value": "Sample Data 1"
},
{
"name": "Custom_Object_Field_Two",
"value": "Sample Data 2"
}
]
}
]
}
}Response
Upon successful creation, the API returns the details of the newly created component. The response includes its status, unique identifiers, linked parent entities, form details, creator information, and associated attributes. It also lists all linked custom objects, each with a name, unique UUID, and an API link for retrieving its records.
Response Body
{
"Sample Component": {
"status": "ACTIVE",
"id": "ABC123",
"parents": [
{
"type": "account",
"id": "ACCOUNT-12345"
}
],
"custom_form": {
"uuid": "form-uuid-1234",
"name": "Sample Form"
},
"created_by": "username",
"created_on": "2025-08-13T03:30:56Z",
"uuid": "component-uuid-1234",
"version": "1",
"attributes": [
{
"name": "Attribute_One",
"value": "Value 1"
},
{
"name": "Attribute_Two",
"value": "Value 2"
},
{
"name": "Attribute_Three",
"value": ""
}
],
"custom_objects": [
{
"uuid": "object-uuid-1234",
"name": "Custom Object 1",
"link": "https://api.example.com/component/{component_uuid}/{id}/custom_objects/{object_uuid}?limit=10&offset=0"
}
]
}
}