アウトプットのレスポンス項目一覧を作成しよう
クエスト概要
アウトプットの連携方式にAPIを選択し、アウトプット基本情報を定義しようで「出力APIのレスポンスの項目定義の有無」を「定義する」とした場合にこのクエストは解放されます。
連携先システムの取込API実行のレスポンスの値を別の処理で利用する場合に定義する必要があります。
I/F事後処理を利用する場合、事後処理のAPIの実行に取込APIのレスポンスの値が必要となるケースがあるため、本クエストで定義することでI/F事後処理で利用することができるようになります。
アウトプット項目一覧を定義しよう、と基本的なクエスト構成は同じです。現状、レスポンス項目はjsonのフォーマット形式のみ対応しています。
用語一覧
このクエストで登場する用語を解説します。
アウトプット基本情報を定義しようのクエストの中で、以下の内、どのファイル形式を指定したかによって定義する内容は変わります。
プロパティ名
対象項目のプロパティ名を記載します。
※ファイル形式「json」またはフォーマット形式「application/json」を選択した場合に利用可
項目名称
対象項目の名称を記載します。項目名称は、設定しなくても出力されるデータに影響はありません。
マッピング設定の際や、後から見たときに何の項目なのか、というところを分かりやすくつけられる
ヘッダー文字列に対してつける名称ですので任意項目となります。
必須
必須項目である場合は「〇」選択します。
必須にした項目については、I/F処理の際に値がない場合にエラーにして事前にチェックすることができます。
エラーメッセージなどの定義は後に出てくる、「バリデーションを定義しよう」のクエストで実施しますので、
項目定義では、必須のチェックをしたいかどうか、という観点で定義してください。
データ型
対象項目のデータ型を以下から選択し、選択したデータ型に沿った内容を定義していきます。
文字列
テキスト項目の入力に利用します。数値
小数点を含む、数値項目に利用します。日時
日付と時刻の項目に利用します。日付項目なのか、日時項目（時刻入り）なのかは、日付フォーマットで定義するので、
日付の場合でもデータ型は日時を選択してください。真理値 (Boolean)
ある条件が成立する場合には「真(True)」、そうでない場合には「偽(False)」と選択する値が真理値です。
例えば「年齢が20歳以上かどうか」といった問いに対して回答するのに利用します。オブジェクト
オブジェクトは、中括弧 {} で囲まれた、キーと値のペアを持つデータ型です。
キーは文字列で、値には文字列、数値、真偽値、オブジェクト、配列などを含めることができます。
キーと値のペアはコロン : で区切り、複数のペアをカンマ , で区切ります。
※ファイル形式「json」またはフォーマット形式「application/json」を選択した場合利用可
以下は、オブジェクトの例です。
{
"name": "John",
"age": 30,
"isStudent": false,
"address": {
"city": "Tokyo",
"country": "Japan"}
}
この例では、キーとして "name" "age" "isStudent" "address" があり、それぞれの値は文字列、数値、真偽値、オブジェクトになっています。
- 配列（オブジェクト）
配列（オブジェクト）は、角括弧 [] で囲まれた、オブジェクトの集合を持つデータ型です。
オブジェクトは、先に説明したように、キーと値のペアを持つデータ型です。
※ファイル形式「json」またはフォーマット形式「application/json」を選択した場合利用可
以下は、配列（オブジェクト）の例です。
[
{"name": "John","age": 30,"isStudent": false},
{"name": "Jane","age": 25,"isStudent": true},
{"name": "Bob","age" : 40,"isStudent": false}
]
この例では、配列内に3つのオブジェクトがあります。
それぞれのオブジェクトは、キーとして "name" "age" "isStudent" を持ち、
それぞれの値は文字列、数値、真偽値になっています。
- 配列（文字列）
配列（文字列）は、角括弧 [] で囲まれた、文字列の集合を持つデータ型です。
※ファイル形式「json」またはフォーマット形式「application/json」を選択した場合利用可
以下は、配列（文字列）の例です。
["apple","orange","banana","grape"]
この例では、配列内に4つの文字列があります。
- 配列（数値）
配列（数値）は、角括弧 [] で囲まれた、数値の集合を持つデータ型です。
※ファイル形式「json」またはフォーマット形式「application/json」を選択した場合利用可
以下は、配列（数値）の例です。
[1,2,3,4]
- ファイル（バイナリ）
※ファイル形式「ファイル」「multipart/form-data」を選択した場合利用可
ファイル（バイナリ）のデータ型は、ファイルデータを取り扱う項目となります。 ファイル形式「ファイル」を選択していた場合は自動で作成されます。
ファイル形式「multipart/form-data」を選択していた場合は、ファイルデータとして送信するキーにこのデータ型を選択して下さい。
これ以下は選択したデータ型に応じた用語説明です。
- 「データ型：文字列」を選択した場合
フォーマットテンプレート
データ型に合わせた最大文字数等のフォーマット情報をテンプレートで指定できます。
最大文字数
全角文字（2byte文字）で入力した時の、入力可能な最大文字数の定義をすることができます。
I/F処理の際に、対象項目が定義した最大文字数を超えている場合、エラーにして事前にチェックすることができます。
初期値
項目が特定の値を持たない場合に適用されるデフォルトの値を定義することができます。
- 「データ型：数値」を選択した場合
フォーマットテンプレート
データ型に合わせた最大文字数等のフォーマット情報をテンプレートで指定できます。
最小値
入力可能な最小値の定義をすることができます。
例えば、最小値が100と設定されている場合は、100以上の数値入力を許可します。
I/F処理の際に、対象項目が定義した範囲外の数値の場合は、エラーにして事前にチェックすることができます。
最大値
入力可能な最大値の定義をすることができます。
例えば、最大値が100と設定されている場合は、100以下の数値入力を許可します。
I/F処理の際に、対象項目が定義した範囲外の数値の場合は、エラーにして事前にチェックすることができます。
小数桁数
入力可能な小数桁数の定義をすることができます。
例えば、小数桁数が2と設定されている場合は、小数第二位までの入力、3.14といった数値入力を許可します。
I/F処理の際に、対象項目が定義した範囲外の数値の場合は、エラーにして事前にチェックすることができます。
初期値
項目が特定の値を持たない場合に適用されるデフォルトの値を定義することができます。
- 「データ型：日時」を選択した場合
日付フォーマット
日時項目のフォーマット定義をすることができます。選択肢から、適した日付フォーマットを選択して下さい。
I/F処理の際に、対象項目が指定していない日付フォーマットだった場合は、エラーにして事前にチェックすることができます。
- 「データ型：配列（オブジェクト）」を選択した場合
配列(オブジェクト)の要素の展開方法
アウトプットのレコード毎に含まれる配列を、CSV等のフラットなデータ構造から配列化することができます。
要素を項目として展開する
配列(オブジェクト)の要素に含まれる値を、キーとして指定し、条件をもとに静的な配列にします。条件で要素を展開する
配列(オブジェクト)の要素数を静的に指定して、静的な配列にします。利用しない
展開方法を利用せずそのまま使います。