Documentation Powered by ReDoc

Little Bock REST API (1.0.0)

You can use the Little Bock REST API to create calls to get the data you need to integrate with Little Bock.

Authentication

ApiKey

Value for the X-AUTH-TOKEN header parameter.

Security Scheme Type API Key
Header parameter name: X-AUTH-TOKEN

BeerPackageType

Retrieves the collection of BeerPackageType resources.

Retrieves the collection of BeerPackageType resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a BeerPackageType resource.

Retrieves a BeerPackageType resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "name": "string",
  • "beerSize": "string",
  • "isReturnable": true,
  • "notes": "string",
  • "isSingleUse": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

BeerProduct

Retrieves the collection of BeerProduct resources.

Retrieves the collection of BeerProduct resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a BeerProduct resource.

Retrieves a BeerProduct resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "amount": "string",
  • "amountProducted": "string",
  • "beerPackageType": {
    },
  • "emptyBeerPackage": {
    },
  • "brewSession": {
    },
  • "packagedAt": "2019-08-24T14:15:22Z",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "emptyBeerPackageUnitCost": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Updates the BeerProduct resource.

Updates the BeerProduct resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated BeerProduct resource

amount
string
notes
string or null
lowAmountAlertValue
string or null
traceabilityNumber
string or null

Responses

Request samples

Content type
application/merge-patch+json
{
  • "amount": "string",
  • "notes": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "amount": "string",
  • "amountProducted": "string",
  • "beerPackageType": {
    },
  • "emptyBeerPackage": {
    },
  • "brewSession": {
    },
  • "packagedAt": "2019-08-24T14:15:22Z",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "emptyBeerPackageUnitCost": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

BeerStyle

Retrieves the collection of BeerStyle resources.

Retrieves the collection of BeerStyle resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a BeerStyle resource.

Retrieves a BeerStyle resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "name": "string",
  • "category": "string",
  • "categoryNumber": "string",
  • "styleLetter": "string",
  • "styleGuide": "string",
  • "fermentationType": "string",
  • "ogMin": "string",
  • "ogMax": "string",
  • "fgMin": "string",
  • "fgMax": "string",
  • "ibuMin": 0,
  • "ibuMax": 0,
  • "ebcMin": 0,
  • "ebcMax": 0,
  • "carbonationMin": "string",
  • "carbonationMax": "string",
  • "abvMin": "string",
  • "abvMax": "string",
  • "examples": "string"
}

BrewEquipment

Retrieves the collection of BrewEquipment resources.

Retrieves the collection of BrewEquipment resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a BrewEquipment resource.

Retrieves a BrewEquipment resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "name": "string",
  • "grainAbsorption": 0.9,
  • "falseBottomVolume": 0.5,
  • "offsetFalseBottomVolume": true,
  • "falseBottomVolumeNotLost": true,
  • "evaporationRate": 20,
  • "coolingRetractionRate": 4,
  • "miscLossVolume": 0.5,
  • "efficiency": 72,
  • "batchSize": 20,
  • "boilTime": 60,
  • "hopAromaUtilizationCalculation": true,
  • "hopAromaUtilization": 50,
  • "notes": "string"
}

BrewLog

Retrieves the collection of BrewLog resources.

Retrieves the collection of BrewLog resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a BrewLog resource.

Retrieves a BrewLog resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "mashingAt": "2019-08-24T14:15:22Z",
  • "mashPh": "string",
  • "postSpargeVolume": "string",
  • "mashingNotes": "string",
  • "boilingAt": "2019-08-24T14:15:22Z",
  • "preBoilGravity": "string",
  • "postBoilGravity": "string",
  • "preBoilVolume": "string",
  • "postBoilVolume": "string",
  • "boilingNotes": "string",
  • "fermentationStartAt": "2019-08-24T14:15:22Z",
  • "originalGravity": "string",
  • "preFermentationVolume": "string",
  • "fermentationStartNotes": "string",
  • "fermentationEndAt": "2019-08-24T14:15:22Z",
  • "finalGravity": "string",
  • "fermentationEndNotes": "string",
  • "brewLogEvents": [
    ]
}

Updates the BrewLog resource.

Updates the BrewLog resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated BrewLog resource

mashingAt
string or null <date-time>
http://schema.org/Date
mashPh
string or null
postSpargeVolume
string or null
mashingNotes
string or null
boilingAt
string or null <date-time>
http://schema.org/Date
preBoilGravity
string or null
postBoilGravity
string or null
postBoilVolume
string or null
boilingNotes
string or null
fermentationStartAt
string or null <date-time>
http://schema.org/Date
originalGravity
string or null
preFermentationVolume
string or null
fermentationStartNotes
string or null
fermentationEndAt
string or null <date-time>
http://schema.org/Date
finalGravity
string or null
fermentationEndNotes
string or null

Responses

Request samples

Content type
application/merge-patch+json
{
  • "mashingAt": "2019-08-24T14:15:22Z",
  • "mashPh": "string",
  • "postSpargeVolume": "string",
  • "mashingNotes": "string",
  • "boilingAt": "2019-08-24T14:15:22Z",
  • "preBoilGravity": "string",
  • "postBoilGravity": "string",
  • "postBoilVolume": "string",
  • "boilingNotes": "string",
  • "fermentationStartAt": "2019-08-24T14:15:22Z",
  • "originalGravity": "string",
  • "preFermentationVolume": "string",
  • "fermentationStartNotes": "string",
  • "fermentationEndAt": "2019-08-24T14:15:22Z",
  • "finalGravity": "string",
  • "fermentationEndNotes": "string"
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "mashingAt": "2019-08-24T14:15:22Z",
  • "mashPh": "string",
  • "postSpargeVolume": "string",
  • "mashingNotes": "string",
  • "boilingAt": "2019-08-24T14:15:22Z",
  • "preBoilGravity": "string",
  • "postBoilGravity": "string",
  • "preBoilVolume": "string",
  • "postBoilVolume": "string",
  • "boilingNotes": "string",
  • "fermentationStartAt": "2019-08-24T14:15:22Z",
  • "originalGravity": "string",
  • "preFermentationVolume": "string",
  • "fermentationStartNotes": "string",
  • "fermentationEndAt": "2019-08-24T14:15:22Z",
  • "finalGravity": "string",
  • "fermentationEndNotes": "string",
  • "brewLogEvents": [
    ]
}

BrewSessionRecipe

Retrieves the collection of BrewSessionRecipe resources.

Retrieves the collection of BrewSessionRecipe resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a BrewSessionRecipe resource.

Retrieves a BrewSessionRecipe resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "brewSession": {
    },
  • "totalCost": "string",
  • "id": 0,
  • "name": "string",
  • "type": "string",
  • "beerStyle": {
    },
  • "equipment": {
    },
  • "batchSize": "string",
  • "kettleBatchSize": "string",
  • "boilSize": "string",
  • "boilTime": 0,
  • "efficiency": "string",
  • "brewhouseEfficiency": "string",
  • "estOG": "string",
  • "estFG": "string",
  • "ebc": 0,
  • "ibu": 0,
  • "abv": "string",
  • "buOnGuRatio": "string",
  • "dryHopAmount": "string",
  • "estBoilGravity": "string",
  • "estPostBoilGravity": "string",
  • "note": "string",
  • "source": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "primaryAge": 0,
  • "primaryTemp": "string",
  • "secondaryAge": 0,
  • "secondaryTemp": "string",
  • "tertiaryAge": 0,
  • "tertiaryTemp": "string",
  • "age": 0,
  • "ageTemp": "string",
  • "fermentationNote": "string",
  • "carbonation": "string",
  • "carbonationTemp": "string",
  • "fermentables": [
    ],
  • "hops": [
    ],
  • "miscs": [
    ],
  • "yeasts": [
    ],
  • "targetWater": {
    },
  • "mash": {
    },
  • "medal": {
    }
}

BrewSession

Retrieves the collection of BrewSession resources.

Retrieves the collection of BrewSession resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a BrewSession resource.

Retrieves a BrewSession resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "name": "Brassin",
  • "number": 0,
  • "recipe": {
    },
  • "brewSessionRecipe": {
    },
  • "startedAt": "2019-08-24T14:15:22Z",
  • "brewLog": {
    },
  • "fermentationDevice": {
    },
  • "beerContainer": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Consumable

Retrieves the collection of Consumable resources.

Retrieves the collection of Consumable resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a Consumable resource.

Retrieves a Consumable resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "isForPackaging": true,
  • "amount": "string",
  • "name": "string",
  • "unit": "items",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "notes": "string",
  • "traceabilityNumber": "string"
}

