エコフットプリントの統合

エコフットプリントは、定義済みの REST API を使用して他のシステムに統合できます。

このドキュメントでは、IFS エコフットプリントへの統合をサポートするために特別に開発された API について説明しますが、外部システムとのインターフェイスに一般的に使用できる標準エンティティ API についてもいくつか説明します。
エコフットプリント コンポーネント内には、統合目的で使用できる標準エンティティ API が他にも存在します。詳しい情報については、API エクスプローラを参照してください。

このドキュメントで説明されている内容:

エコフットプリント統合 API

API 予測 説明
GetNonConformingParts EcomanReporting サービス 要件に適合しない品目のリスト (JSON フォーマット) を返品します。
物質の作成または変更 エコサブスタンスサービス この API は、化学物質データの新しいレコードを作成します。このデータは 3 つの異なるエンティティに保存され、API はそれに応じて入力データを配布します。化学物質ID がすでに存在する場合は、代わりに記録が更新されます。入力は配列として指定されるため、1 回の呼び出しで複数のレコードを作成できます。
物質の削除 エコサブスタンスサービス この API は、すべてのエンティティ内の既存の化学物質ID とそのすべてのデータを削除します。使用中のデータは削除できないように、既存のビジネス ロジックが使用されます。
物質情報を取得する エコサブスタンスサービス 指定された物質 ID のすべてのデータを返品します。物質 ID が渡されない場合、登録されているすべての物質が返されます。
EcomanRequirementEntity EcomanRequirementEntity 方法
適用条件:指定されたエコフットプリント要件のデータを返品します。要件 ID とリビジョンが渡されない場合、登録されているすべての要件が返されます。
事後請求:新しい要件 ID とリビジョンを作成します。
パッチ:既存の要件/リビジョンの組み合わせを更新します。既存のビジネス ロジックが検証に使用されます。
連番:既存の要件/リビジョンの組み合わせを削除します。既存のビジネス ロジックが検証に使用されます。また、最新バージョンが削除されるようにするには、If-match パラメータとして Etag を提供する必要があります。この Etag は、Get call を使用して取得できます。
EcomanRegulatedSubstEntity EcomanRegulatedSubstEntity 方法
適用条件:指定されたエコ フットプリント要件/リビジョンの化学物質データを返品します。要件 ID とリビジョンが渡されない場合、登録されているすべての規制化学物質レコードが返されます。
事後請求:要件のリビジョンのために新しい規制化学物質レコードを作成します
パッチ:要件の改訂に合わせて既存の規制化学物質レコードを更新します。既存のビジネスロジックを検証に使用します
連番:既存の規制化学物質レコードを削除します。既存のビジネス ロジックが検証に使用されます。また、最新バージョンが削除されるようにするには、If-match パラメータとして Etag を提供する必要があります。この Etag は、Get call を使用して取得できます。

GetNonConformingParts API

この API は、不適合品目、つまり要件のしきい値を満たさない化学物質を含む品目を返します。データ抽出は、エコフットプリントの要件分析からの出力データに基づいています。

入力パラメータに応じて、API は、化学物質、排出量、エコフットプリント品目情報、リンクされた品目 (親品目)、トップ品目、およびトップ品目までの完全な製品構成パスを含むサブレコードを含む、すべての不適合品目のリストを返します。サブレコード (ProductPath) には、品目の基本情報、親品目、および各品目の構成レベルが含まれます。

入力パラメータは次のとおりです:

必須

使用可

図 1 - 品目構成

図 1 の不適合品目は不適合物質が赤くマークされている品目です。たとえば、抽出には次の 5 つのレコードが含まれます。

レコード 品目 レベル 物質 関連品目 最上位品目 パスサブレコード
1 COM-B-L3 3 物質 1 COM-A-L2 MF 品目番号 製品品目レベル
COM-A-L2 2
COM-A-L1 1
MF 0
2 COM-B-L3 3 物質 2 COM-A-L2 MF 品目番号 製品品目レベル
COM-A-L2 2
COM-A-L1 1
MF 0
3 COM-A-L2 2 物質 3 COM-A-L1 MF 品目番号 製品品目レベル
COM-A-L1 1
MF 0
4 COM-B-L2 2 物質 2 COM-A-L1 MF 品目番号 製品品目レベル
COM-A-L1 1
MF 0
5 COM-B-L1 1 物質 4 MF MF

テーブル 1 - 抽出のレコード

CreateOrModifySubstance

入力パラメータは配列フォーマットで送信されます。データマッピングなどの詳細については、API エクスプローラを参照してください。

必須

物質の削除

削除する物質は URL 内のパラメータとして渡されます。詳細については、API エクスプローラを参照してください。

必須

物質情報を取得する

取得する物質は URL 内のパラメータとして渡されます。データマッピングなどの詳細については、API エクスプローラを参照してください。

必須

EcomanRequirementEntity|Get

取得要件は URL 内のパラメータとして渡されます。データマッピングなどの詳細については、API エクスプローラを参照してください。
キーが渡されない場合でも、他の属性でフィルタリングすることは可能です。

必須

EcomanRequirementEntity|Post

作成する要件は、json 配列として渡されます。データマッピングなどの詳細については、API エクスプローラを参照してください。

必須

EcomanRequirementEntity|Patch

更新するレコードのキーは URL 経由で渡されます。その他のデータは json 配列として送信されます。データマッピングなどの詳細については、API エクスプローラを参照してください。

必須

EcomanRequirementEntity|Del

削除するレコードのキーは URL 経由で渡されます。詳細については、API エクスプローラを参照してください。

必須

EcomanRegulatedSubstEntity|Get

取得する規制物質データは、URL のパラメータとして渡されます。データマッピングなどの詳細については、API エクスプローラを参照してください。
キーが渡されない場合でも、他の属性でフィルタリングすることは可能です。

必須

EcomanRegulatedSubstEntity|Post

作成するレコードのキーは URL 経由で渡されます。追加データは json 配列として渡されます。データマッピングなどの詳細については、API エクスプローラを参照してください。

必須

EcomanRegulatedSubstEntity|Patch

更新するレコードのキーは URL 経由で渡されます。追加データは json 配列として渡されます。データマッピングなどの詳細については、API エクスプローラを参照してください。

必須

EcomanRegulatedSubstEntity|Del

削除するレコードのキーは URL 経由で渡されます。詳細については、API エクスプローラを参照してください。

必須