受信設定作成

受信設定を作成するためのAPIです。Manager画面で［プロファイル］を選択した後、プロファイルを選択したときに表示される画面での［受信設定］の操作に相当します。

= 備考 =

次のAPIのJSON形式のリクエストパラメータは同じです。

  • 受信設定作成API
  • 受信設定情報更新API

次のAPIのレスポンスパラメータは同じです。

  • 受信設定作成API
  • 受信設定情報更新API
  • 受信設定詳細取得API
書式
curl -X POST --header 'Content-Type: application/json'
             --header 'Accept: application/json'
             --header 'X-API-KEY:APIキー'
             -d 'JSON形式のリクエストボディ'
             'http://ホスト名:ポート番号/api/v1/profiles/profileId/receiving-profiles'
リクエストボディ（JSON形式）
{
　　　"fileName": "string",
　　　"jobExecMode": 0,
　　　"jobScript": "string",
　　　"receivingProfileName": "string"
}
リクエストパラメータ（JSON形式）
項目名 リクエストパラメータ 型 値 省略値
配置先ファイル名 fileName 文字列

配付ファイルをIoT機器で受信したときのファイル名を、IoT機器でのファイルの格納先となる絶対パスで指定します。

256バイト以内の文字列（*?"<>| は指定不可）

 省略不可

ジョブ実行モード

（受信設定）

 jobExecMode 数値

配付ファイルの受信が成功したときに実行されるジョブを、スクリプト単位で実行するかステップ単位で実行するかを選択します。

0　|　1

•　0：スクリプト実行

•　1：ステップ実行

 0
ジョブの内容 jobScript 文字列

配付ファイルの受信が成功したときに実行するジョブを記入します。

2048文字以下のASCII文字（NULLを除く）

  
受信設定名 receivingProfileName 文字列

1文字以上、64文字以下

 省略不可
リクエストパラメータ（パス形式）
項目名 リクエストパラメータ 型 値 省略値
プロファイルID profileId 文字列   省略不可
レスポンス
{
　　　"entryPoint": "string",
　　　"fileName": "string",
　　　"jobExecMode": 0,
　　　"jobScript": "string",
　　　"receivingProfileId": "string",
　　　"receivingProfileName": "string"
}
レスポンスパラメータ

レスポンスパラメータについては、「受信設定詳細取得」の「レスポンスパラメータ」を参照してください。