Zum Hauptinhalt springen

HACCP list

GET 
https://app.connectedcooking.com/api/public/haccp-service/haccps

Returns a paginated list of HACCP batches.

Request​

Query Parameters

    groupId number

    Id of the group and subgroups to filter batches for.

    Example: 1
    finished boolean

    Only return batches that have finished.

    Default value: true
    Example: true
    incomplete boolean

    Also return batches that have not yet finished.

    Default value: false
    Example: false
    search string

    Filter batches by the provided search string (applicable fields name, deviceSerialNumber).

    Example: MyDevice1
    filter string

    Possible values: [cooking, care, cookingWithWarnings]

    Filter batches by their type or state.

    Example: cooking
    entries boolean

    Return detailed measurements of the batch.

    Default value: false
    Example: true
    from string

    Start date from which entries are to be displayed. Has to be used together with to.

    Example: 2024-01-01
    to string

    End date from which entries are to be displayed. Has to be used together with from.

    Example: 2024-01-31
    sort string

    Possible values: [id,asc, id,desc, name,asc, name,desc, startDate,asc, startDate,desc, finished,asc, finished,desc]

    The property/properties and direction the list should be sorted. Multiple sort params are supported.

    Example: name,asc
    page number

    The index of the page.

    Example: 1
    size number

    Possible values: >= 1 and <= 100

    The number of entries to return per page.

    Default value: 20
    Example: 20

Responses​

Response Headers
    x-total-count

    The number of total devices

    Example: 69
    link

    Pagination links for first, last and next page.

    Example: </api/public/haccp-service/haccp?page=1&size=20>; rel="next",</api/public/haccp-service/haccp?page=7&size=20>; rel="last",</api/public/haccp-service/haccp?page=0&size=20>; rel="first"
Schema
    idnumber

    The unique id.

    groupIdnumber

    The id of the device's parent group.

    groupNamestring

    The name of the device's parent group.

    batchIdnumber

    The unique id of the HACCP batch related to the device. (Can be found in HACCP data on the device)

    namestring

    The name of the batch. (The name of the executed program)

    appVersionstring

    The version of the application software that was installed on the device.

    scriptVersionstring

    The version of the ExpertScript software that was installed on the device.

    startDatestring

    The date and time the batch was started on the device.

    tempUnitstring

    The temperature unit the batch was recorded with. (C for Celsius or F for Fahrenheit)

    categoryImagestring

    An representative image for the category.

    deviceNamestring

    The name of the device that executed the batch.

    deviceSerialNumberstring

    The serial number of the device that executed the batch.

    finishedboolean

    Whether the batch is finished on the device or not.

    durationnumber

    The total amount of time in seconds the batch took to execute.

    foodTempTargetValueReachedboolean

    Whether the required core temperature set by the cooking program was reached.

    energyConsumptionstring

    The amount of energy the batch consumed in kWh.

    openDoorCountnumber

    The total number of door openings during execution.

    careRecipeboolean

    Whether the program that was executed was a cleaning program or not.

    entries object[]

    List of measurements and event during the cooking process.

  • Array [
    • idnumber

    The unique id of the event.

    startOffsetnumber

    Number of seconds since startDate.

    doorStatusstring

    The status of the door. (Only applicable for iComib/iHexagon/SCC devices)

    Possible values: [open, close]

    lidStatusstring

    The lid status of the device. (Only applicable for iVario/VCC devices)

    Possible values: [up, down]

    modeOrCartReceiptstring

    The cooking mode of the event/measurement.

    chamberTemperaturenumber

    The temperature inside the cooking chamber.

    foodTemperatureSetnumber

    The target food temperature that must be reached for the cooking process.

    foodTemperaturenumber

    The food temperature measured with an core probe.

    powernumberdeprecated

    Whether the device has power optimization activated. Only applicable for SCC devices.

    Default value: 0
    powerHalfnumber

    Cooking program used half energy feature to reduce energy consumption.

    Possible values: [0, 1]

    eventCodenumber

    The event that occured. See Event code list

  • ]
    • pvalueCalculationFactornumber

    TODO

    pvalueReferenceTemperaturenumber

    TODO

    pvalueStartTemperaturenumber

    TODO

    pvalueTargetValueReachedboolean

    Whether the P-Value target was reached.

Authorization: http

name: bearerAuthtype: httpscheme: bearerbearerFormat: JWTdescription: The `access token` of the `API client` you requested with `/access`.
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://app.connectedcooking.com/api/public/haccp-service/haccps");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://app.connectedcooking.com
Auth
Parameters
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!