BRbrumby
site plans

Add Site Plan

Store a planner run. It is a draft until a variant is chosen.

post/api/v1/farms/{farm_id}/site-plans

Request

  • Base URL
    https://api.brumby.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.brumby.com/api/v1/farms/{farm_id}/site-plans
  • Auth
    HTTP bearer

Path parameters

farm_idstring required

Request body

device_idstring nullable
namestring nullable
paddock_idsstring[]

Response

Successful Response

site_plan_idstring uuid required
farm_idstring required
device_idstring nullable required
namestring nullable required
statusstring required
paddock_idsstring[] required
settingsobject required
variantsobject[] required
chosen_variantinteger nullable required
engineobject required
created_bystring required
archived_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.