Lizenzbedingung

Übersicht

Technische Informationen zur API

Technische Informationen zur API
GET https://[RootUrl]/apiinfos	Abfragen von technischen Informationen zum API
Produktionsdaten Asphaltmischgut
GET https://[RootUrl]/asphaltproductions	Abfragen der Produktionsdaten von Asphaltmischgut

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 "plantXQualityControl" notwendig.

Technischen Informationen zur API

GET https://[RootUrl]/apiinfos

GET https://[RootUrl]/apiinfos

Eine GET-Abfrage auf die API Root-Url liefert technischen 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 System die Möglichkeit dem Anwender einen entsprechenden Hinweis anzuzeigen und ihn darauf hinzuweisen, dass ein Update des Systems notwendig ist.

Produktionsdaten von Asphaltmischgut

Diese Ressource repräsentiert die Produktions- inklusive Chargendaten von Asphalt-Mischgut.

Produktionsdaten abfragen

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

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

Die Methode liefert die zu dem angegebenen Zeitraum vorliegenden Produktionslose der adressierten Mischanlage.

Query Params
from datetime required	Beginn des Bezugszeitraums der Produktionen. Der Aufruf liefert sämtliche Produktionen deren Produktionsstart (asphaltProductuions.productionBeginDt), sich mit dem angegebenen Bezugszeitraum schneidet.
to datetime required	Ende des Bezugszeitraums der Produktionen (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: 10	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 Anfragen maximal die als "default" festgelegte Anzahl Datensätze!

Response

200 - OK

Response Body

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

Request Body (asphaltProductions)
id UUID required	ID (GUID) der Asphaltproduktion, mit welcher diese systemweit eindeutig identifiziert wird.
Identifier string(100)	Fakultative Kennung des Produktionstickets.
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 aus dem Q Plant Rezeptstamm. Wird mitgeliefert, falls ein synchronisierter Rezeptstamm vorliegt.
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.

Asphalt-Produktionscharge (asphaltBatches)

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

Request Body (asphaltBatches)
id UUID required	ID bzw. GUID der Produktionscharge.
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	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 zu Grunde liegen. Jeder Datensatz beschreibt dabei eine einzelne Rezeptkomponente und deren Sollwerte. 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 required	ID (GUID) der Materialkomponente.
componentIdentifier string(100) required	Eindeutige Kennung der Materialkomponente
componentName string(100) required	Bezeichnung der Materialkomponente
componentTypeIdentifier string(100)	Eindeutige Kennung des Komponenttyps der Materialkomponente
componentTypeName string(100)	Bezeichnung des Komponententyps der Materialkomponente
quantity decimal(10,3) required must be greater or equal 0	Rezept-Sollwert der Materialkomponente
quantityUnit string(40) required	Masseinheit der Materialkomponente. In der Regel 'kg'.
phase integer must be greater than 0	Mischphase, in der die Komponenten beigegeben werden soll (OneBased)
additionTime integer	Zugabezeitpunkt der Komponente [s]

Produktions-Istwerte zu einer Materialkomponente der Charge (batchComponent)

Beschreibung einer zur Produktion der Charge eingesetzten Materialkomponenten. Jeder Datensatz repräsentiert eine dosierte Materialkomponente sowie die zugehörigen Istwerte. 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 required	ID (GUID) der Materialkomponente.
componentIdentifier string(100) required	Eindeutige Kennung der Materialkomponente
componentName string(100) required	Bezeichnung der Materialkomponente
componentTypeIdentifier string(100)	Eindeutige Kennung des Komponenttyps der Materialkomponente
componentTypeName string(100)	Bezeichnung des Komponententyps der Materialkomponente
toleranceError bool	Bei der Dosierung der Komponenten hat die Abweichung zwischen Soll- und Istwert den maximal zulässigen Toleranzwert überschritten. Der Toleranzwert wird durch das jeweilige Steuerungssystem festgelegt.
manualIntervention bool	Der Anwender hat manuell in den automatischen Produktionsablauf eingegriffen
automaticSetValueCorrection bool	Die Sollmenge der Komponenten wurde aufgrund der effektiven Dosiermenge einer abhängigen Komponente korrigiert.
phase integer must be greater than 0	Mischphase, in der die Komponenten 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 Istmenge. In der Regel "kg"
surfaceMoistness decimal(10,3)	Oberflächenfeuchte in Massen-% der trockenen Gesteinskörnung.
moistnessIsMeasured bool 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 "%".

public

REST API V8 - Reference Plant X Quality Control

Lizenzbedingung

Übersicht

URL's

Technischen Informationen zur API

Response

Response Body

Produktionsdaten von Asphaltmischgut

Produktionsdaten abfragen

Response

Asphalt-Produktionscharge (asphaltBatches)

Rezeptsollwerte zu einer Materialkomponente der Charge (recipeComponent)

Produktions-Istwerte zu einer Materialkomponente der Charge (batchComponent)