Lizenzbedingung

Übersicht

Technische Informationen zur API
GET https://[RootUrl]/apiinfos	Abfragen von technischen Informationen zum API
Produktionsdaten
POST https://[BaseUrl]/asphaltproductions	Übermittelt eine einzelne Asphalt-Produktion an Q Plant
POST https://[BaseUrl]/asphaltproductions/{asphaltProductionId}/asphaltbatches	Übermittelt eine einzelne Produktions-Charge an Q Plant
Betriebsdaten
POST https://[BaseUrl]/operatingdata	Eine Liste von Betriebsdaten an Q Plant übermitteln
Asphalt-Mischrezepte
PUT https://[BaseUrl]/asphaltrecipes/{recipeId}	Übermitteln oder Ändern eines Asphaltrezepts
DELETE https://[BaseUrl]/asphaltrecipes/{recipeId}	Löschen eines Asphaltrezepts
Produktionslose für Asphaltmischgut
GET https://[BaseUrl]/asphaltproductiontickets	Produktionslose abfragen

URL's

API Root URL [RootUrl]

Hierbei handelt es sich um die Basis URL des PlantX API's der spezifischen Q Plant Kundeninstanz. Die einzelnen Kunden unterscheiden sich jeweils durch ihre Subdomain. Die von Ihnen benötigte Root URL erhalten Sie zusammen mit dem Access-Key vom Q Point Support.

Sie lautet beispielsweise: https://asphaltag-api.q-plant.com

API Base URL [BaseUrl]

Hierbei handelt es sich um die Basis-URL, welche zum eigentlichen Aufruf der einzelnen Methoden verwendet wird. Sie basiert auf der Root-URL und erweitert diese durch den Bezug zu einer bestimmten API-Version und der Adressierung eines bestimmten Mischwerks. Sie folgt dem Schema: '..../vx/plants{plantId}/..' Die von Ihnen benötigte Base URL zu den einzelnen Mischwerken erhalten Sie zusammen mit dem Access-Key vom Q Point Support.

Sie lautet beispielsweise: https://asphaltag-api.q-plant.com/v8/plants/852f275a-2d00-4e59-8b12-d8f0f7b828e6

API Key

Für den Zugriff auf die in dem Dokument angeführten Endpunkte des API ist ein API-Key mit der Key-Role "plantXProductionRole" notwendig.

Technische Informationen zur API

GET https://[RootUrl]/apiinfos

GET https://[RootUrl]/apiinfos

Eine GET-Abfrage auf die API Root-Url liefert technische Informationen zur API. Aktuell handelt es sich hierbei um eine Liste der unterstützten API-Versionen. Ein Server kann gleichzeitig mehrere unterschiedliche Versionen des API unterstützen. Client-Systeme können hiermit zur Laufzeit prüfen, ob der angesprochene Server die benötigte Version des API anbietet.

Response

200 - OK

Response Body

{ 
 "supportedApiVersions": [
    {
      "version": "v7",
      "isDeprecated": false
    },
	{
      "version": "v6",
      "isDeprecated": true
    }
  ]
 //... 
}

Response Body (supportedApiVersions)
version string(40) required	Einzelne vom Cluster bzw. Server unterstützten API Versionen (Bsp: "v2").
isDeprecated bool default: false	Die angegebene Version ist veraltet und wird in absehbarer Zeit nicht mehr unterstützt. Dieser Hinweis gibt abhängigen Systemen die Möglichkeit, dem Anwender einen entsprechenden Hinweis anzuzeigen und ihn darauf hinzuweisen, dass ein Update des Systems notwendig ist.

Produktionsdaten

Unter den Begriff “Produktionsdaten” fallen alle relevanten Soll- und Ist-Werte, die im Zusammenhang mit einem Produktionsvorgang stehen. Es handelt sich um Bewegungsdaten, welche fortlaufend von der Produktionsteuerung an Q Plant übermittelt werden. Anlagenteile sind in der Lage, eigenständige Produktionsvorgänge auszuführen. Jeder zusammenhängende Produktionsvorgang auf einem Anlagenteil liefert einen entsprechenden strukturierten Protokolldatensatz. Hierbei handelt es sich um Produktionsdaten zum Mischvorgang, zur Vordosierung weiss, sowie der beiden Recycling Vordosierungen RAC und RAH.

Das Protokoll zu einem zusammenhängenden Produktionsvorgang ist hierarchisch aufgebaut. Die Basis bildet ein einzelner Datensatz, welcher die Produktion darstellt (AsphaltProduction), gefolgt von einer beliebigen Anzahl von Protokoll-Datensätzen der einzelnen Chargen (AsphaltBatches). Die Übermittlung des Produktionsdatensatzes erfolgt mit dem Start des Produktionsvorgangs - die Übermittlung der Chargendaten unmittelbar nach dem Produktionsende der betroffenen Charge.

Falls das Mischwerk keine Chargen-, sondern einen kontinuierlichen Produktionsprozess besitzt, liefert das Leitsystem keine echten, sondern virtuelle Chargendatensätze. Diese werden in einen konstanten zeitlichen Intervall von der Produktionssteuerung bereitgestellt und an Q Plant übermittelt.

Asphalt-Produktion (asphaltProductions)

Diese Ressource beschreibt eine einzelne Asphalt-Produktion bzw. einen Produktionsvorgang. Eine Produktion besteht aus mindestens einer einzelnen - in der Regel jedoch mehreren Chargen (asphaltBatches). Eine Charge besteht aus Rezeptsollwerten (batchRecipeComponents) und den zugehörigen Produktionsistwerten (batchComponents) der eingesetzten Materialkomponenten. Die einzelnen Ressourcen sind nachfolgend einzeln beschrieben.

Produktionsdatensätze werden einzeln vom Leitsystem an Q Plant übermittelt, sobald der Produktionsvorgang begonnen hat. Nach einem Unterbruch der Kommunikationsverbindung besteht auf Seite der Anlagensteuerung die Pflicht, die ausstehenden Produktionsdatensätze nachträglich an Q Plant zu übermitteln.

Eine Asphalt-Produktion an Q Plant übermitteln

POST https://[BaseUrl]/asphaltproductions

POST https://[BaseUrl]/asphaltproductions

Request Body (asphaltProductions)
id UUID	ID (GUID) der Asphaltproduktion, mit welcher diese systemweit eindeutig identifiziert wird. Fehlt die Angabe, wird die ID durch Q Plant festgelegt und anschliessend im Response Body zurückgegeben. Die ID wird anschliessend als Fremdschlüssel zur Verknüpfung der einzelnen Produktionschargen herangezogen (Siehe: asphaltBatch.asphaltProductionId).
identifier string(100)	Kennung der Produktion. Dies muss für das angegebene Mischwerk eindeutig sein.
plantIdentifier string(100) required	Eindeutige Kennung der Produktionsanlage, auf welcher die Produktion stattgefunden hat.
plantTypeIdentifier string(100)	Eindeutige Kennung des Mischanlagen-Typs ('batch', 'continous').
plantPartTypeIdentifier string(100) required	Eindeutige Kennung des Anlagenteils, auf dem die Produktion durchgeführt wurde: 'RAC' (Reclaimed Asphalt Cold), 'RAH' (Reclaimed Asphalt Hot), 'MIX' (Mixing), 'VAG' (Virgin Aggregates).
recipeId UUID conditionally required	ID (GUID) des verwendeten Rezepts. Pflicht, sobald der Rezeptstamm synchronisiert wird.
recipeIdentifier string(100) required	Eindeutige Kennung des produzierten Rezepts.
recipeName string(100) required	Name des produzierten Rezepts.
orderIdentifier string(100)	Fakultative Kennung der Bestellung, welche der Produktion zugrunde liegt.
orderName string(100)	Fakultativer Name der Bestellung, welche der Produktion zugrunde liegt.
executiveUser string(100)	Name des ausführenden Mischmeisters.
processIdentifier string(100)	Eindeutige Vorgangsidentifikation. Mithilfe dieser Identifikation lassen sich die gesetzlich relevanten Wiegevorgänge rückverfolgen.
productionBeginDt datetime required	Zeitpunkt der Produktion (Datum und Uhrzeit).
nominalQuantity decimal(10,3) must be greater or equal 0	Menge des produzierten Mischguts.
nominalQuantityUnit string(100) conditionally required	Einheit-Kurzzeichen der Menge. Pflichtfeld, falls 'productionQuantity' angegeben wurde.
asphaltBatches [asphaltBatches]	Liste mit den Chargendaten zu der Produktion. Diese Möglichkeit sollte nur im Ausnahmefall genutzt werden! Die bessere Alternative ist die getrennte bzw. einzelne Übermittlung der Chargendaten, sobald der Produktionsvorgang der Charge abgeschlossen ist!

Response

202 - Accepted Jeder valide Request wird entgegengenommen und asynchron verarbeitet.

Response Body (asphaltProductions)
id UUID required	Systemübergreifende eindeutige ID (UUID) der Produktion. Die ID wird anschliessend als Fremdschlüssel zur Verknüpfung der einzelnen Produktionschargen herangezogen (Siehe: asphaltBatch.asphaltProductionId).
...	Restliche Felder gemäss Request Body. Da die Produktion asynchron verarbeitet wird, wird sie nicht sofort im UI oder über die Schnitte verfügbar sein. Die Daten aus dem Request werden mit den Stammdaten von Q Plant abgeglichen. Einige Felder werden somit bei einer späteren Abfrage nicht genau gleich zurückgeliefert, wie sie in diesem Request gesendet werden.

Asphalt-Produktionscharge (asphaltBatches)

Die Ressource asphaltbatch (Asphalt-Produktionscharge) ist stets einer Asphaltproduktion zugeordnet und repräsentiert eine einzelne Charge einer zusammenhängenden Produktion. Es handelt sich um Soll- und Ist-Werte der jeweiligen Produktionscharge wie z.B. Menge, Produktionsdauer oder Mischtemperatur. Eine Charge besteht aus Rezeptsollwerten (batchRecipeComponents) und den zugehörigen Produktionsistwerten (batchComponents) der eingesetzten Materialkomponenten.

Chargendatensätze werden vorzugsweise einzeln vom Leitsystem an Q Plant übermittelt, sobald der Produktionsvorgang der Charge abgeschlossen ist. Nach einem Unterbruch der Kommunikationsverbindung besteht auf Seite der Anlagensteuerung die Pflicht, die ausstehenden Chargendatensätze nachträglich an Q Plant zu übermitteln.

Eine Produktionscharge an Q Plant übermitteln

POST https://[BaseUrl]/asphaltproductions/{asphaltProductionId}/asphaltbatches

POST https://[BaseUrl]/asphaltproductions/{asphaltProductionId}/asphaltbatches

Jede Produktionscharge gehört zu einer Asphaltproduktion. Deren Identifier (asphaltproductionId) ist deshalb Teil der aufgerufenen URL. Der Aufruf übermittelt eine neue Produktionscharge an Q Plant.

Path Params
asphaltProductionId UUID required	ID der Asphaltproduktion, zu der diese einzelne Charge gehört.

Request Body (asphaltBatches)
id UUID	ID bzw. GUID der Produktionscharge. Fehlt die Angabe, wird die ID durch Q Plant festgelegt und anschliessend im Response Body zurückgegeben.
sequenceNumber integer required must be greater than 0	Fortlaufende Chargennummer (Onebased) innerhalb der Produktion. Umfasst beispielsweise eine Produktion von 20 t Mischgut 5 aufeinanderfolgende Chargen, so besitzt die erste Charge die Sequence-Number '1' und die letzte Charge die Number '5'.
productionDt datetime required	Produktionszeitpunkt (Datum / Zeit).
productionQuantity decimal(10,3) required must be greater or equal 0	Effektiv produzierte Menge an Mischgut.
productionUnit string(40) required	Kurzzeichen Masseinheit der Produktionsmenge. In der Regel "kg".
mixDuration integer must be greater or equal 0	Effektive Mischdauer in [s].
dryMixDuration integer must be greater or equal 0	Effektive Trockenmischdauer in [s].
mixtureTemperature decimal(10,3)	Mischguttemperatur nach Verlassen des Mischers.
mixtureTemperatureUnit string(40) conditionally required	Kurzzeichen Masseinheit der Mischguttemperatur. Pflichtfeld, falls 'mixtureTemperature' angegeben wurde. In der Regel "°C".
sampleIdentifier string(100)	Kennung der Mischgutprobe. Nur enthalten, wenn auch eine Probe entnommen wurde.
recipeModification bool default: false	Zu Beginn dieser Charge wurde das Rezept verändert.
dryerCapacity integer must be greater than 0	Ist-Leistung des Trockners in "%".
recipeComponent [recipeComponent]	Liste der zur Herstellung des Mischguts vorgegebenen Rezeptsollwerte.
batchComponent [batchComponent] required	Liste der zur Herstellung des Mischguts verwendeten Produktionsistwerte.

Rezeptsollwerte zu einer Materialkomponente der Charge (recipeComponent)

Protokollierung der Asphalt-Rezepsollwerte, welche einer bestimmten Charge zugrunde liegen. Jeder Datensatz beschreibt dabei eine einzelne Rezeptkomponente und deren Soll-Werte. Die Rezeptdaten werden per Definition der ersten Charge einer Produktion angehängt. Bei allen nachfolgenden Chargen, welche auf Basis derselben Rezeptwerte hergestellt wurden, entfällt die Angabe. Bei einer allfälligen Rezeptanpassung während der Produktion, werden die Rezeptsollwerte bei derjenigen Charge erneut angehängt, bei welcher die Änderung wirksam wird

Rezeptsollwerte zu einer Materialkomponente der Charge (recipeComponent)
componentId UUID	ID (GUID) der Materialkomponente. Ist Pflicht, sobald der Stamm der Materialkomponenten ebenfalls synchron wird. Fehlt die Angabe, identifiziert das System die Materialkomponente mithilfe des Identifiers.
componentIdentifier string(100) required	Eindeutige Kennung der Materialkomponente.
componentName string(100) required	Bezeichnung der Materialkomponente.
componentTypeIdentifier string(100)	Eindeutige Kennung des Komponententyps der Materialkomponente.
componentTypeName string(100)	Bezeichnung des Komponententyps der Materialkomponente.
quantity decimal(10,3) required must be greater or equal 0	Rezept-Soll-Wert der Materialkomponente.
quantityUnit string(40) required	Masseinheit der Materialkomponente. In der Regel 'kg'.
phase integer default: 1 must be greater than 0	Mischphase, in der die Komponente beigegeben werden soll (OneBased).
additionTime integer	Zugabezeitpunkt der Komponente [s].

Produktionsistwerte zu einer Materialkomponente der Charge (batchComponent)

Beschreibung einer zur Produktion der Charge eingesetzten Materialkomponente. Jeder Datensatz repräsentiert eine dosierte Materialkomponente sowie die zugehörigen Ist-Werte. Diese Datensätze korrespondieren in der Regel mit den Rezeptwerten. Einzige Ausnahme bilden Materialkomponenten, welche von Hand durch den Mischmeister zugegeben wurden.

Produktionsistwerte zu einer Materialkomponente der Charge (batchComponent)
componentId UUID	ID (GUID) der Materialkomponente. Ist Pflicht, sobald der Stamm der Materialkomponente ebenfalls synchron wird. Fehlt die Angabe, identifiziert das System die Materialkomponente mithilfe des Identifiers.
componentIdentifier string(100) required	Eindeutige Kennung der Materialkomponente.
componentName string(100) required	Bezeichnung der Materialkomponente.
componentTypeIdentifier string(100)	Eindeutige Kennung des Komponententyps der Materialkomponente.
componentTypeName string(100)	Bezeichnung des Komponententyps der Materialkomponente.
toleranceError bool default: false	Bei der Dosierung der Komponenten hat die Abweichung zwischen Soll- und Ist-Wert den maximal zulässigen Toleranzwert überschritten. Der Toleranzwert wird durch das jeweilige Steuerungssystem festgelegt.
manualIntervention bool default: false	Der Anwender hat manuell in den automatischen Produktionsablauf eingegriffen.
automaticSetValueCorrection bool default: false	Die Sollmenge der Komponenten wurde aufgrund der effektiven Dosiermenge einer abhängigen Komponente korrigiert.
phase integer default: 1 must be greater than 0	Mischphase, in der die Komponente beigegeben wurde (OneBased).
storageIdentifier string(100)	Optionale Angabe des Quellspeichers aus dem die Komponente entnommen wurde.
storageTemperature decimal(10,3) must be greater than 0	Materialtemperatur bei Dosierung (Messung im Quellspeicher). Die Angabe entfällt, wenn keine Messung vorhanden ist.
storageTemperatureUnit string(40) conditionally required	Kurzzeichen Masseinheit der Materialtemperatur. Die Angabe entfällt, wenn keine Messung vorhanden ist.
nominalQuantity decimal(10,3) required must be greater or equal 0	Geforderte Soll-Menge der Materialkomponente pro Charge. Entspricht in der Regel dem Rezeptwert. Abweichungen entstehen hierbei nur bei allfälligen verfahrensbedingter Korrekturen durch die jeweilige Produktionssteuerung.
actualQuantity decimal(10,3) required must be greater or equal 0	Effektiv dosierte Menge (Ist-Menge).
quantityUnit string(40) required	Kurzzeichen Masseinheit der Soll- und Ist-Menge. In der Regel "kg".
surfaceMoistness decimal(10,3)	Oberflächenfeuchte in Massen-% der trockenen Gesteinskörnung.
moistnessIsMeasured bool default: false conditionally required	true: Der Feuchtewert wurde gemessen (Feuchtemessung). false: Der Feuchtewert wurde manuell durch den Anwender spezifiziert. Lediglich relevant, wenn auch ein Feuchtewert (SurfaceMoistness) existiert.
capacity decimal(10,3) must be greater than 0	Förderleistung des Doseurs (nur bei Vordosierung relevant).
capacityUnit string(40) conditionally required	Kurzzeichen Masseinheit der Förderleistung (nur bei Vordosierung relevant). In der Regel "%".

Response

202 - Accepted Jeder valide Request wird entgegengenommen und asynchron verarbeitet.

Response Body (asphaltBatches)
id UUID required	Systemübergreifende eindeutige ID (UUID) der Produktionscharge.
...	Restliche Felder gemäss Request Body. Die Werte werden so zurückgegeben, wie sie in Q Plant aktuell gespeichert sind.

Betriebsdaten (operatingData)

Die Ressource operatingData repräsentiert einen einzelnen Messwert, welcher während des Betriebs des Mischwerks ermittelt wurde.

Die verschiedenen Mischwerke unterscheiden sich hinsichtlich Art und Anzahl der vorhandenen Betriebsmittel. Als Folge ist auch das Set der ermittelten Betriebsdaten unterschiedlich. Die Ressource für die Betriebsdaten ist so aufgebaut, dass es für unterschiedliche Gegenstände, Quellen und Arten von Messwerten geeignet ist. Es umfasst neben dem eigentlichen Messwert samt Messeinheit, auch die Kontext-Information zu Messquelle und des Mischwerks. Hinzu kommt der Zeitpunkt der Messung sowie der Wertetyp. Der Wertetyp kann ein Einzelwert sein, der gemessen und sofort übermittelt wird - oder ein berechneter Wert, für den mehrere Einzelwerte zu einer bestimmten Kennzahl (Durchschnitt, Minimum/Maximum) aggregiert wurden.

Betriebsdaten werden im Allgemeinen stündlich - in Form einer Liste - vom Leitsystem an Q Plant übermittelt. Im Ausnahmefall kann dies jedoch auch täglich erfolgen. Zu den diskreten Ausführungszeitpunkten werden jeweils sämtliche Betriebsdaten exportiert, deren Fälligkeitszeitpunkt zwischen dem vorangehenden Ausführungszeitpunkt und der aktuellen Systemzeit liegt (Betrachtungszeitraum). Nach einem Unterbruch der Kommunikationsverbindung besteht auf Seite der Anlagensteuerung die Pflicht, die ausstehenden Werte nachträglich an Q Plant zu übermitteln. Sollte z.B. der Produktionsrechner zu einem oder mehreren Ausführungszeitpunkten ausgeschaltet sein, werden mit dem nächsten Export alle ausstehenden, d.h. auch die fehlenden Daten exportiert.

Welche der vorangehend aufgeführten Betriebsdaten bzw. Messpunkte auf einer bestimmten Anlage exportiert werden, ist von der jeweiligen Infrastruktur abhängig. Fehlt die entsprechende Messtechnik, so ist auch der zugehörige Messwert im Datentransfer nicht enthalten.

Eine Liste von Betriebsdaten an Q Plant übermitteln

POST https://[BaseUrl]/operatingdata

POST https://[BaseUrl]/operatingdata

Der Aufruf übermittelt die als Body angeführte Liste von Betriebsdaten an Q Plant.

Response Body

[
  {
    "plantIdentifier": "Asphalt-Nord",
    "dataSourceIdentifier": "Burner starts",
	//...
  },
  {
    "plantIdentifier": "Asphalt-Nord",
    "dataSourceIdentifier": "Burner operating hour",
	//...
  }
]

Request Body (operatingData)
plantIdentifier string(100) required	Eindeutige Kennung der Produktionsanlage, auf welcher die Produktion stattgefunden hat.
dataSourceIdentifier string(100) required	Bezeichner des Messpunktes. Er muss einem Wert aus der unten angeführten Liste entsprechen.
alias string(100)	Lokalisierter, d.h. in UI-Sprache übersetzter Name der Messquelle für das Steuersystem.
valueType string(40) required	Typ des Messwerts. Muss einem der folgenden Werte entsprechen: SNGL (= Einzelwert), DSUM (= Summe pro Tag), DAVG (= Durchschnitt pro Tag), DMAX (= Maximum pro Tag), DMIN (= Minimum pro Tag), HSUM (= Summe pro Stunde), HAVG (= Durchschnitt pro Stunde), HMAX (= Maximum pro Stunde), HMIN (= Minimum pro Stunde). Siehe unten angeführte Liste.
measureDt datetime required	Zeitpunkt der Messung bzw. Berechnung des Werts.
value decimal(10,3) required	Gemessener bzw. berechneter Wert.
unit string(40) required	Einheit des Werts.

Response

202 - Accepted Jeder valide Request wird entgegengenommen und asynchron verarbeitet.

Messpunkte

Im Feld dataSourceIdentifier ist jeweils einer der folgenden Werte möglich (siehe linke Spalte).

dataSourceIdentifier- Wert	Bedeutung	Typ	Anmerkungen
Weather rain	Niederschlagsmenge	Stunden-Mittelwert	mm/h
Weather rain	Niederschlagsmenge	Tagessumme	mm
Weather wind speed	Windgeschwindigkeit in der Umgebung der Produktionsanlage	Stunden-Mittelwert
Weather wind direction	Windrichtung in der Umgebung der Produktionsanlage	Stunden-Mittelwert
Weather outdoor temperature	Aussentemperatur in der Umgebung der Produktionsanlage	Stunden-Mittelwert
Weather air pressure	Luftdruck in der Umgebung der Produktionsanlage	Stunden-Mittelwert
Weather air humidity	Relative Luftfeuchte in der Umgebung der Produktionsanlage	Stunden-Mittelwert
Plant consumption electrical energy	Elektrischer Energieverbrauch der gesamten Anlage	Tagessumme
Plant consumption electrical power	Elektrische Leistung der gesamten Anlage	Tages-Maximalwert
Plant consumption electrical power	Elektrische Leistung der gesamten Anlage	Tages-Minimalwert
Plant consumption electrical power	Elektrische Leistung der gesamten Anlage	Tages-Mittelwert
Burner consumption light oil	Primärer Verbrauch des Brenners (Weiss) an Leichtoel	Tagessumme
Burner consumption heavy oil	Primärer Verbrauch des Brenners (Weiss) an Schweroel	Tagessumme
Burner consumption liquid gas	Primärer Verbrauch des Brenners (Weiss) an Flüssiggas	Tagessumme
Burner consumption natural gas	Primärer Verbrauch des Brenners (Weiss) an Erdgas	Tagessumme
Burner consumption BCD	Primärer Verbrauch des Brenners (Weiss) an BKS (BCD: brown coal dust)	Tagessumme
Burner support flame consumption light oil	Sekundärer Verbrauch des Brenners (Weiss) an Leichtoel für die Stützflamme	Tagessumme
Burner support flame consumption liquid gas	Sekundärer Verbrauch des Brenners (Weiss) an Flüssiggas für die Stützflamme	Tagessumme
Burner support flame consumption natural gas	Sekundärer Verbrauch des Brenners (Weiss) an Erdgas für die Stützflamme	Tagessumme
Burner starts	Anzahl der Brennereinschaltungen (Weiss)	Tagessumme
Burner operating hours	Betriebsdauer des Brenners (Hauptflamme)	Tagessumme
RA Burner consumption light oil	Primärer Verbrauch des RA-Brenners an Leichtoel	Tagessumme
RA Burner consumption heavy oil	Primärer Verbrauch des RA-Brenners an Schweroel	Tagessumme
RA Burner consumption liquid gas	Primärer Verbrauch des RA-Brenners an Flüssiggas	Tagessumme
RA Burner consumption natural gas	Primärer Verbrauch des RA-Brenners an Erdgas	Tagessumme
RA Burner consumption BCD	Primärer Verbrauch des RA-Brenners an BKS	Tagessumme
RA Burner support flame consumption light oil	Sekundärer Verbrauch des RA-Brenners an Leichtoel für die Stützflamme	Tagessumme
RA Burner support flame consumption liquid gas	Sekundärer Verbrauch des RA-Brenners an Flüssiggas für die Stützflamme	Tagessumme
RA Burner support flame consumption natural gas	Sekundärer Verbrauch des RA-Brenners an Erdgas für die Stützflamme	Tagessumme
RA Burner starts	Anzahl der Brennereinschaltungen	Tagessumme
RA Burner operating hours	Betriebsdauer des RA-Brenners (Hauptflamme)	Tagessumme
RAH consumption electrical energy	Elektrischer Energieverbrauch des RAH-Anlagenteils	Tagessumme
Thermal oil heating consumption light oil	Primärer Energieverbrauch der Thermaloelheizung an Leichtoel	Tagessumme
Thermal oil heating consumption heavy oil	Primärer Energieverbrauch der Thermaloelheizung an Schweroel	Tagessumme
Thermal oil heating consumption liquid gas	Primärer Energieverbrauch der Thermaloelheizung an Flüssiggas	Tagessumme
Thermal oil heating consumption natural gas	Primärer Energieverbrauch der Thermaloelheizung an Erdgas	Tagessumme
Thermal oil pumps consumption electrical energy	Elektrischer Energieverbrauch für Thermaloelpumpen	Tagessumme
EBIT heating consumption electrical energy	Gesamtverbrauch an elektrischer Energie der Bitumentankheizung inklusive Begleitheizung, ohne Dosierpumpen	Tagessumme
Bitumen tank n temperature	Lagertemperatur Bitumentankn	Tages-Mittelwert	Die Anzahl der Bitumentanks ist variabel. Der Platzhalter ‚n‘ repräsentiert die jeweilige Tanknummer
Filler heater consumption light oil	Verbrauch des Füllererhitzers an Leichtoel	Tagessumme
Filler heater consumption liquid gas	Verbrauch des Füllererhitzers an Flüssiggas	Tagessumme
Filler heater consumption natural gas	Verbrauch des Füllererhitzers an Erdgas	Tagessumme
Filler heater consumption electrical energy	Elektrischer Energieverrauch des Füllererhitzers	Tagessumme
Mastics asphalt heater consumption light oil	Verbrauch des Gussasphaltkochers an Leichtoel	Tagessumme
Mastics asphalt heater consumption liquid gas	Verbrauch des Gussasphaltkochers an Flüssiggas	Tagessumme
Mastics asphalt heater consumption natural gas	Verbrauch des Gussasphaltkochers an Erdgas	Tagessumme
Mastics asphalt heater consumption electrical energy	Elektrischer Energieverbrauch des Gussasphaltkochers	Tagessumme
Hot mix silo consumption electrical energy	Elektrischer Energieverbrauch des Mischgut-Verladesilos	Tagessumme
RA surface moisture	Relative Oberflächenfeuchte des RC Materials	Tages-Mittelwert
Virgin aggregat surface moisture	Relative Oberflächenfeuchte des Neumaterials (Weiss)	Tages-Mittelwert
Mixer operating hours	Betriebsdauer des Mischers	Tagessumme