Updates the Consumable resource.

Updates the Consumable resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated Consumable resource

amount
string
unitCost
string or null
lowAmountAlertValue
string or null
notes
string or null
traceabilityNumber
string or null

Responses

Request samples

Content type
application/merge-patch+json
{
  • "amount": "string",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "notes": "string",
  • "traceabilityNumber": "string"
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "isForPackaging": true,
  • "amount": "string",
  • "name": "string",
  • "unit": "items",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "notes": "string",
  • "traceabilityNumber": "string"
}

EmptyBeerPackage

Retrieves the collection of EmptyBeerPackage resources.

Retrieves the collection of EmptyBeerPackage resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a EmptyBeerPackage resource.

Retrieves a EmptyBeerPackage resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "amount": "string",
  • "beerPackageType": {
    },
  • "notes": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Updates the EmptyBeerPackage resource.

Updates the EmptyBeerPackage resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated EmptyBeerPackage resource

amount
string
notes
string or null
unitCost
string or null
lowAmountAlertValue
string or null
traceabilityNumber
string or null

Responses

Request samples

Content type
application/merge-patch+json
{
  • "amount": "string",
  • "notes": "string",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "amount": "string",
  • "beerPackageType": {
    },
  • "notes": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Fermentable

Retrieves the collection of Fermentable resources.

Retrieves the collection of Fermentable resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a Fermentable resource.

Retrieves a Fermentable resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "type": "string",
  • "amount": "string",
  • "yield": "string",
  • "color": 0,
  • "origin": "string",
  • "supplier": "string",
  • "notes": "string",
  • "potential": "string",
  • "name": "string",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Updates the Fermentable resource.

Updates the Fermentable resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated Fermentable resource

amount
string
notes
string or null
name
string
expireAt
string or null <date-time>
http://schema.org/Date
unitCost
string or null
lowAmountAlertValue
string or null
traceabilityNumber
string or null

Responses

Request samples

Content type
application/merge-patch+json
{
  • "amount": "string",
  • "notes": "string",
  • "name": "string",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "type": "string",
  • "amount": "string",
  • "yield": "string",
  • "color": 0,
  • "origin": "string",
  • "supplier": "string",
  • "notes": "string",
  • "potential": "string",
  • "name": "string",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

FermentationDeviceBrewBubbles

Retrieves the collection of FermentationDeviceBrewBubbles resources.

Retrieves the collection of FermentationDeviceBrewBubbles resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a FermentationDeviceBrewBubbles resource.

Retrieves a FermentationDeviceBrewBubbles resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "communicatedAt": "2019-08-24T14:15:22Z"
}

FermentationDeviceFloaty

Retrieves the collection of FermentationDeviceFloaty resources.

Retrieves the collection of FermentationDeviceFloaty resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a FermentationDeviceFloaty resource.

Retrieves a FermentationDeviceFloaty resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "communicatedAt": "2019-08-24T14:15:22Z"
}

FermentationDeviceIspindle

Retrieves the collection of FermentationDeviceIspindle resources.

Retrieves the collection of FermentationDeviceIspindle resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a FermentationDeviceIspindle resource.

Retrieves a FermentationDeviceIspindle resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "battery": "string",
  • "gravityUnit": "plato",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "communicatedAt": "2019-08-24T14:15:22Z"
}

FermentationDevicePlaato

Retrieves the collection of FermentationDevicePlaato resources.

Retrieves the collection of FermentationDevicePlaato resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a FermentationDevicePlaato resource.

Retrieves a FermentationDevicePlaato resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "communicatedAt": "2019-08-24T14:15:22Z"
}

FermentationDeviceTilt

Retrieves the collection of FermentationDeviceTilt resources.

Retrieves the collection of FermentationDeviceTilt resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a FermentationDeviceTilt resource.

Retrieves a FermentationDeviceTilt resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "color": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "name": "string",
  • "communicatedAt": "2019-08-24T14:15:22Z"
}

FermentationLog

Retrieves the collection of FermentationLog resources.

Retrieves the collection of FermentationLog resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

brewSession
string
brewSession[]
Array of strings

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a FermentationLog resource.

Creates a FermentationLog resource.

Authorizations:
ApiKey
Request Body schema:
application/ld+json
application/ld+json
application/json
text/html

The new FermentationLog resource

brewSession
required
string <iri-reference>
gravity
string or null
beerTemp
string or null
outsideTemp
string or null
bpm
integer or null

