post observation-summary-metrics Endpoint

Sends alert data from activity monitoring devices to PULSE.

POST https://integrations.prod.vas.com/api/batches/locations/com.vas.dairies.id/{location-id}/observation-summary-metrics

IMPORTANT: VAS currently supports the following data point for use in PULSE and DairyComp reports and worklists: 

When aggregation=SUM and isIncomplete=FALSE

  • metric id: populates as Rumination time, 24-hour Rumination time, Eating time, 24-hour Eating time, Inactive time, and 24-hour Inactive time.

All other data sent to VAS will not be visible from PULSE and DairyComp.

Parameters (required)

In addition to the standard Authorization and API Key header parameters, the following are required: 

{location-id}integerREQUIRED

VAS-specificClosed A data value that originates from the VAS product line. [dairy] location identifier. For routes with “com.vas.dairies.id”, {location-id} is a VAS-specific dairy id.

ContentTypestringREQUIRED

Use application/json

Request bodyREQUIRED

Format required for the POST request. See the details below in the Request Schema.

Request Schema

Follow the ICARClosed International Committee for Animal Recording (ICAR) is a global organization focused on the standardization of animal identification, recording, genetic evaluation, and data management. resourceTypeCatalog

The meta data specifies information about the data or event source.

URI or reverse DNS that identifies the source system

Unique identifier within the source system

Indicates if the resource is deleted in the source system

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTCClosed Coordinated Universal Time, also known as Greenwich Mean Time (GMT) time) of the last animal update. Learn more about VAS Developer API Date/Time Formatting.

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of when the animal record was created. Learn more about VAS Developer API Date/Time Formatting.

Person or system that created the resource

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of the start of valid period.

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of the end of valid period.

The animal data includes animal identification details.

idinteger

VAS-specific dairy cow identifier. This number is used in all VAS products, including PULSE and DairyComp 305. This identifier is unique to each animal in the VAS suite of products, and is the most stable and reliable source of animal identification data. dairyCowId differs from the animal's cowNumber, displayCowNumber, EIDClosed 15-digit electronic ID number associated with the animal eartag, and isoId.

schemestring

Identifies the data source as VAS: com.vas.animals.id

Statistics data provides a summary of animal activity for a specified period of time.

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of the start of the statistics period.

Period of time specified as [ 1D, 1H, 24H, 96H, 1W, 1M ] 

When true, the duration data is incomplete or insufficient

idstringREQUIRED

Metric identifier (units):

EatingTime (minutes)
InactiveTime (minutes)
RuminationTime (minutes)

This data is made available in DairyComp and PULSE as the following items:

VAS Developer API Data Point Default DairyComp/
Standard PULSE Item

EatingTime, when duration=1D

EAT: most recent eating time

EatingTime, when duration=24H

EAT24: most recent 24-hour eating time

InactiveTime, when duration=1D

INACT: most recent inactivity time
InactiveTime, when duration=24H INA24: most recent 24-hour inactivity time
RuminationTime, when duration=1D RUMIN: most recent rumination time
RuminationTime, when duration=24H RUM24: most recent 24-hour rumination time
NOTE: Item names in DairyComp and PULSE are customizable and may differ from the default listed above.

schemestringREQUIRED

Identifies the metric data source as org.icar.activities

Unit of the metric:

MIN: Time in minutes

Type of aggregation: Sum

Metric value

curl -X POST 
'https://integrations.prod.vas.com/api/batches/locations/com.vas.dairies.id/{location-id}/observation-summary-metrics'  \
-H 'Authorization: bearer {authorization token}'  \
-H 'X-API-Key: {API key}'  \
-H 'Content-Type: application/json'  \
--data-raw '{
[
    {
        "resourceType": "icarResourceType",
        "meta": {
            "source": "10.1.1.123",
            "sourceId": "10.1.1.234",
            "isDeleted": false,
            "modified": "2024-04-30T14:54:07.609Z",
            "created": "2024-04-30T14:54:07.609Z",
            "creator": "Technician123",
            "validFrom": "2024-04-30T14:54:07.609Z",
            "validTo": "2024-04-30T14:54:07.609Z"
        },
        "location": {
            "id": "{location}",
            "scheme": "com.vas.dairies.id"
        },
      
        "animal": {
            "id": "123456789",
            "scheme": "com.vas.animals.id"
        },
	"statistics": 
	{
            "startDateTime": "2024-10-04T14:54:07.609Z",
            "duration": "1D",
            "isInComplete": false,
            "metric": {
            	"id": "123456789",
            	"scheme": "org.icar.activities"
            "unit": "MIN",
            "aggregation": "Sum",
            "value": "1225",
        },       
    }
]
}'

Response

A successful response is 201 Created. See API Errors and HTTP Status Code Details for other possible responses and errors.

< Return to Bi-directional Data Exchange Overview