Integration Öko-Fußabdruck

Öko-Fußabdrücke können über vordefinierte REST API's in andere Systeme integriert werden

Dieses Dokument beschreibt die APIs, die speziell zur Unterstützung der Integration in IFS Öko-Fußabdruck entwickelt wurden, aber auch einige der Standard-Entity-APIs, die üblicherweise für die Anbindung externer Systeme verwendet werden können.
Nicht, dass es innerhalb der Öko-Fußabdruck-Komponente mehr Standard-Entity-Api's gibt, die für Integrationszwecke verwendet werden könnten. Weitere Informationen und Details sind im API Explorer verfügbar.

In diesem Dokument beschrieben:

API für die Integration des Öko-Fußabdrucks

API Prognose Beschreibung
Nichtkonforme Artikel erhalten Ecoman Meldedienst Zurückgeben einer Liste (JSON-Format) von Artikeln, die nicht den Anforderungen entsprechen.
CreateOrModifySubstance EcoSubstanceService Diese API erstellt neue Datensätze für Substanzdaten. Diese Daten werden in drei verschiedenen Einheiten gespeichert, und die API verteilt die Eingabedaten entsprechend. Ist die Substanz-ID bereits vorhanden, werden stattdessen die Aufzeichnungen aktualisiert. Die Eingabe erfolgt in Form eines Anordnung, so dass mehrere Datensätze in einem Aufruf erstellt werden können.
DeleteSubstance EcoSubstanceService Diese API löscht eine vorhandene Substanz-ID und alle Daten in allen Entitäten. Vorhandene Geschäftslogik wird verwendet, so dass die verwendeten Daten nicht gelöscht werden können.
GetSubstanceInfo EcoSubstanceService Gibt alle Daten für eine gegebene Substanz-ID zurück. Wird keine Substanz-ID übergeben, werden alle registrierten Substanzen zurückgegeben.
EcomanRequirementEntity EcomanRequirementEntity Eingeben
Erhalten: Liefert Daten für eine bestimmte Ökofußabdruck-Anforderung. Wenn keine Anforderungskennung und Revision übergeben werden, werden alle registrierten Anforderungen zurückgegeben.
Buchen: Erzeugt eine neue Anforerungs-ID und Revision.
Patch: Aktualisiert eine bestehende Anforderungs-/Revisionskombination. Die vorhandene Geschäftslogik wird für die Validierung verwendet.
Entf: Löscht eine bestehende Anforderung/Revisionskombination. Die vorhandene Geschäftslogik wird für die Validierung verwendet. Außerdem muss ein Etag als If-Match-Parameter bereitgestellt werden, um sicherzustellen, dass die neueste Version gelöscht wird. Dieses Etag kann mit dem Aufruf „Erhalten“ abgerufen werden.
EcomanRegulatedSubstEntity EcomanRegulatedSubstEntity Eingeben
Erhalten: Liefert Substanzdaten für eine bestimmte Öko-Fußabdruck-Anforderung/Revision. Werden keine Anforderungs-ID und Revision übergeben, werden alle registrierten geregelten Stoffdatensätze zurückgegeben.
Buchen: Erzeugt einen neuen Datensatz für eine geregelte Substanz für eine Bedarfsänderung
Patch: Aktualisiert einen bestehenden Datensatz einer geregelten Substanz für eine Anforderungsrevision. Vorhandene Geschäftslogik wird für die Validierung verwendet
Entf: Löscht einen bestehenden Datensatz zu einer geregelten Substanz. Die vorhandene Geschäftslogik wird für die Validierung verwendet. Außerdem muss ein Etag als If-Match-Parameter bereitgestellt werden, um sicherzustellen, dass die neueste Version gelöscht wird. Dieses Etag kann mit dem Aufruf „Erhalten“ abgerufen werden.

Nichtkonforme Artikel erhalten/API

Diese API gibt nicht-konforme Artikel zurück, d. h. Artikel mit einer Substanz, der die Schwellenwerte der Anforderung nicht erfüllt. Der Datenextrakt basiert auf Ausgabedaten aus Bedarfsanalysen in Öko-Fußabdruck.

