Custom Fields / Definition / Type
/v3/custom-data/definition/type/{typeKey} endpoint reference.
URL: https://demo.1health.io/api/v3/custom-data/definition/type
APIs for defining custom fields on a business object class. Supports creating, replacing, partially updating, and retiring definitions. The tenant and application are resolved from the authenticated context; storage slots are allocated automatically.
Endpoints
| Endpoint | Method | Description |
|---|---|---|
| /v3/custom-data/definition/type/{typeKey} | GET | List custom data definitions for a business object class |
GET/v3/custom-data/definition/type/{typeKey}
List custom data definitions for a business object class
Overview
Returns all custom data definitions (each with its fields) visible to the caller for the given business object class, within the authenticated tenant and application context.
Authorization
Bearer JWT required. See the authentication guide.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| typeKey | String | Yes | The key of the business object class whose custom data definitions should be returned. |
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| appId | Long | No | External application the custom data belongs to. Optional; when omitted, the application is resolved from the authenticated context. |
Responses
200 OK
Custom data definitions retrieved successfully.
DTO: Page<CustomDataDefinitionResponseDTO>
{
"data": [
{}
],
"pageNumber": 1,
"pageSize": 1,
"offset": 1001,
"emptyPage": true,
"firstPage": true,
"lastPage": true,
"numberOfElements": 1001,
"totalElements": 1001,
"totalPages": 1
}
| Field | Type | Nullable | Description |
|---|---|---|---|
| data | List | No | |
| pageNumber | int | No | |
| pageSize | int | No | |
| offset | long | No | |
| emptyPage | boolean | No | |
| firstPage | boolean | No | |
| lastPage | boolean | No | |
| numberOfElements | long | No | |
| totalElements | long | No | |
| totalPages | int | No |
400 Bad Request
Invalid request. Possible causes: • typeKey does not reference an existing business object class • Missing external application context
401 Unauthorized
Not authenticated — valid session required.
Example
curl -X GET "https://demo.1health.io/api/v3/custom-data/definition/type/example-value" \
-H "Authorization: Bearer $TOKEN"
Navigation
Parent: https://agents.1health.io/public/demo/api/v3/custom-data/definition/agents.md · Site guide: https://agents.1health.io/public/demo/api/agents.md