Responses

Request samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "brewSession": "../словник",
  • "gravity": "string",
  • "beerTemp": "string",
  • "outsideTemp": "string",
  • "bpm": 0
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "brewSession": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "gravity": "string",
  • "beerTemp": "string",
  • "outsideTemp": "string",
  • "bpm": 0,
  • "device": {
    }
}

Retrieves a FermentationLog resource.

Retrieves a FermentationLog resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "brewSession": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "gravity": "string",
  • "beerTemp": "string",
  • "outsideTemp": "string",
  • "bpm": 0,
  • "device": {
    }
}

Updates the FermentationLog resource.

Updates the FermentationLog resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated FermentationLog resource

gravity
string or null
beerTemp
string or null
outsideTemp
string or null
bpm
integer or null

Responses

Request samples

Content type
application/merge-patch+json
{
  • "gravity": "string",
  • "beerTemp": "string",
  • "outsideTemp": "string",
  • "bpm": 0
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "brewSession": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "gravity": "string",
  • "beerTemp": "string",
  • "outsideTemp": "string",
  • "bpm": 0,
  • "device": {
    }
}

Hop

Retrieves the collection of Hop resources.

Retrieves the collection of Hop resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a Hop resource.

Retrieves a Hop resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "amount": "string",
  • "origin": "string",
  • "alpha": "string",
  • "useType": "string",
  • "notes": "string",
  • "type": "string",
  • "form": "string",
  • "name": "string",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Updates the Hop resource.

Updates the Hop resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated Hop resource

amount
string
notes
string or null
name
string
expireAt
string or null <date-time>
http://schema.org/Date
unitCost
string or null
lowAmountAlertValue
string or null
traceabilityNumber
string or null

Responses

Request samples

Content type
application/merge-patch+json
{
  • "amount": "string",
  • "notes": "string",
  • "name": "string",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "amount": "string",
  • "origin": "string",
  • "alpha": "string",
  • "useType": "string",
  • "notes": "string",
  • "type": "string",
  • "form": "string",
  • "name": "string",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Misc

Retrieves the collection of Misc resources.

Retrieves the collection of Misc resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a Misc resource.

Retrieves a Misc resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "amount": "string",
  • "unit": "string",
  • "type": "string",
  • "notes": "string",
  • "name": "string",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Updates the Misc resource.

Updates the Misc resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated Misc resource

amount
string
notes
string or null
name
string
expireAt
string or null <date-time>
http://schema.org/Date
unitCost
string or null
lowAmountAlertValue
string or null
traceabilityNumber
string or null

Responses

Request samples

Content type
application/merge-patch+json
{
  • "amount": "string",
  • "notes": "string",
  • "name": "string",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "amount": "string",
  • "unit": "string",
  • "type": "string",
  • "notes": "string",
  • "name": "string",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Recipe

Retrieves the collection of Recipe resources.

Retrieves the collection of Recipe resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a Recipe resource.

Retrieves a Recipe resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "tastingToken": "string",
  • "visibility": "private",
  • "slug": "string",
  • "publishedAt": "2019-08-24T14:15:22Z",
  • "brewSessions": [
    ],
  • "labels": [
    ],
  • "totalCost": "string",
  • "id": 0,
  • "name": "string",
  • "type": "string",
  • "beerStyle": {
    },
  • "equipment": {
    },
  • "batchSize": "string",
  • "kettleBatchSize": "string",
  • "boilSize": "string",
  • "boilTime": 0,
  • "efficiency": "string",
  • "brewhouseEfficiency": "string",
  • "estOG": "string",
  • "estFG": "string",
  • "ebc": 0,
  • "ibu": 0,
  • "abv": "string",
  • "buOnGuRatio": "string",
  • "dryHopAmount": "string",
  • "estBoilGravity": "string",
  • "estPostBoilGravity": "string",
  • "note": "string",
  • "source": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "primaryAge": 0,
  • "primaryTemp": "string",
  • "secondaryAge": 0,
  • "secondaryTemp": "string",
  • "tertiaryAge": 0,
  • "tertiaryTemp": "string",
  • "age": 0,
  • "ageTemp": "string",
  • "fermentationNote": "string",
  • "carbonation": "string",
  • "carbonationTemp": "string",
  • "fermentables": [
    ],
  • "hops": [
    ],
  • "miscs": [
    ],
  • "yeasts": [
    ],
  • "targetWater": {
    },
  • "mash": {
    },
  • "medal": {
    }
}

Tasting

Retrieves the collection of Tasting resources.

Retrieves the collection of Tasting resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

recipe
string
recipe[]
Array of strings

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a Tasting resource.

Retrieves a Tasting resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "recipe": {
    },
  • "signature": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "color": 0,
  • "transparency": 0,
  • "foam": 0,
  • "sweetness": 0,
  • "salty": 0,
  • "sourness": 0,
  • "bitterness": 0,
  • "body": 0,
  • "carbonation": 0,
  • "alcohol": 0,
  • "astringency": 0,
  • "spicy": 0,
  • "personalScore": 0,
  • "personalNote": "string",
  • "aromas": {
    }
}

