Skip to main content

FarmRepositoryApi

All URIs are relative to http://localhost:1985

MethodHTTP requestDescription
createFarmPOST /api/backend/repository/farm/Create a new Farm
deleteFarmDELETE /api/backend/repository/farm/{uuid}Delete a Farm
getFarmGET /api/backend/repository/farm/{uuid}Retrieve one Farm
listFarmsGET /api/backend/repository/farm/List all Farms
updateFarmPATCH /api/backend/repository/farm/{uuid}Update a Farm

createFarm

Farm createFarm()

Create a new Farm

Creates one Farm entity in the database.

Parameters

This endpoint does not need any parameter.

Return type

Farm

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

deleteFarm

deleteFarm(uuid)

Delete a Farm

Deletes one Farm entity from its UUID stored in the database.

Parameters

NameTypeDescriptionNotes
uuidStringIdentifier of the Farm[default to null]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getFarm

Farm getFarm(uuid)

Retrieve one Farm

Returns one Farm entity from its UUID stored in the database.

Parameters

NameTypeDescriptionNotes
uuidStringIdentifier of the Farm[default to null]

Return type

Farm

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

listFarms

List listFarms()

List all Farms

Returns all Farm entities stored in the database.

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

updateFarm

Farm updateFarm(uuid, request_body)

Update a Farm

Updates one Farm entity in the database.

Parameters

NameTypeDescriptionNotes
uuidStringIdentifier of the Farm[default to null]
request_bodyMap

Return type

Farm

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /