ODBC Driver for REST

Build 24.0.9062

Keyword Reference

API Script の構文は、"api:" を接頭辞に取るXML エレメントであるキーワードを使って定義されます。キーワードは、プログラミングもしくはスクリプト言語の一般的な機能である、条件分岐、ループ、およびフロー制御を含みます。ただし、API Script は、フィード操作や生成に特化した専用のキーワードも含みます。例えば、api:callapi:enum、およびapi:set があります。

キーワードの多くは、その動作を定義もしくは変化させるパラメータを取ります。パラメータは、キーワードエレメントのXML アトリビュートとして定義されます。このセクションでは、それぞれのキーワードについて、必須およびオプションのパラメータ、コードサンプルが記載されています。

キーワードスコープ

API Script では、キーワードでスコープを持つものがあります。つまり、他のキーワードのボディの内部にネストされるキーワードがあり、ネストされ方はAPI Script 言語において重要な意味を持ちます。

  • キーワードのスコープ内で反復の指示を定義することが可能です。例えば、api:call キーワードのボディは、api:call により起動したオペレーションにより生成されたフィード内のそれぞれのアイテムに対して実行されます。このため、api:call の内部にネストされたキーワードは、それぞれの反復において実行され、フィード内にそれぞれのアイテムを作成します。
  • スコープは、キーワードのマッチングペアと関連付けられます。例えば、api:else キーワード、api:equals、もしくはapi:check のような条件分岐キーワードのそれぞれの実行パスを定義します。API Script では、特定のapi:else キーワードは、条件ステートメントの直接の子としてネストされている場合には、条件ステートメントに関連付けられます。このため、api:else キーワードは、条件分岐キーワードによるスコープの外部に定義されなければなりません。
  • キーワードは、スコープ内で新しいアイテム(変数)を持ち込むことができます。例えば、api:call キーワードは、生成されているフィード内での反復されているアイテムを表すデフォルトアウトプットアイテムを出します。
  • キーワードは、スコープ内でより多くの情報を提供する追加アトリビュートをデフォルトアイテムに追加することができます。これらのアトリビュートは、本ドキュメントで説明される際にはコントロールアトリビュートと呼ばれます。これらは、通常、_文字から始まるため、簡単に判別できます。例えば、_attr、_index、_value などです。

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062