v1

latestOpenAPI 3.0.02026-08-061380344.2 KB
Notes

Create a Note

Create a note

Parameters

description REQUIRED

The contents of the note that you want to record for the parent resource


date OPTIONAL

The date the note was captured. Defaults to today.


category OPTIONAL

The category for the note. For example, for livestock you might use one of the following categories:

"Breeding", "Deworming", "General", "Grazing"," Grooming", "Injury", "Medication"," Supplement", Vaccination", "Veterinarian", "Other"


keywords OPTIONAL

A comma delimited list of keywords, tags or labels to easily search for similar notes


longitude OPTIONAL

Longitude of the note location


latitude OPTIONAL

Latitude of the note location

post/{resource_name}/{resource_id}/notes

Path parameters

resource_namestring required
resource_idstring required

Headers

Content-Typestring

Request body

object required

Example request

{
  "date": "2023-08-01",
  "description": "Note details",
  "category": "Other",
  "keywords": "test"
}

Response

Successful response