AgriWebb API
GraphQL/Queries

animals

**scope:** read:animals

animals(
  farmId: String!
  filter: AnimalFilter
  sort: [AnimalSort!]
  limit: Int
  skip: Int
  observationDate: Timestamp
  _capabilities: [String]
): [Animal]

Arguments

animals.farmId ● String!
non-null
scalar

An internal AgriWebb ID of the farm you want to query for animals

animals.filter ● AnimalFilter
input

Filter object to refine the animals by

animals.sort ● [AnimalSort!]
list
input

Sort information for the animals

animals.limit ● Int
scalar

Limit the number of animals returned

animals.skip ● Int
scalar

Number of animals to skip

animals.observationDate ● Timestamp
scalar

Get animals as of this date

animals._capabilities ● [String]
list
scalar

Query capabilities

Type

Animal
object

The base representation of an individual animal, this includes animals that are no longer on farm.

The sub-objects here contain detailed information, in particular:

  • AnimalCharacteristics & Parentage define features that once set typically not change over the animals lifetime
  • AnimalState exposes the mutable current state of the animal including some 1 off events such as death and sale
  • records includes events that are typically recorded 0-n times over the lifetime, such as weight and feed

On this page

Argumentsanimals.farmId ● String!
non-null
scalar
animals.filter ● AnimalFilter
input
animals.sort ● [AnimalSort!]
list
input
animals.limit ● Int
scalar
animals.skip ● Int
scalar
animals.observationDate ● Timestamp
scalar
animals._capabilities ● [String]
list
scalar
TypeAnimal
object