Abhängig von den Eingabeparametern gibt die API eine Liste aller nicht-konformen Artikel zurück, einschließlich: Substanz, Emissionen, Artikeldaten Öko-Fußabdruck, verknüpfter Artikel (übergeordneter Artikel), oberer Artikel und Unterdatensätze mit dem vollständigen Produktstücklistenpfad bis zum oberen Artikel. Die Unterdatensätze (ProductPath) enthalten Artikelgrunddaten, den übergeordneter Artikel und die Strukturebene für jeden Artikel.

Die Eingabeparameter sind:

Erforderlich

Optional

Bild 1 – Artikelstruktur

Nicht konforme Artikel in Bild 1 sind Artikel mit rot markierten nicht konformen Stoffen. Als Beispiel enthält der Auszug dann die folgenden fünf Datensätze:

Datensatz Artikel Stufe Substanz Verlinkter Artikel Oberster Artikel Pfa -Unterdatensätze
1 COM-B-L3 3 Substanz 1 COM-A-L2 MF Artikelnr. Produkt Artikelebene
COM-A-L2 2
COM-A-L1 1
MF 0
2 COM-B-L3 3 Substanz 2 COM-A-L2 MF Artikelnr. Produkt Artikelebene
COM-A-L2 2
COM-A-L1 1
MF 0
3 COM-A-L2 2 Substanz 3 COM-A-L1 MF Artikelnr. Produkt Artikelebene
COM-A-L1 1
MF 0
4 COM-B-L2 2 Substanz 2 COM-A-L1 MF Artikelnr. Produkt Artikelebene
COM-A-L1 1
MF 0
5 COM-B-L1 1 Substanz 4 MF MF

Tabelle 1 – Datensätze des Auszugs

Substanz erstellen oder ändern

Die Eingabeparameter werden im Array-Format gesendet. Weitere Informationen zur Datenzuordnung usw. sind im API Explorer verfügbar.

Erforderlich

DeleteSubstance

Die zu löschende Substanz wird als Parameter in der URL übergeben. Einzelheiten finden Sie im API Explorer.

Erforderlich

GetSubstanceInfo

Die abzurufende Substanz wird als Parameter in der URL übergeben. Weitere Informationen über die Datenzuordnung usw. finden Sie im API Explorer.

Erforderlich

Anforderungseinheit für Ecoman - Abrufen

Die abzurufende Registrierung wird als Parameter in der URL übergeben. Weitere Informationen über die Datenzuordnung usw. finden Sie im API Explorer.
Die Filterung nach anderen Attributen ist auch möglich, wenn keine Schlüssel übergeben werden

Erforderlich

Anforderungseinheit für Ecoman - Beitragen

Die zu erstellende Anforderung wird als json-Array übergeben. Weitere Informationen über die Datenzuordnung usw. finden Sie im API Explorer.

Erforderlich

Anforderungseinheit für Ecoman - Patch

Die Schlüssel für den zu aktualisierenden Datensatz werden in der URL übergeben. Andere Daten werden als json-Array gesendet. Weitere Informationen über die Datenzuordnung usw. finden Sie im API Explorer.

Erforderlich

Anforderungseinheit für Ecoman - Löschen

Die Schlüssel für den zu löschenden Datensatz werden in der URL übergeben, Einzelheiten finden Sie im API Explorer.

Erforderlich

Ecoman-Einheit für regulierte Substanzen - Abrufen

Die abzurufenden regulierten Substanzdaten werden als Parameter in der URL übergeben. Weitere Informationen über die Datenzuordnung usw. finden Sie im API Explorer.
Die Filterung nach anderen Attributen ist auch möglich, wenn keine Schlüssel übergeben werden

Erforderlich

Ecoman-Einheit für regulierte Substanzen - Beitragen

Die Schlüssel für den zu erstellenden Datensatz werden in der URL übergeben. Zusätzliche Daten werden als json-Array übergeben. Weitere Informationen über die Datenzuordnung usw. finden Sie im API Explorer.

Erforderlich

Ecoman-Einheit für regulierte Substanzen - Patch

Die Schlüssel für den zu aktualisierenden Datensatz werden in der URL übergeben. Zusätzliche Daten werden als json-Array übergeben. Weitere Informationen über die Datenzuordnung usw. finden Sie im API Explorer.

Erforderlich

Ecoman-Einheit für regulierte Substanzen - Löschen

Die Schlüssel für den zu löschenden Datensatz werden in der URL übergeben. Weitere Informationen finden Sie unter API Explorer.

Erforderlich