Working with Resources

Working with Resources

Resources are the main objects that you can GET (and where supported, POST, PUT, or PATCH) using ICAR ADE APIs. Resource schemas form a heirarchy inherited from the base icarResource, using the JSON Schema allOf keyword.

icarResource

This schema defines the self-link @id which is used to find the URL of a resource. This is useful when you retrieve an collection of resources, and then need to know the URL to a single resource instance. The schema also embeds a meta data type (meta, of type icarMetaDataType). This defines attributes such as the date the resource was last modified.

icarAnimalCoreResource

This schema defines the core description of an animal, including its identity, parentage, and other static or slowly varying characteristics.

icarDeviceResource

This schema defines a resource for describing devices used to gather data and measure characteristics. Devices will support one or more ICAR message types.

icarEventCoreResource

This schema is a base class for all animal events. It defines a unique id for each event, the event date and time (eventDateTime), and provides the identity of the animal and the location at which the event was recorded. Specific schemas for each event type all include icarEventResource using the JSON Schema allOf keyword.