Update separation

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/separation' \
  -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",
    "separationId": "123e4567-e89b-12d3-a456-426614174000",
    "separationType": {
      "code": "string",
      "system": "string",
      "display": "string"
    }
  }'

Responses

Separation created successfully

Bodyapplication/json

categorystringrequired

High-level category of separation.

Enum"ownership""location""grouping""other"

childEntityIdstringrequired

Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).

Example: "123e4567-e89b-12d3-a456-426614174000"

clientProvidedIdstringrequired

Optional client-supplied identifier for idempotency or cross-system correlation.

Example: "123e4567-e89b-12d3-a456-426614174000"

contactIdstringrequired

Reference to the associated contact, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"

createdAtstring(date-time)required

Timestamp when this separation record was created.

Example: "2025-01-01T00:00:00.000Z"

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this separation record is currently active.

namestringrequired

Human-readable name or label for the separation.

parentEntityIdstringrequired

Identifier of the parent entity in the separation relationship (e.g., owner, source group).

Example: "123e4567-e89b-12d3-a456-426614174000"

separationIdstringrequired

Canonical identifier for this separation relationship.

Example: "123e4567-e89b-12d3-a456-426614174000"

separationTypeobjectrequired

separationType.codestringrequired

Code value

separationType.systemstringrequired

Code system URI

separationType.displaystring

Human-readable display

updatedAtstring(date-time)required

Timestamp when this separation record was last updated.

Example: "2025-01-01T00:00:00.000Z"

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"
}

List separations

Request

Returns a paginated list of Separations for the specified site. Supports filtering and sorting.

Security

bearer

Path

siteIdnumberrequired

Site identifier

Query

pagenumber>= 0

Page number (0-indexed)

Default 0

pageSizenumber[ 1 .. 100 ]

Number of items per page

Default 10

sortBystring

Field to sort by

Enum"createdAt""updatedAt""name"

sortOrderstring

Sort order

Default "asc"

Enum"asc""desc"

categorystring

High-level category of separation.

Enum"ownership""location""grouping""other"

childEntityIdstring

Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).

Example: childEntityId=123e4567-e89b-12d3-a456-426614174000

clientProvidedIdstring

Optional client-supplied identifier for idempotency or cross-system correlation.

Example: clientProvidedId=123e4567-e89b-12d3-a456-426614174000

contactIdstring

Reference to the associated contact, if applicable.

Example: contactId=123e4567-e89b-12d3-a456-426614174000

isActiveboolean

Whether this separation record is currently active.

namestring

Human-readable name or label for the separation.

parentEntityIdstring

Identifier of the parent entity in the separation relationship (e.g., owner, source group).

Example: parentEntityId=123e4567-e89b-12d3-a456-426614174000

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/separation?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&category=ownership&childEntityId=123e4567-e89b-12d3-a456-426614174000&clientProvidedId=123e4567-e89b-12d3-a456-426614174000&contactId=123e4567-e89b-12d3-a456-426614174000&isActive=true&name=string&parentEntityId=123e4567-e89b-12d3-a456-426614174000' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Separations

Get separation

Request

Returns a single Separation by its unique identifier.

Security

bearer

Path

siteIdnumberrequired

Site identifier

separationIdstringrequired

Separation unique identifier (UUID)

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/separation/{separationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Separation found

Bodyapplication/json

categorystringrequired

High-level category of separation.

Enum"ownership""location""grouping""other"

childEntityIdstringrequired

Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).

Example: "123e4567-e89b-12d3-a456-426614174000"

clientProvidedIdstringrequired

Optional client-supplied identifier for idempotency or cross-system correlation.

Example: "123e4567-e89b-12d3-a456-426614174000"

contactIdstringrequired

Reference to the associated contact, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"

createdAtstring(date-time)required

Timestamp when this separation record was created.

Example: "2025-01-01T00:00:00.000Z"

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this separation record is currently active.

namestringrequired

Human-readable name or label for the separation.

parentEntityIdstringrequired

Identifier of the parent entity in the separation relationship (e.g., owner, source group).

Example: "123e4567-e89b-12d3-a456-426614174000"

separationIdstringrequired

Canonical identifier for this separation relationship.

Example: "123e4567-e89b-12d3-a456-426614174000"

separationTypeobjectrequired

separationType.codestringrequired

Code value

separationType.systemstringrequired

Code system URI

separationType.displaystring

Human-readable display

updatedAtstring(date-time)required

Timestamp when this separation record was last updated.

Example: "2025-01-01T00:00:00.000Z"

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"
}