Skip to main content

This documentation is for an older version of this product. See the latest version of this content.Opens in a new tab

GET /api/mgmnt/v2/:namespace/:application/

指定された REST サービスの OpenAPI 2.0 仕様Opens in a new tabを返します。この REST サービスは、新しい REST サービスでも手動コーディングの REST サービスでもかまいません。

URL パラメータ

namespace 必須。ネームスペース名。このパラメータでは大文字と小文字は区別されません。
application 必須spec クラス、impl クラス、および disp クラスが格納されているパッケージの完全修飾名。このパラメータでは大文字と小文字は区別されません。

許可

このエンドポイントを使用するには、指定されたネームスペースに対する読み取りアクセス権を持っている必要があります。ネームスペースを指定しない場合、または指定したネームスペースが %SYS である場合は、既定のネームスペース (USER) に対する読み取りアクセス権を持っている必要があります。既定のネームスペースを別のネームスペースに設定できます。そのためには、グローバル・ノード ^%SYS("REST","UserNamespace") を目的のネームスペースに設定します。

また、ディスパッチ・クラスが格納されているデータベースに対する読み取りアクセス権も必要です。 ディスパッチ・クラスのネームスペースとエンドポイントのネームスペースは同じである必要があります (パッケージ内の % で始まるディスパッチ・クラスの場合を除きます。これはすべてのネームスペースに使用できます)。

要求の例

  • 要求のメソッド :

    GET

  • 要求の URL :

    http://localhost:52773/api/mgmnt/v2/user/myapp

応答

この呼び出しは、https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.mdOpens in a new tab に記載されているような Swagger (OpenAPI 2.0Opens in a new tab) 仕様を返します。返される仕様では、プロパティが以下のように設定されます。

  • host は常に、呼び出したサーバの server:port に設定されます。

  • basePath は、この REST アプリケーションにディスパッチされる最初の Web アプリケーションに設定されます。この REST アプリケーションにディスパッチされる Web アプリケーションがない場合、basePath は、.spec クラスで定義されたとおりに返されます。

FeedbackOpens in a new tab