リソース

概要

リソースは、管理API で公開されているオブジェクトで、クエリ、作成、更新、削除が可能です。これらのリソースには次のものがあります：

リソース	説明
Certificates	暗号化、署名、復号、検証、SSL/TLS などに使用されるデジタル証明書を取得、作成、更新、または削除します。
Connectors	既存のコネクタの設定を取得、更新、または削除するか、アプリケーションワークフローに新しいコネクタを追加します。
Files	アプリケーションワークフロー内のファイルを取得、更新、または削除するか、コネクタのインプットフォルダに追加することでファイルをアプリケーションワークフローにプッシュします。
FlowAPIs	ワークスペースからFlow API を取得します。
FlowConnections	ワークスペースからフロー接続を取得、作成、更新、または削除します。
FlowNodes	ワークスペースからフローノードを取得、作成、更新、または削除します。
Logs	アプリケーションレベルのエラーが記録されるアプリケーションログからログデータを取得または削除します。
Profile	アプリケーションのローカルプロファイルの設定を取得または更新します。
Reports	アプリケーション内のレポートを取得、作成、更新、または削除します。
Requests	HTTP リクエストが記録されるアクセスログからログデータを取得または削除します。
Transactions	成功および失敗したファイル送信（送信および受信）が記録されるトランザクションログからメタデータを取得または削除します。
Vault	Vault アイテムを取得、作成、変更、または削除します。
Workspaces	コネクタをグループ化するためのワークスペースを取得、作成、変更、または削除します。

各リソースは、次の規則を使用して専用のアプリケーションエンドポイントで公開されます：/api.rsc/resourceName。例えば、がmydomain.com でホストされ、ポート8001 でリッスンしている場合、Files リソースにアクセスするには次のエンドポイントを使用します：

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

リソースメソッド

このセクションでは、管理API によって公開されるリソースに対して操作を実行するために使用するHTTP メソッドについて説明します。

は、データを送信するAPI 呼び出し、特にリクエストボディが大きい呼び出しでは、JSON またはx-www-form-urlencoded ペイロードのいずれかを使用することを推奨します。

GET

HTTP GET リクエストを使用して、からリソースまたはリソースのセットを取得できます。GET リクエストは、リクエストでクエリパラメータが指定されているかどうかに応じて、複数のアイテムまたは単一のアイテムのみを返します。

パラメータなしのGET リクエスト

クエリパラメータを含まないGET リクエストは、そのリソースタイプのすべてのインスタンスを返します。例えば、クエリパラメータなしのGET リクエストがCertificates リソースに対して行われると、レスポンスにはアプリケーションに保存されているすべての証明書が含まれます。Connectors リソースに対する同様のリクエストは、フロー内の設定済みのすべてのコネクタインスタンスの設定データを返します。パラメータなしのGET リクエストの対象URL は、リソースエンドポイントと同じである必要があります。次に例を示します：

GET http://mydomain.com:8001/api.rsc/certificates

パラメータ付きのGET リクエスト

GET リクエストでは、対象URL にクエリパラメータを含めることで、結果セットを対象リソースの単一のインスタンスに限定できます。例えば、Files リソースへのGET リクエストには、特定のコネクタ、Folder、Filename パラメータを含めて、そのコネクタが処理した単一のファイルを取得できます。クエリパラメータは、対象URL の末尾に括弧で囲んで指定します。次に例を示します：

GET http://mydomain.com:8001/api.rsc/files(connectorId='myConnector',Folder='Receive',Filename='myFile.txt')?@authtoken=myAuthTokenValue

各リソースで利用可能なパラメータの詳細は、アプリケーションUI のAPI Browser に記載されています。

POST

HTTP POST リクエストを使用して、で指定したリソースの新しいインスタンスを作成できます。例えば、Files リソースへのPOST リクエストはフローにファイルを挿入し、Connectors リソースへのPOST リクエストはフロー内に新しい設定済みコネクタを作成します。新しいリソースのパラメータは、POST のボディにJSON 形式で提供します。POST ボディが正しく解釈されるよう、リクエストには適切なcontent-type ヘッダー（例えば、application/json）を含める必要があります。各リソースで利用可能なプロパティの詳細は、アプリケーションUI のAPI Browser に記載されています。次は、Connectors リソースのPOST ボディの例です：

{
	"ConnectorId":"myNewConnector",
	"ConnectorType":"Zip",
	"Workspace":"Default",
}

Connectors リソースは、指定したConnectorType に応じた追加のプロパティもサポートします。JSON ボディにフィールド名と値を含めることで、設定可能な任意のコネクタフィールドをPOST 呼び出し中に設定できます。例えば、新しいZip コネクタを作成する際に、コネクタのOperation フィールドをDecompress に設定できます：

{
	"ConnectorId":"myNewConnector",
	"ConnectorType":"Zip",
	"Workspace":"Default",
	"Operation":"Decompress"
}

POST リクエストの対象URL は、リソースエンドポイントと同じである必要があります：

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

PUT

HTTP PUT リクエストを使用して、で指定したリソースのインスタンスを更新できます。例えば、Connectors リソースへのPUT リクエストは、フロー内の単一の設定済みコネクタの設定を更新します。 PUT リクエストには、次の項目の組み合わせが必要です：

対象URL 内のクエリパラメータ。これらのパラメータは、リソースのどのインスタンスを更新するか（例えば、どのコネクタを更新するか）を指定します。
PUT リクエストのJSON ボディ内のプロパティ。これらのプロパティは、そのリソースのどのフィールドを更新するか（例えば、どのコネクタ設定フィールドを新しい値に設定するか）を決定します。

クエリパラメータは、対象URL の末尾に括弧で囲んで指定します。次に例を示します：

PUT http://mydomain.com:8001/api.rsc/connectors(ConnectorId='myZipConnector')

リクエストのJSON ボディには、対象リソースインスタンスで更新するリソース固有のフィールドが含まれます。PUT ボディが正しく解釈されるよう、リクエストには適切なcontent-type ヘッダー（例：application/json）を含める必要があります。次は、Zip コネクタインスタンスのOperation フィールドを更新するPUT リクエストのJSON ボディの例です：

{
 "Operation":"Compress"
}

DELETE

HTTP DELETE リクエストを使用して、から指定したリソースのインスタンスを削除できます。例えば、Files リソースへのDELETE リクエストは、ワークフローからファイルを削除します。 DELETE リクエストには、削除するリソースのインスタンスを識別するために、対象URL にクエリパラメータを含めます。クエリパラメータは、対象URL の末尾に括弧で囲んで指定します。次に例を示します：

DELETE http://mydomain.com:8001/api.rsc/files(connectorId='myConnector',Folder='Send',Filename='myfile.txt')

各リソースで利用可能なパラメータの詳細は、アプリケーションUI のAPI Browser に記載されています。

はじめに

フロー

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

コネクタ

マッピング

API と自動化

ハウツーガイド

スクリプティング

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

概要

リソースメソッド

GET

パラメータなしのGET リクエスト

パラメータ付きのGET リクエスト

POST

PUT

DELETE

​概要

​リソースメソッド

​GET

​パラメータなしのGET リクエスト

​パラメータ付きのGET リクエスト

​POST

​PUT

​DELETE

概要

リソースメソッド

GET

パラメータなしのGET リクエスト

パラメータ付きのGET リクエスト

POST

PUT

DELETE