サンプルユースケース

このセクションでは、複数のAPI リクエストを組み合わせて実現する一般的なユースケースについて説明します。

ファイルをワークフローに挿入する

Files リソースにPOST すると、特定のコネクタのSend、Receive、Sent フォルダにファイルが追加されます。ファイルをワークフローに挿入するには、そのファイルを最初に処理すべきコネクタのSend フォルダにPOST します。次に例を示します：

POST http://mydomain.com:8001.com/api.rsc/files

{
    "ConnectorId":"myConnector",
    "Folder":"Send",
    "Filename":"test.txt",
    "Content":"VGhpcyBpcyBhIHRlc3Qu"
}

Content パラメータには、ファイルのbase64 エンコードされた内容が含まれることに注意してください。対象のコネクタでSend オートメーションが有効になっている場合、ファイルは自動的に処理されます。そうでない場合は、コネクタにファイルの処理を指示するために、sendFile アクションへの追加の呼び出しが必要です。次に例を示します：

POST http://mydomain.com:8001/api.rsc/sendFile

{
  "ConnectorId":"myConnector",
  "File":"test.txt"
}

特定のトランザクションのログファイルを取得する

getTransactionLogs アクションは、特定のアクションのログファイルを取得します。このアクションを呼び出すには、対象のトランザクションのMessageId を知っておく必要があります。MessageId は、まずTransactions リソースをクエリすることで見つけられます（Transactions リソースはトランザクションに関するメタデータを返しますが、トランザクションのログファイル自体は返しません）。 Transactions リソースへのGET クエリには、特定のトランザクションを識別するために必要なフィルタをすべて含める必要があります。ただし、結果セットを他のプロセスで解析して目的のトランザクションのMessageId を見つけられる場合はこの限りではありません。次に例を示します：

GET http://mydomain.com:8001/api.rsc/transactions(connectorId='myAS2Connector',Filename='myFile.edi')

レスポンスのJSON ボディには、特定のトランザクションのMessageId が含まれます。このMessageId を、他の必須パラメータであるConnectorId およびDirection（Send またはReceive）とともにgetTransactionLogs の呼び出しで使用します。レスポンスにログファイルの内容を含めるには、IncludeContent パラメータをTrue に設定してください。次に例を示します：

POST http://mydomain.com:8001/api.rsc/getTransactionLogs

{
	"ConnectorId":"myConnector",
	"Direction":"Send",
	"MessageId":"message_id_from_earlier",
	"IncludeContent":"True"
}

レスポンスのContent パラメータには、base64 エンコードされたログファイルの内容が保持されます。

Script から管理API を呼び出す

Script を使用して、管理API にarc:call コマンドを送信できます。各呼び出しはapi.rsc/ で始める必要があります。この機能には次の制限が適用されます：

OData クエリ構文はサポートされていません。
レートリミッターは適用されません。
スクリプトがAdmin Console から直接実行される場合、ユーザーは現在ログインしているユーザーになります。
スクリプトがオートメーションサービスによって実行される場合、監査内のIP アドレスは127.0.0.1 になります。

コネクタを取得する

次の例は、connectors リソースを取得するために使用する単独のarc:call コマンドです：

<arc:call op="api.rsc/connectors" httpmethod="get" authtoken="6o6B3m4r3F8z6m4R3d1k" out="o">

このコマンドは次の要素で構成されています：

要素	説明
op=“api.rsc/connectors”	op（操作）パラメータを設定して、管理API を呼び出し（`api.rsc/` を使用）、connectors リソースを取得します。
httpmethod=“get”	コマンドをGET コマンドとして指定します。
authtoken=“6o6B3m4r3F8z6m4R3d1k”	指定したトークンをauthtoken パラメータに渡します。これは、設定ページのユーザーセクションで取得できます。
out=“o”	コマンドによって返されたコネクタをo に割り当てます。

次のScript コードは、このarc:call コマンドを使用して、既存のすべてのコネクタのリストを作成します：

<!--Initialize item for output and filename-->
<arc:set attr="result.data" value=""/>
<arc:set attr="result.filename" value="connectors.txt"/>

<!--Empty 'in' attribute to allow global scope for connectors-->
<arc:set attr="in.in" value=""/>

<!-- List all existing connectors -->
<arc:call op="api.rsc/connectors" httpmethod="get" authtoken="YourUser:YourAdminAPIToken" out="o" in="in">
  <arc:set attr="result.data" value="[o.connectorid]([o.connectortype])\n[result.data]"/>
</arc:call>

<!--Push to output-->
<arc:push item="result"/>

コネクタを作成および変更する

次の例は、フロー内に新しいScript コネクタを作成するために、管理API にPOST コマンドを発行します：

<arc:set attr="new.connectorid" value="Script1"/>
<arc:set attr="new.connectortype" value="Script"/>
<arc:call op="api.rsc/connectors" httpmethod="post" authtoken="test0:8s9T7b7m5Y5k3i5P2s6x" in="new">
</arc:call>

この新しいコネクタが作成された後、管理API にコマンドを発行して、新しく作成されたScript コネクタのLogLevel 値を取得できます：

<arc:set attr="read.connectorid" value="Script1"/>
<arc:call op="api.rsc/connectors" httpmethod="get" authtoken="test0:8s9T7b7m5Y5k3i5P2s6x" in="read" out="o">
  <arc:set attr="result.new:old_loglevel" value="[o.loglevel]" />
</arc:call>

また、PUT コマンドでScript コネクタのLogLevel を更新することもできます：

<arc:set attr="update.connectorid" value="Script1"/>
<arc:set attr="update.loglevel" value="Debug"/>

<arc:call op="api.rsc/connectors" httpmethod="put" authtoken="test0:8s9T7b7m5Y5k3i5P2s6x" in="update" out="o">
</arc:call>

はじめに

フロー

EDI トレーディングパートナー管理コンソール

コネクタ

マッピング

API と自動化

ハウツーガイド

スクリプティング

ソフトウェアライセンスとサードパーティ著作権

ファイルをワークフローに挿入する

特定のトランザクションのログファイルを取得する

Script から管理API を呼び出す

コネクタを取得する

コネクタを作成および変更する

​ファイルをワークフローに挿入する

​特定のトランザクションのログファイルを取得する

​Script から管理API を呼び出す

​コネクタを取得する

​コネクタを作成および変更する

ファイルをワークフローに挿入する

特定のトランザクションのログファイルを取得する

Script から管理API を呼び出す

コネクタを取得する

コネクタを作成および変更する