Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
Overview
Languages
Servers
Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
Local Development
http://localhost:8083/
Bodyapplication/jsonrequired
Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).
Example: "123e4567-e89b-12d3-a456-426614174000"
Optional client-supplied identifier for idempotency or cross-system correlation.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the associated contact, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the parent entity in the separation relationship (e.g., owner, source group).
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/separation/{separationId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/separation/{separationId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/separation/{separationId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"category": "ownership",
"childEntityId": "123e4567-e89b-12d3-a456-426614174000",
"clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
"contactId": "123e4567-e89b-12d3-a456-426614174000",
"extensions": {},
"isActive": true,
"name": "string",
"parentEntityId": "123e4567-e89b-12d3-a456-426614174000",
"separationType": {
"code": "string",
"system": "string",
"display": "string"
}
}'Separation replaced successfully
Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).
Example: "123e4567-e89b-12d3-a456-426614174000"
Optional client-supplied identifier for idempotency or cross-system correlation.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the associated contact, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when this separation record was created.
Example: "2025-01-01T00:00:00.000Z"
Identifier of the parent entity in the separation relationship (e.g., owner, source group).
Example: "123e4567-e89b-12d3-a456-426614174000"
Canonical identifier for this separation relationship.
Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "category": "ownership", "childEntityId": "123e4567-e89b-12d3-a456-426614174000", "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "name": "string", "parentEntityId": "123e4567-e89b-12d3-a456-426614174000", "separationId": "123e4567-e89b-12d3-a456-426614174000", "separationType": { "code": "string", "system": "string", "display": "string" }, "updatedAt": "2025-01-01T00:00:00.000Z" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/separation/{separationId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/separation/{separationId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/separation/{separationId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'