Daten

Im Feld valueType ist jeweils einer der folgenden Werte möglich (siehe linke Spalte).

valueType- Wert	Bezeichnung	Beschreibung
SNGL	Einzelmesswert	Diskreter Einzelmesswert. Bei einem Export werden alle im Betrachtungszeitraum aufgezeichneten Einzelmesswerte exportiert.
DSUM	Tagessumme	Innerhalb des bezeichneten Tages aufgezeichnete Wertänderung des Messpunktes. In der Regel positiv, kann jedoch im Ausnahmefall auch negativ sein. Bei einem Export wird für jeden abgeschlossenen Tag des Betrachtungszeitraums eine Tagessumme berechnet.
DAVG	Tages-Mittelwert	Mittelwert aller während dem angegebenen Tag aufgezeichneten Messwerte. Bei einem Export wird für jeden abgeschlossenen Tag des Betrachtungszeitraums ein Tages-Mittelwert berechnet.
DMAX	Tages-Maximalwert	Höchster Wert aller während dem angegebenen Tag aufgezeichneten Messwerte. Bei einem Export wird für jeden abgeschlossenen Tag des Betrachtungszeitraums ein Tages-Maximalwert berechnet.
DMIN	Tages-Minimalwert	Kleinster Wert aller während dem angegebenen Tag aufgezeichneten Messwerte. Bei einem Export wird für jeden abgeschlossenen Tag des Betrachtungszeitraums ein Tages-Minimalwert berechnet.
HSUM	Stundensumme	Innerhalb der bezeichneten Stunde aufgezeichnete Wertänderung des Messpunktes. In der Regel positiv, kann jedoch im Ausnahmefall auch negativ sein. Bei einem Export wird für jede abgeschlossene Stunde des Betrachtungszeitraums eine Stundensumme berechnet
HAVG	Stunden-Mittelwert	Mittelwert aller während der angegebenen Stunde aufgezeichneten Messwerte. Bei einem Export wird für jede abgeschlossene Stunde des Betrachtungszeitraums ein Stunden-Mittelwert berechnet.
HMAX	Stunden-Maximalwert	Höchster Wert aller während der angegebenen Stunden aufgezeichneten Messwerte. Bei einem Export wird für jede abgeschlossene Stunde des Betrachtungszeitraums ein Stunden-Maximalwert berechnet.
HMIN	Stunden-Minimalwert	Kleinster Wert aller während den angegebenen Stunden aufgezeichneten Messwerte. Bei einem Export wird für jede abgeschlossene Stunde des Betrachtungszeitraums ein Stunden-Minimalwert berechnet.

Asphalt-Mischrezepte

Diese Ressource repräsentiert ein Mischrezept zur Herstellung von Asphalt-Mischgut. Es handelt sich hierbei nicht um alle Angaben, welche für die Herstellung notwendig sind, sondern lediglich um die Kopfdaten.

Übermitteln oder Ändern eines Asphaltrezepts

PUT https://[BaseUrl]/asphaltrecipes/{recipeId}

PUT https://[BaseUrl]/asphaltrecipes/{recipeId}

Die Methode übermittelt die Daten eines Asphaltrezepts vom Leitsystem zu Q Plant. Je nachdem, ob die übergebene 'recipeId' schon existiert oder nicht, wird in Q Plant ein neues Rezept angelegt oder das bestehende überschrieben.

Path Params
recipeId UUID required	Global eindeutige ID (UUID) des Mischrezepts, welches übermittelt oder geändert wird.

Request Body (asphaltRecipes)
identifier string(100) required	Für den Anwender sichtbare eindeutige Kennung des Rezepts.
name string(100)	Für den Anwender sichtbare frei formulierbare Bezeichnung des Rezepts.
plantIdentifier string(100) required	Kennung der Anlage, für welches das Rezept erstellt ist.
recipeCategory string(100)	Kennung der Kategorie, zu der das Rezept gehört.
initialInspectionIdentifier string(100)	Kennung der Erstprüfung des Rezepts.
....	tbd

