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/
Query
Field to sort by
Enum"createdAt""updatedAt""fileDownloadUrl""mimeType""name""notes""recordType"
Identifier of the underlying stored file object.
Example: fileId=123e4567-e89b-12d3-a456-426614174000
Identifier of the record this attachment is linked to.
Example: recordId=123e4567-e89b-12d3-a456-426614174000
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/attachment
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/attachment
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/attachment?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&fileDownloadUrl=string&fileId=123e4567-e89b-12d3-a456-426614174000&isActive=true&isPrimaryImage=true&mimeType=string&name=string¬es=string&recordId=123e4567-e89b-12d3-a456-426614174000&recordType=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/attachment/{attachmentId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/attachment/{attachmentId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/attachment/{attachmentId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Attachment found
Canonical identifier for the attachment.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the attachment record was created.
Example: "2025-01-01T00:00:00.000Z"
URL that can be used to download the file content, subject to authorization.
Example: "https://example.com"
Identifier of the underlying stored file object.
Example: "123e4567-e89b-12d3-a456-426614174000"
Whether the attachment is active and should be shown in client applications.
Example: true
Whether this attachment is the primary image for the associated record.
Example: true
MIME type of the attached file (e.g. 'image/jpeg', 'application/pdf').
Example: "example"
Identifier of the record this attachment is linked to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of record this attachment is associated with (e.g. 'Animal', 'Contact', 'Consult').
Example: "example"
Response
application/json
{ "attachmentId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "fileDownloadUrl": "https://example.com", "fileId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "isPrimaryImage": true, "mimeType": "example", "name": "Example Name", "notes": "Example description", "recordId": "123e4567-e89b-12d3-a456-426614174000", "recordType": "example", "updatedAt": "2025-01-01T00:00:00.000Z" }
Bodyapplication/jsonrequired
URL that can be used to download the file content, subject to authorization.
Example: "https://example.com"
Identifier of the underlying stored file object.
Example: "123e4567-e89b-12d3-a456-426614174000"
Whether the attachment is active and should be shown in client applications.
Example: true
Whether this attachment is the primary image for the associated record.
Example: true
MIME type of the attached file (e.g. 'image/jpeg', 'application/pdf').
Example: "example"
Identifier of the record this attachment is linked to.
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/attachment/{attachmentId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/attachment/{attachmentId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/attachment/{attachmentId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"extensions": {},
"fileDownloadUrl": "https://example.com",
"fileId": "123e4567-e89b-12d3-a456-426614174000",
"isActive": true,
"isPrimaryImage": true,
"mimeType": "example",
"name": "Example Name",
"notes": "Example description",
"recordId": "123e4567-e89b-12d3-a456-426614174000",
"recordType": "example"
}'Attachment updated successfully
Canonical identifier for the attachment.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the attachment record was created.
Example: "2025-01-01T00:00:00.000Z"
URL that can be used to download the file content, subject to authorization.
Example: "https://example.com"
Identifier of the underlying stored file object.
Example: "123e4567-e89b-12d3-a456-426614174000"
Whether the attachment is active and should be shown in client applications.
Example: true
Whether this attachment is the primary image for the associated record.
Example: true
MIME type of the attached file (e.g. 'image/jpeg', 'application/pdf').
Example: "example"
Identifier of the record this attachment is linked to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of record this attachment is associated with (e.g. 'Animal', 'Contact', 'Consult').
Example: "example"
Response
application/json
{ "attachmentId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "fileDownloadUrl": "https://example.com", "fileId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "isPrimaryImage": true, "mimeType": "example", "name": "Example Name", "notes": "Example description", "recordId": "123e4567-e89b-12d3-a456-426614174000", "recordType": "example", "updatedAt": "2025-01-01T00:00:00.000Z" }