Water

Retrieves the collection of Water resources.

Retrieves the collection of Water resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a Water resource.

Creates a Water resource.

Authorizations:
ApiKey
Request Body schema:
application/ld+json
application/ld+json
application/json
text/html

The new Water resource

name
required
string or null
city
string or null
country
string
calcium
string
bicarbonate
string
sulfate
string
chloride
string
sodium
string
magnesium
string
ph
string
Default: 8
notes
string or null

Responses

Request samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "name": "string",
  • "city": "string",
  • "country": "string",
  • "calcium": "string",
  • "bicarbonate": "string",
  • "sulfate": "string",
  • "chloride": "string",
  • "sodium": "string",
  • "magnesium": "string",
  • "ph": 8,
  • "notes": "string"
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "city": "string",
  • "country": "string",
  • "calcium": "string",
  • "bicarbonate": "string",
  • "sulfate": "string",
  • "chloride": "string",
  • "sodium": "string",
  • "magnesium": "string",
  • "ph": 8,
  • "notes": "string"
}

Retrieves a Water resource.

Retrieves a Water resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "city": "string",
  • "country": "string",
  • "calcium": "string",
  • "bicarbonate": "string",
  • "sulfate": "string",
  • "chloride": "string",
  • "sodium": "string",
  • "magnesium": "string",
  • "ph": 8,
  • "notes": "string"
}

Updates the Water resource.

Updates the Water resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated Water resource

name
string or null
city
string or null
country
string
calcium
string
bicarbonate
string
sulfate
string
chloride
string
sodium
string
magnesium
string
ph
string
Default: 8
notes
string or null

Responses

Request samples

Content type
application/merge-patch+json
{
  • "name": "string",
  • "city": "string",
  • "country": "string",
  • "calcium": "string",
  • "bicarbonate": "string",
  • "sulfate": "string",
  • "chloride": "string",
  • "sodium": "string",
  • "magnesium": "string",
  • "ph": 8,
  • "notes": "string"
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "city": "string",
  • "country": "string",
  • "calcium": "string",
  • "bicarbonate": "string",
  • "sulfate": "string",
  • "chloride": "string",
  • "sodium": "string",
  • "magnesium": "string",
  • "ph": 8,
  • "notes": "string"
}

Yeast

Retrieves the collection of Yeast resources.

Retrieves the collection of Yeast resources.

Authorizations:
ApiKey
query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a Yeast resource.

Retrieves a Yeast resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "type": "string",
  • "form": "string",
  • "amount": "string",
  • "unit": "string",
  • "laboratory": "string",
  • "productId": "string",
  • "attenuation": "string",
  • "notes": "string",
  • "timesCultured": 0,
  • "name": "string",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Updates the Yeast resource.

Updates the Yeast resource.

Authorizations:
ApiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated Yeast resource

amount
string
notes
string or null
name
string
expireAt
string or null <date-time>
http://schema.org/Date
unitCost
string or null
lowAmountAlertValue
string or null
traceabilityNumber
string or null

Responses

Request samples

Content type
application/merge-patch+json
{
  • "amount": "string",
  • "notes": "string",
  • "name": "string",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "type": "string",
  • "form": "string",
  • "amount": "string",
  • "unit": "string",
  • "laboratory": "string",
  • "productId": "string",
  • "attenuation": "string",
  • "notes": "string",
  • "timesCultured": 0,
  • "name": "string",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "unitCost": "string",
  • "lowAmountAlertValue": "string",
  • "traceabilityNumber": "string"
}
Available formats: jsonld json html
Other API docs: