Patient Vault v3 API

URL: https://demo.1health.io/api/v3/custom-data/instance

REST API for reading and writing custom field values on business object instances.

Endpoints

---

GET/v3/custom-data/instance/{boInstanceId}

Read all custom field values for an instance

Overview

Returns all custom field values set on a business object instance as a flat JSON object keyed by custom field key, within the authenticated tenant and application context.

Authorization

Bearer JWT required. See the authentication guide.

Path Parameters

Query Parameters

Responses

200 Values retrieved successfully.

{}

401 Not authenticated — valid session required.

404 Instance not found.

Example

curl -X GET "https://demo.1health.io/api/v3/custom-data/instance/1001" \
  -H "Authorization: Bearer $TOKEN"

PATCH/v3/custom-data/instance/{boInstanceId}

Create, update, or clear custom field values

Overview

Writes one or more custom field values on a business object instance in a single request. The body is a flat JSON object keyed by custom field key; each value is validated against its field definition, and only the referenced fields are written.

Authorization

Bearer JWT required. See the authentication guide.

Path Parameters

Query Parameters

Request Body

Content-Type: application/json

{}

Responses

200 Values upserted successfully.

{}

400 Invalid request. Possible causes: • A value is not valid for its field's type or JSON schema • An empty body was provided • Missing external application context

401 Not authenticated — valid session required.

404 A referenced field or the instance was not found.

Example

curl -X PATCH "https://demo.1health.io/api/v3/custom-data/instance/1001" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" -d '{}'

---

Child Routes

Navigation

Parent: https://agents.1health.io/public/demo/api/v3/custom-data/agents.md · Site guide: https://agents.1health.io/public/demo/api/agents.md