リソースインベントリオープン API 開発者ガイド

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:2分
  • リソースインベントリオープン API を使用して、インターフェイスカード、論理接続と物理接続、ネットワークサイトなどのリソースを作成、取得、更新、および削除します。

    この開発者ガイドでは、リソース在庫オープン API を拡張してさまざまなカスタマイズを行う方法について説明します。

    Resource Inventory Open API の拡張

    リソースインベントリオープン API は、拡張ポイントとスクリプトインクルードを使用して拡張できます。

    拡張ポイント

    Resource Inventory Open API には、必要なパラメーターを定義する API の既存のスキーマを変更するために使用できる拡張ポイントが含まれています。拡張ポイントを使用して、新しいパラメーターを追加して Now Platformのフィールドにマップしたり、既存のパラメーターのマッピングを変更したりすることもできます。たとえば、新しいリソース特性を追加し、適切なフィールドにマッピングできます。

    リソースインベントリオープン API には、次の拡張ポイントが含まれています。
    • TNITMFResourceInventoryAPICreateResource:リソースを作成するための拡張ポイント。
    • TNITMFResourceInventoryAPIPatchResource:リソースを更新するための拡張ポイント。
    • TNITMFResourceInventoryAPITransformToIREPayload:TMF 要求から識別および調整エンジン (IRE) ペイロードを作成するための拡張ポイント。
    • TNITMFResourceInventoryAPITransformToResponse:リソース GlideRecord から TMF 応答を作成する拡張ポイント。
    • TNITMFResourceInventoryAPIValidateCreate:TMF POST 要求を検証する拡張ポイント。
    • TNITMFResourceInventoryAPIValidatePatch:TMF PATCH 要求を検証するための拡張ポイント。

    スクリプトインクルード

    スクリプトインクルードを使用して、デフォルトの検証および変換関数を上書きします。デフォルトの関数はsn_ni_coreで定義されています 。TNITMFResourceInventoryProcessorOOB スクリプトインクルード。デフォルトの関数をオーバーライドするには、sn_ni_core内で同じ名前とパラメーターを持つ関数を作成します 。TNITMFResourceInventoryProcessor スクリプトインクルード。