Response

200 - OK Falls der Datensatz aktualisiert wurde.
201 - Created Falls der Datensatz neu angelegt wurde.

Response Body (asphaltRecipes)
id UUID required	Systemübergreifende eindeutige ID (UUID) des Asphaltrezepts.
...	Restliche Felder gemäss Request Body. Die Werte werden so zurückgegeben, wie sie in Q Plant aktuell gespeichert sind.

Löschen eines einzelnen Asphaltrezepts

DELETE https://[BaseUrl]/asphaltrecipes/{recipeId}

DELETE https://[BaseUrl]/asphaltrecipes/{recipeId}

Die Methode löscht das per 'recipeId' adressierte Rezept aus Q Plant.

Path Params
recipeId UUID required	Global eindeutige ID (UUID) des zu löschenden Mischrezepts.

Response

200 - OK
404 - Not Found Falls kein Rezept mit der angegebenen ID existiert

Produktionslose für Asphaltmischgut

Diese Ressouce repräsentiert die Vorgabe für eine zeitlich zusammenhängende Produktion von Asphalt-Mischgut.

Produktionslose abfragen

GET https://[BaseUrl]/asphaltproductiontickets?from={datetime}&to={datetime}&skip={integer}&take={integer}

GET https://[BaseUrl]/asphaltproductiontickets?from={datetime}&to={datetime}&skip={integer}&take={integer}

Die Methode liefert die für den angegebenen Zeitraum geplanten Produktionslose der adressierten Mischanlage.

Query Params
from datetime required	Beginn des Bezugszeitraums der Tickets. Der Aufruf liefert sämtliche Tickets, deren geplanten Produktionsstart (scheduledProductionDt) sich mit dem angegebenen Bezugszeitraum schneidet.
to datetime required	Ende des Bezugszeitraums der Tickets (siehe vorangehendes Feld "from").
skip integer 0 <= Wert	Index im Resultset. Anzahl Datensätze, welche in Resultset zu überspringen sind. Wird verwendet um nacheinander mehrere Data-Pages abzurufen.
take integer 0 < Wert <= default default: 200	Maximale Anzahl der als Response Body zurückgelieferten Datensätze. Falls das Feld fehlt oder der angegebene Wert über dem default-Wert liegt, liefert die Anfrage maximal die als "default" festgelegte Anzahl Datensätze!

Response

200 - OK

Response Body

{ 
"pagination": { 
			"offset": 0,
	 		"count": 50,
			"total": 465,
			"hasMoreEntries":  true,
			"changedTillDt": "2020-03-24T14:33:23"
	 },
"items": [
	 //... 
	]
}

Response Body (asphaltProductionTickets)
id UUID required	Systemübergreifende eindeutige ID (GUID) des Produktions-Tickets. Diese wird von Q Plant festgelegt.
identifier string(100) required	Kennung des Produktionsloses. Wird durch Q Plant generiert. In der Regel handelt es sich hierbei um eine Laufnummer und wird mit jedem neuen Anlegen des Produktionsplans neu festgelegt.
scheduledProductionDt datetime required	Geplanter Produktionszeitpunkt.
recipeId UUID required	GUID des zu produzierenden Mischgutrezepts.
recipeIdentifier string(100) required	Kennung des zu produzierenden Mischgutrezepts.
quantity decimal(10,3) required must be greater than 0	Geplante Produktionsmenge des spezifizierten Mischguts.
quantityUnit string(40) required	Masseinheit der Mengenangabe.
targetStorage string(100)	Kennung des Heissmischgutsilos, in welchem das Produkt gelagert werden soll (Produktions-Ziel).
changedDt datetime required	Zeitpunkt der letzten Mutation. Lässt sich zur Änderungserkennung oder zur Konfliktlösung verwenden.

public

REST API V8 - Reference PlantX Production

Lizenzbedingung

Übersicht

URL's

Technische Informationen zur API

Response

Response Body

Produktionsdaten

Asphalt-Produktion (asphaltProductions)

Eine Asphalt-Produktion an Q Plant übermitteln

Response

Asphalt-Produktionscharge (asphaltBatches)

Eine Produktionscharge an Q Plant übermitteln

Rezeptsollwerte zu einer Materialkomponente der Charge (recipeComponent)

Produktionsistwerte zu einer Materialkomponente der Charge (batchComponent)

Response

Betriebsdaten (operatingData)

Eine Liste von Betriebsdaten an Q Plant übermitteln

Response Body

Response

Messpunkte

Daten

Asphalt-Mischrezepte

Übermitteln oder Ändern eines Asphaltrezepts

Response

Löschen eines einzelnen Asphaltrezepts

Response

Produktionslose für Asphaltmischgut

Produktionslose abfragen

Response

Response Body