パブリック・サービス・レジストリへのパブリック REST API を使用したアクセス

サービス・レジストリ・パブリック API の概要

この節では、パブリック API での REST 呼び出しの概要を示します。各呼び出しの詳細は、“サービス・レジストリ・パブリック API リファレンス” を参照してください。

サービスの JSON 記述

サービスの取得呼び出しにより、共に返されるサービスの数に関係なく、1 つの JSON メッセージが返されます。サービスの取得要求に一致していて、さらにユーザからアクセス可能であるサービスがない場合、呼び出しは空の JSON メッセージを返します。それ以外の場合は、サービスの取得呼び出しにより、要求に一致し、ユーザからアクセス可能な 1 つ以上のサービスと共に JSON メッセージが返されます。この節では、返される JSON メッセージの例を示し、メッセージ内のフィールドについて説明します。

いずれのサービスの取得呼び出しによっても、次のようなメッセージが返されます。WSDL スキーマは、リスト内では省略形で示されていますが、JSON メッセージでは完全な形で表示されます。

[
{
    "Name": "MathServiceSOAP",
    "Domain": "UnitTest",
    "Version": "1.1",
    "Stage": "Live",
    "Protocol": "SOAP",
    "Description": "Add 2 Numbers",
    "Endpoint": "https://jgm6457/enslatest/csp/support/Demo.SOAP.MathService.cls",
    "ResponseStyle": "Sync",
    "LastModified": "2015-03-16 19:07:47.469",
    "Topics": 
    [
        "Test",
        "Maths"
    ],
    "Contacts":
    [
      {
        "Identity": "QD Developer Moon",
        "Type": "Operator",
        "Details": "Details of contact",
        "BusinessPartner": "QD",
        "Notes": "This SOAP service is designed to have minimum moving parts"
      }
    ],
    "Schema":
    {
       "Type": "Notes",
       "Ref": "https://jgm6457/enslatest/csp/support/Demo.SOAP.MathService.cls?wsdl=1",
       "Content": "<definitions targetNamespace='http://tempuri.org'> ...</definitions>",
       "Notes": "Some WSDL"
    },
    "Public": true,
    "Attributes":
    [
       {
          "Name": "One",
          "Value": "1"
        }
    ],
    "Files":
    [
       {
          "Filename": "SOAPMathService.WSDL",
          "FileExtention": ".WSDL",
          "MIMEType": "text/text",
          "CharEncoding": "UTF-8",
          "FileSize": "1.44 KB",
          "Contents": null
       }
    ],
    "Actions":
    [
       {
          "Name": "Sum",
          "Ref": "Sum",
          "Verb": "POST",
          "Description": "Add up 2 numbers",
          "ReadOnly": false,
          "Idempotent": true
       }
    ]
},
{
    "Name": "PublicREST",
    "Domain": "UnitTest",
    "Version": "0.9",
    "Stage": "Live",
    "Protocol": "REST",
    "Description": "REST Call for the Public Registry",
    "Endpoint": "http://jgm527clone.iscinternal.com:57774/csp/registry/docserver/public",
    "ResponseStyle": "Sync",
    "LastModified": "2015-03-05 16:15:33.38",
    "Topics": 
    [
       "Public",
       "Search",
    ],
    "Public": true,
    "Attributes":
    [
       {
          "Name": "Security",
          "Value": "Username and Password"
       }
    ],
    "Files":
    [
       {
           "Filename": "TestPlan",
           "MIMEType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
           "CharEncoding": "UTF-8",
           "FileSize": "16.95 KB",
            "Contents": null
       }
    ],
    "Actions":
    [
       {
          "Name": "public",
          "Ref": "public",
          "Verb": "GET",
          "Description": "Returns REST endpoint for public registry",
          "RequestSchema": 
          {
              "Type": "Notes",
              "Notes": "This is the REST endpoint to query the public Registry"
          },
          "ResponseSchema":
          {
             "Type": "REST Information
          },
          "ReadOnly": true,
          "Idempotent": true
       }
    ]
}
]

以下に、サービスの記述に含まれる可能性のあるフィールドのリストと説明を示します。すべてのフィールドについて、ESB サイトには、ESB のサービス・レジストリのフィールドの使用に関する情報を提供するガイドラインと一般的な使用方法が記載されているはずです。

[すべてのサービスの取得]

このサービスの取得 REST 呼び出しでは、表示する権限があるすべてのサービス・レジストリ・エントリが返されます。この呼び出しでは、ファイルの内容が省略されることを除いて、各サービスの完全なレジストリ・エントリが返されます。レジストリから、表示する権限があるすべてのサービスが返されます。この呼び出しの URL は次のとおりです。

GET /services

例えば、サーバと最上位ディレクトリを含む完全な URL は、次のようになります。

https://esb.example.com/registry/services

[ID によるサービスの取得]

