AgriWebb API
GraphQL/Objects

Animal

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
type Animal {
  animalId: ID!
  identity: AnimalIdentity
  ageClass: AgeClass
  characteristics: AnimalCharacteristics
  parentage: Parentage
  managementGroupId: String
  managementGroup: ManagementGroup
  enterpriseId: String
  enterprise: Enterprise
  state: AnimalState
  records(
    filter: RecordFilter
    limit: Int
    skip: Int
    _capabilities: [String]
  ): [Record]
  farmId: String
  purchasedFrom: String
  purchaseLocationId: String
  creationRecordGroupId: String
  creationRecordId: String
  birthingRecordId: String
  purchaseRecordId: String
  saleRecordId: String
  _observationDate: Timestamp
}

Fields

Animal.animalId ● ID!
non-null
scalar

An internal AgriWebb ID for the animal.

Animal.identity ● AnimalIdentity
object

Identity of the animal.

Animal.ageClass ● AgeClass
enum

Age class of the animal.

Animal.characteristics ● AnimalCharacteristics
object

Characteristics of the animal.

Animal.parentage ● Parentage
object

Animal's parentage information

Animal.managementGroupId ● String
scalar

Animal's management group id

Animal.managementGroup ● ManagementGroup
object

Animal's management group

Animal.enterpriseId ● String
scalar

Animal's enterprise id

Animal.enterprise ● Enterprise
object

Animal's enterprise

Animal.state ● AnimalState
object

Animal's current state

Animal.records ● [Record]
list
interface

Records recorded against the animal

Animal.records.filter ● RecordFilter
input
Animal.records.limit ● Int
scalar
Animal.records.skip ● Int
scalar
Animal.records._capabilities ● [String]
list
scalar

Query capabilities

Animal.farmId ● String
scalar

An internal AgriWebb ID for the farm the animal is on

Animal.purchasedFrom ● String
scalar

Vendor animal was purchased from

Animal.purchaseLocationId ● String
scalar

Vendor's location id, for example in Australia this will be the PIC

Animal.creationRecordGroupId ● String
scalar

Internal AgriWebb creation record group Id. Record itself not exposed through the API

Animal.creationRecordId ● String
scalar

Internal AgriWebb creation record Id. Record itself not exposed through the API

Animal.birthingRecordId ● String
scalar

Internal AgriWebb birth record Id. Record itself not exposed through the API

Animal.purchaseRecordId ● String
scalar

Internal AgriWebb purchase record Id. Record itself not exposed through the API

Animal.saleRecordId ● String
scalar

Internal AgriWebb sale record Id. Record itself not exposed through the API

Animal._observationDate ● Timestamp
scalar

Animal state shown as of this date

Returned By

animals

query

Member Of

AnimalsWithCount

object

On this page

FieldsAnimal.animalId ● ID!
non-null
scalar
Animal.identity ● AnimalIdentity
object
Animal.ageClass ● AgeClass
enum
Animal.characteristics ● AnimalCharacteristics
object
Animal.parentage ● Parentage
object
Animal.managementGroupId ● String
scalar
Animal.managementGroup ● ManagementGroup
object
Animal.enterpriseId ● String
scalar
Animal.enterprise ● Enterprise
object
Animal.state ● AnimalState
object
Animal.records ● [Record]
list
interface
Animal.records.filter ● RecordFilter
input
Animal.records.limit ● Int
scalar
Animal.records.skip ● Int
scalar
Animal.records._capabilities ● [String]
list
scalar
Animal.farmId ● String
scalar
Animal.purchasedFrom ● String
scalar
Animal.purchaseLocationId ● String
scalar
Animal.creationRecordGroupId ● String
scalar
Animal.creationRecordId ● String
scalar
Animal.birthingRecordId ● String
scalar
Animal.purchaseRecordId ● String
scalar
Animal.saleRecordId ● String
scalar
Animal._observationDate ● Timestamp
scalar
Returned ByMember Of