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
Human-readable description or label for the hotlink.
Example: "Example description"
Identifier of the resource this hotlink is associated with.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource this hotlink is associated with (e.g., animal, contact, invoice).
Example: "example"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/external-hotlink/{externalHotlinkId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/external-hotlink/{externalHotlinkId}
- 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/external-hotlink/{externalHotlinkId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"description": "Example description",
"extensions": {},
"resourceId": "123e4567-e89b-12d3-a456-426614174000",
"resourceType": "example",
"status": "active",
"url": "https://example.com"
}'External Hotlink updated successfully
Timestamp when this hotlink was created.
Example: "2025-01-01T00:00:00.000Z"
Human-readable description or label for the hotlink.
Example: "Example description"
Canonical identifier for this external hotlink.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the resource this hotlink is associated with.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource this hotlink is associated with (e.g., animal, contact, invoice).
Example: "example"
Lifecycle status of the external hotlink.
Enum"active""inactive"
Example: "active"
Timestamp when this hotlink was last updated.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "description": "Example description", "extensions": {}, "externalHotlinkId": "123e4567-e89b-12d3-a456-426614174000", "resourceId": "123e4567-e89b-12d3-a456-426614174000", "resourceType": "example", "status": "active", "updatedAt": "2025-01-01T00:00:00.000Z", "url": "https://example.com" }
Bodyapplication/jsonrequired
Human-readable description or label for the hotlink.
Example: "Example description"
Identifier of the resource this hotlink is associated with.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource this hotlink is associated with (e.g., animal, contact, invoice).
Example: "example"
Lifecycle status of the external hotlink.
Enum"active""inactive"
Example: "active"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/external-hotlink/{externalHotlinkId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/external-hotlink/{externalHotlinkId}
- 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/external-hotlink/{externalHotlinkId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"description": "Example description",
"extensions": {},
"resourceId": "123e4567-e89b-12d3-a456-426614174000",
"resourceType": "example",
"status": "active",
"url": "https://example.com"
}'External Hotlink replaced successfully
Timestamp when this hotlink was created.
Example: "2025-01-01T00:00:00.000Z"
Human-readable description or label for the hotlink.
Example: "Example description"
Canonical identifier for this external hotlink.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the resource this hotlink is associated with.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource this hotlink is associated with (e.g., animal, contact, invoice).
Example: "example"
Lifecycle status of the external hotlink.
Enum"active""inactive"
Example: "active"
Timestamp when this hotlink was last updated.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "description": "Example description", "extensions": {}, "externalHotlinkId": "123e4567-e89b-12d3-a456-426614174000", "resourceId": "123e4567-e89b-12d3-a456-426614174000", "resourceType": "example", "status": "active", "updatedAt": "2025-01-01T00:00:00.000Z", "url": "https://example.com" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/external-hotlink/{externalHotlinkId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/external-hotlink/{externalHotlinkId}
- 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/external-hotlink/{externalHotlinkId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'