BRbrumby
site plans

Choose

Materialise one variant: the dock and one site per usable relay.

Idempotent — the same variant chosen twice makes no second set of rows. Choosing supersedes whatever plan was chosen for this (farm, dock) before and retires the sites it had planned.

post/api/v1/site-plans/{site_plan_id}/choose

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/site-plans/{site_plan_id}/choose
  • Auth
    HTTP bearer

Path parameters

site_plan_idstring uuid required

Request body

variantinteger required
namestring nullable

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.