Skip to main content

データ API の概要

InterSystems Supply Chain Orchestrator™ は、データの作成、更新、削除、および取得のための APIOpens in a new tab を提供します。ここでは、この API の概要を説明します。

API の URL パターン

すべての API 呼び出しは以下の同じ URL パターンに従います。

GET {{IRIS-SERVER}}/{{DATAMODEL-PATH}}/OBJECT_PATH?parameters 
POST {{IRIS-SERVER}}/{{DATAMODEL-PATH}}/OBJECT_PATH 
GET/PUT/DELETE {{IRIS-SERVER}}/{{DATAMODEL-PATH}}/OBJECT_PATH/uid

以下はその説明です。

  • {{IRIS-SERVER}} の部分は、InterSystems IRIS® インスタンスのサーバ情報です。ローカルで導入されたサーバでは、http://localhost:52773 のようになります。

  • {{DATAMODEL-PATH}} の部分は、API ベース URL です。例えば、/api/scdata/v1 のようになります。

  • OBJECT_PATH の部分は、小文字の複数形のオブジェクト名です。例えば、salesorders や customers のようになります。すべてのオブジェクト値については、以下の表を参照してください。

  • 最初の URL パターンは、オブジェクトのデータを取得するか、一連のパラメータを使用してオブジェクトを検索します。任意のオブジェクトの属性を検索条件で使用できます。

  • 2 番目の URL パターンは、新しいオブジェクト・レコードを作成します。要求の本文には、新しいオブジェクトの JSON 文字列を含める必要があります。

  • 3 番目の URL パターンは、uid (外部の主キー) によりオブジェクト・レコードを取得、更新、または削除します。

以下に例を示します。

  • ステータスが Open または PartialShip であるすべての販売注文の検索 ：

    GET {{IRIS-SERVER}}/{{DATAMODEL-PATH}}/salesorders?orderStatus=Open,PartialShip

  • 新規顧客の作成 ：

    POST {{IRIS-SERVER}}/{{DATAMODEL-PATH}}/customers

    この際に、要求の本文に以下の JSON を含めます。

    {
    "uid" : "CUST-TEST-101",
    "name" : "Google",
    "type" : "HighTech",
    "contact" : "Ming",
    "url" : "https://google.com"
}

  • uid 値が SUP-SHIP-1001 である供給出荷レコードの取得 ：

    GET {{IRIS-SERVER}}/{{DATAMODEL-PATH}}/supplyshipments/SUP-SHIP-1001

  • 位置レコードの更新 ：

    PUT {{IRIS-SERVER}}/{{DATAMODEL-PATH}}/locations/LOC-PLANT-002

    この際に、要求の本文に新しい位置の JSON データを含めます。

結果の並べ替え

API 呼び出しによって複数のレコードが返される場合、並べ替えパラメータ sortBy を指定することで応答データの順序を定義できます。このパラメータの値は、返されるプライマリ・オブジェクトの属性名のコンマ区切りリストである必要があります。

例えば、次の API 呼び出しは、応答で注文リストをどのように並べ替えるかを定義します。

GET /salesorders?sortBy=customer,orderValue

これは、最初は顧客順で、次に注文額順で並べ替えが実行されるよう定義します。

既定では、並べ替えは昇順で行われます。順序を降順に変更するには、以下の例に示すように属性名の前に - 記号を使用します。この例では、最初に顧客によって昇順で並べ替え、その後 orderValue によって降順で並べ替えます。

GET  /salesorders?sortBy=customer,-orderValue

既定の並べ替え

要求の URL で並べ替えパラメータが指定されない場合、返されるプライマリ・オブジェクトに基づいて、既定の並べ替えが適用されます。以下の表は、各オブジェクト・タイプの既定の並べ替えパラメータを示しています。

オブジェクト URL パス 既定の並べ替え属性
Carrier carriers name
Customer customers name
Supplier suppliers name
Product products name
Location locations locationName
BillOfMaterial billofmaterials productId、parentItemId
InventoryThreshold inventorythresholds siteLocationId、productId
Milestone milestones ID
ProductInventory productinventories siteLocationId、productId
ProductSupplier productsuppliers productId
SupplyPlan supplyplans locationId、productId
DemandPlan demandplans locationId、productId
SalesOrder salesorders -orderPlacedDate
SalesOrderLine salesorderlines orderId、lineNumber
SalesShipment salesshipments -actualShipDate
SalesShipmentLine salesshipmentlines shipmentId、lineNumber
PurchaseOrder purchaseorders -orderPlacedDate
PurchaseOrderLine purchaseorderlines orderId、lineNumber
SupplyShipment supplyshipments -actualShipDate
SupplyShipmentLine supplyshipmentlines shipmentId、lineNumber
ManufacturingOrder manufacturingorders -orderEntryDate

結果のページ付け

既定では、複数のレコードを返す API 呼び出しは、指定された条件と一致する最初の 100 件のレコードを返します。ページ付けパラメータを使用して、追加のレコードまたはより大きなレコード・セットを取得できます。ページ付けパラメータにより、例えばリソース (メモリ、ネットワーク帯域幅など) を過剰に消費したり、パフォーマンスの問題を引き起こすことなく、Web UI でテーブルを生成するために必要な制御が可能になります。

ページ付けパラメータは、以下のとおりです。

  • pageSize. このパラメータは、API 呼び出しで返されるレコードの最大数を定義します。返されるレコードの実際の数は、この値以下になります。既定値は 100 で、許可される最大値は 1000 です。

  • pageIndex. このパラメータは、応答で返されるページ・インデックス (0 から始まる) を指定します。既定値は 0 です。

例えば、以下の API 呼び出しは、最初の 200 件の注文をスキップし、次の 100 件の注文を、注文額で並べ替えて返します。

GET  /salesorders?sortBy=orderValue&pageSize=100&pageIndex=2

応答でページ付けを使用して部分的なレコードのみが返される場合、応答内で以下の HTTP ヘッダ・パラメータが生成されます。これらの値を使用して、UI のページ付けロジックを制御します。

  • pageSize.要求パス・パラメータで指定されている場合は同じ値です。要求で明示的に指定されていない場合は、既定値が返されます。

  • pageIndex.要求パス・パラメータで指定されている場合は同じ値です。要求で明示的に指定されていない場合は、既定値が返されます。

  • returnCount. 現在の応答で返されるレコード数。この値は pageSize 以下です。

日付および日付/時刻の形式

日付または日付/時刻の属性については、メッセージの JSON 本文内で指定するか、または HTTP パラメータ内で指定するかに関係なく、ISO 8601 形式で値を指定する必要があります。

以下は、その例です。日付属性の場合 ：

2021-02-28

日付/時刻属性の場合 (以下の 2 つの値は同等です) ：

2021-12-15T13:23:15-05:00
2021-12-15T18:23:15Z

タイム・ゾーンの情報が指定されていない場合、UTC 時刻を使用するものと見なされます。例えば、2021-05-24T08:30:00 は 2021-05-24T08:30:00Z と同様に扱われます。

関連項目

InterSystems Supply Chain Orchestrator の分析キューブNext section
Previous sectionサプライ・チェーン・データ・モデル API
FeedbackOpens in a new tab