モジュール名: flowapi

機能名 説明
api_url 指定したフローAPIを実行します

機能名: api_url

説明

URLで指定したフローAPIを実行します。
MCAPIでのログインが必要だが、フローAPIでのログインが不要です。セッションIDを指定するとき、MCAPIのセッションIDを指定してください。
タイムアウトはMCAPIと同じです。
HTTPメソッドは実行するフローAPIによって指定します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET/POST http://{Hostname}:{Port}/mcapi/flowapi/api_url
リクエストパラメーター
実行するフローAPIのパラメーターに参照してください

リクエスト例
GETの場合
GET /mcapi/flowapi/service/info HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
POSTの場合
POST /mcapi/flowapi/project/register HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 24

projectFile=Project1.xfp
ファイルをPOSTする場合
POST /mcapi/flowapi/api_url HTTP/1.1
Content-Type: multipart/form-data; boundary=---------------------------120912416424652; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 333

-----------------------------120912416424652 
Content-Disposition: form-data; name="filedata"; filename="test.csv" 
Content-Type: application/csv

[リクエストのデータとしてファイルがバイナリ形式で付加されます]
-----------------------------120912416424652--
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功すると指定したフローAPIの結果が返ります。

JSONの場合
{
  "result": {
    "status": "success",
    "data": {
      "version": "1.0.0.1"
    }
  }
}
ファイルの場合
HTTP/1.1 200 OK
Content-Type: application/zip
Content-Length: 44556
Content-Disposition: filename="api.zip"

[レスポンスのボディとしてzipファイルがバイナリ形式で付加されます]
エラーケース

下記以外のエラーについては、フローAPIのエラーケースを参照してください。

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