Search

api:info

Version 22.0.8500

api:info

Version 22.0.8500

api:info キーワードは、スクリプトのメタデータを説明するために使われます。この情報は、ユーザー入力の基本的なエラーチェックの実装、およびデフォルト値を設定するためにアプリケーションによって使われます。api:info キーワードには、次のような情報が含まれます。

  • カラム定義
  • スクリプトが受け入れるインプットパラメータ
  • スクリプトが生成するアウトプット

スクリプトパラメータ

次のパラメータはスクリプト自体を定義します：

  • desc[ription]:スクリプトの説明。もし説明がない場合には、スクリプトの名前が使われます。
  • title:スクリプトのタイトル。もしタイトルがない場合には、スクリプトの名前が使われます。
  • methods:スクリプトに対して実行できるHTTP メソッド。SELECT、INSERT、UPDATE、およびDELETE はHTTP GET、POST、PUT/PATCH/MERGE、およびDELETE にそれぞれ対応します。
  • url:スクリプトauther のURL。
  • keywords:スクリプトを説明するキーワード。

インプット、アウトプット、およびカラム パラメータ

api:info キーワードは、スクリプトインプット、およびアウトプットに加えて、カラムを定義するスコープに含まれる追加パラメータを持ちます。これらのパラメータはAPIScript キーワードではなく、api:info の追加情報であることに注意してください。

input

インプットパラメータは、スクリプトへのインプットを説明するために使われます。

<input
  name="name"
  desc="インプットパラメータの例"
  default="defValue"
  req="true"
  values="value1, value2, value3"
  xs:type="string" 
/>
  • name:インプット名。英数字で、以下を追加で含むことができる：”#” はインプットが複数の値を持つことができることを意味し、”myprefix:*” は同一の接頭辞や値を含むインプットのセットを意味し、”*” は、任意のインプットパラメータを意味します。
  • desc[ription]:インプットの短い説明。
  • xs:type:インプットのデータ型。String、int、double、datetime、およびboolean 型がサポートされています。
  • def[ault]:スクリプトコールでインプット値が提供されていない場合に使われるデフォルト値。
  • key:インプットが主キーかどうか。
  • req[uired]:インプットが必要かどうか。要求されたインプットが提供されず、デフォルト値が定義されていない場合にはエンジンはエラーを出します。’TRUE またはFALSE’ が使用可能です。
  • values:カンマ区切りのインプットの有効な値。指定されている場合、指定されたインプットが許容された値のどれかと合致しない場合には、エンジンはエラーを出します。
  • alias:インプットのエイリアス。
  • other:’other:’ で始まるアトリビュートで追加の情報を提供します。これらの other プロパティは、処理に固有とすることができます。

output

オペレーションのアウトプットを説明するアウトプットパラメータ。ただし、これらはアプリケーションには無視されます。よって、オペレーションのアウトプットは、情報ブロックでの定義から独立しています。

<output  name="Id" 
         desc="レコードの一意の識別子。"
         xs:type="string"
         other:xPath="content/properties/Id" 
/>
  • name:アウトプットの名前で、”myprefix:*” は同一の接頭辞や値を含むインプットのセットを意味し、”*” は、任意のアウトプットパラメータを意味します。
  • xs:type:アウトプットのデータ型。String、int、double、datetime、およびboolean 型がサポートされています。
  • desc[ription]:アウトプットの短い説明。
  • columnsize:文字列の最大文字数、もしくは数値アウトプットの桁精度。カラムの桁制度とは、桁数です。
  • other:’other:’ で始まるアトリビュートでアウトプットについて追加の情報を提供します。例えば、other:xPath はXPath をローカル、もしくはリモートリソースのノードに指定します。XPath はRepeatElement に相対的とすることができます。

例

After Receive イベントへのインプットについて説明します：

<api:info title="After Receive"  desc="このイベントはファイルを受信した後に発生します。">
  <input name="Filename"         desc="送信されたファイルの名前。" />
  <input name="FilePath"         desc="受信されたファイルのパス。" />
  <input name="MessageId"        desc="トランスミッションのId。" />
  <input name="ErrorMessage"     desc="エラーが発生した場合は、エラーメッセージが表示されます。" />
</api:info>

関連項目

  • api:script:スクリプトブロックの作成。
  • api:call:スクリプトおよびオペレーションの呼び出し。
  • api:set:アイテムでアトリビュートを設定。