[ID によるサービスの取得] 呼び出しは、識別されたサービスに関する情報を返します。サービスは、名前、ドメイン、およびバージョンで、一意に識別されます。この呼び出しの URL 構文は次のとおりです。

GET /services/id/name/domain/version

例えば、名前が coffeemaker、ドメインが demo、バージョンが 1.0 のサービスを取得するには、次の呼び出しを使用します。

https://esb.example.com/registry/services/id/coffeemaker/demo/1.0

[ID によるサービスの取得] は、指定したサービスについて、[すべてのサービスの取得] で返されるものと同じ情報を返します。そのため、[すべてのサービスの取得] を呼び出した場合、[ID によるサービスの取得] を呼び出す必要はありません。

選択したサービスの取得

レジストリからすべてのサービスを取得したり、ID によって 1 つのサービスを取得したりする代わりに、サービスのサブセットを選択することができます。以下のいずれかの選択条件を指定できます。

• [プロトコル] — リスト内のいずれかのプロトコルを使用するサービスを選択します。プロトコルとしては、以下のいずれかを指定できます。[File]、[FTP]、[HL7]、[HTTP]、[REST]、[SOAP]、[SQL]、[X12]、および任意のカスタム値。

• [段階] — リストで指定した段階にあるサービスを選択します。段階としては、以下のいずれかを指定できます。[概念]、[開発]、[テスト]、[ステージング]、[稼働中]、[廃止]、および [非アクティブ]。

• [バージョン] — 指定したバージョンのサービスを選択します。

• [テキスト検索] — 以下のいずれかのフィールドの、指定したテキストを含むサービスを選択します。[名前]、[ドメイン]、[説明]、[エンドポイント]、および [トピック]。テキストの比較では、大文字小文字は区別されません。

• [変更日] — 指定した日付以降にエントリが変更されているサービスを選択します。

[プロトコルによるサービスの取得] 呼び出しは、リスト内のいずれかのプロトコルに一致するプロトコルを使用するサービスを選択します。この呼び出しの URL 構文は次のとおりです。

GET /services/protocols/protocol-list

以下の呼び出しは、REST プロトコルを使用するすべてのサービスを返します。

https://esb.example.com/registry/services/protocols/REST

以下の呼び出しは、REST プロトコルと SOAP プロトコルのいずれかを使用するすべてのサービスを返します。

https://esb.example.com/registry/services/protocols/REST,SOAP

[段階によるサービスの取得] 呼び出しは、リスト内のいずれかの段階に一致する段階にあるサービスを選択します。この呼び出しの URL 構文は次のとおりです。

GET /services/stages/stage-list

以下の呼び出しは、稼働中の段階にあるすべてのサービスを返します。

https://esb.example.com/registry/services/stages/Live

[バージョンによるサービスの取得] 呼び出しは、指定したバージョンに一致するバージョンのサービスを選択します。この呼び出しの URL 構文は次のとおりです。

GET /services/version/version

例えば、以下の呼び出しは、バージョンが 1.0 のすべてのサービスを返します。

https://esb.example.com/registry/services/version/1.0

[単語によるサービスの取得] 呼び出しは、以下のいずれかのフィールドに、指定の検索テキストが含まれるすべてのサービスを検出します。

• [名前]

• [ドメイン]

• [説明]

• [エンドポイント]

• [トピック]

[単語によるサービスの取得] 呼び出しの URL 構文は次のとおりです。

GET /services/includesword/search-text

例えば、以下の呼び出しは、いずれかのフィールドに “accounts, payable” というテキスト文字列が含まれるすべてのサービスを返します。

https://esb.example.com/registry/services/includesword/accounts,%20payable

[変更以降のサービスの取得] 呼び出しは、特定の日時以降にレジストリ・エントリが変更されているすべてのサービスを返します。この呼び出しの URL 構文は次のとおりです。

GET /services/modifiedsince/date-time

例えば、次の呼び出しは、特定の日時以降にエントリが変更されているすべてのサービスを返します。

https://esb.example.com/registry/services/modifiedsince/2015-02-1%2011:30

日付を年-月-日の形式で指定し、URL スペース・コードの %20 を区切り文字として使用し、時刻を24時間制で時間:分の形式で指定します。

ファイルの内容の取得

[ID によるファイルの取得] 呼び出しは、指定したファイルの内容を返します。テキスト・ファイルとバイナリ・ファイルのいずれかで返すことができます。JSON メッセージやファイル・メタデータを返すことはありません。ファイルの内容だけを返します。この呼び出しの URL 構文は次のとおりです。

GET /services/id/name/domain/version/file/filename

ここで、name/domain/version は、サービスを特定し、filename は、そのサービス内のファイルの名前を指定します。

例えば、以下の呼び出しは、ファイルの内容を返します。

https://esb.example.com/registry/services/id/coffeemaker/demo/1.0/file/HowToCallCoffeemaker.docx