> For the complete documentation index, see [llms.txt](https://developer.emporix.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.emporix.io/changelog/archive/changelog-2025/2025-04-03-schema.md).

# 2025-04-03: Schema Service - endpoints for managing custom entities and instances

## Overview

We added new API for managing custom schema types and custom instances. Custom schema types are custom entities on which you can build custom instances.

## Added endpoints

| Endpoint                                                                                                                                                                                               | Description                             |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------- |
| [Creating a custom schema type](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-schema-type#post-schema-tenant-custom-entities)                        | It creates a new schema type.           |
| [Retrieving all custom schema types](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-schema-type#get-schema-tenant-custom-entities)                    | It retrieves all custom schema types.   |
| [Retrieving a custom schema type](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-schema-type#get-schema-tenant-custom-entities-id)                    | It retrieves a custom schema type.      |
| [Deleting a custom schema type](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-schema-type#delete-schema-tenant-custom-entities-id)                   | It deletes a custom schema type.        |
| [Upserting a custom schema type](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-schema-type#put-schema-tenant-custom-entities-id)                     | It upserts custom schema type.          |
| [Creating a custom instance](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-instance#post-schema-tenant-custom-entities-type-instances)               | It creates a custom instance.           |
| [Retrieving all custom instances](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-instance#get-schema-tenant-custom-entities-type-instances)           | It retrieves all custom instances.      |
| [Retrieving a custom instance](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-instance#get-schema-tenant-custom-entities-type-instances-id)           | It retrieves a custom instance.         |
| [Deleting a custom instance](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-instance#delete-schema-tenant-custom-entities-type-instances-id)          | It deletes a custom instance.           |
| [Upserting a custom instance](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-instance#put-schema-tenant-custom-entities-type-instances-id)            | It upserts a custom instance.           |
| [Patching a custom instance](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-instance#patch-schema-tenant-custom-entities-type-instances-id)           | It partially updates a custom instance. |
| [Searching for custom instances](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-instance#post-schema-tenant-custom-entities-type-instances-search)    | It searches for custom instances.       |
| [Creating custom instances in bulk](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-instance#post-schema-tenant-custom-entities-type-instances-bulk)   | It creates custom instances in bulk.    |
| [Upserting custom instances in bulk](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-instance#put-schema-tenant-custom-entities-type-instances-bulk)   | It upserts custom instances in bulk.    |
| [Deleting custom instances in bulk](https://developer.emporix.io/api-documentation/api-guides/utilities/schema/api-reference/custom-instance#delete-schema-tenant-custom-entities-type-instances-bulk) | It deletes custom instances in bulk.    |

## Known problems

There are no known problems.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.emporix.io/changelog/archive/changelog-2025/2025-04-03-schema.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.