単一エンティティ項目の取得

パスで指定された単一のエンティティ項目情報を返却する

📬 リクエスト

GET {resource_api_url}/entities/{entity_name}/items/{name}

リクエストヘッダ

キー	値
Authorization	`Bearer {アクセストークン}`

パスパラメータ

パラメータ	形式	必須	説明	値の例
entity_name	文字列	YES	検索対象のエンティティ名	`account`
name	文字列	YES	検索対象のエンティティ項目名	`name`

クエリパラメータ

なし

✨ 成功レスポンス

ステータスコード

200 : OK

レスポンスヘッダ

キー	値
Content-Type	`application/json`

レスポンスボディ

フィールド	形式	必須	説明	値の例
name	文字列	YES	項目名	`name`
display_name	文字列	YES	項目の表示名	`取引先名`
type	`text` `numeric` `boolean` `date` `option` `reference`	YES	データ型 `text` : 文字列形式のフィールドに対して設定する `numeric` : 数値形式のフィールドに対して設定する `boolean` : 真偽値形式のフィールドに対して設定する `date` : 日付や日時形式のフィールドに対して設定する `option` : オプション形式のフィールドに対して設定する `reference` : 他レコード参照形式のフィールドに対して設定する	`text`
sub_type	`textarea` `phone` `email` `url` `combobox` `integer` `decimal` `date` `datetime` `time` `single` `multi`	NO	サブデータ型データ型が`text`の場合 `textarea` : 複数行入力が可能なフィールドに対して設定する `phone` : 電話番号を表すフィールドに対して設定する `email` : メールアドレスを表すフィールドに対して設定する `url` : URLを表すフィールドに対して設定する `combobox` : 入力補助オプション付きフィールドに対して設定するデータ型が`numeric`の場合 `integer` : 整数を扱うフィールドに対して設定する `decimal` : 小数点以下の値を扱うフィールドに対して設定するデータ型が`date`の場合 `date` : 日付のみを扱うフィールドに対して設定する `datetime` : 日時（日付と時刻）を扱うフィールドに対して設定する `time` : 時刻のみを扱うフィールドに対して設定するデータ型が`option`の場合 `single` : 選択肢の中から単一の値を設定するフィールドに対して設定する `multi` : 選択肢の中から複数の値を設定するフィールドに対して設定するデータ型が`reference`の場合 `single` : 単一のレコードが設定可能なフィールドに対して設定する `multi` : 複数のレコードが設定可能なフィールドに対して設定する	`null`
is_required	真偽値	YES	必須入力かどうか	`true`
is_filterable	真偽値	YES	フィルタリング可能かどうか	`true`
is_creatable	真偽値	YES	レコード作成時に指定可能かどうか	`true`
is_updatable	真偽値	YES	レコード更新時に指定可能かどうか	`true`
is_formula	真偽値	YES	計算によって表現されるフィールドかどうか	`false`
max_length	整数値	NO	データ型が`text`の場合の最大文字数	`256`
precision	整数値	NO	データ型が`numeric`の場合の精度（全体の桁数）	`null`
scale	整数値	NO	データ型が`numeric`の場合の小数点以下の桁数	`null`
reference_entities	文字列の配列	NO	データ型が`reference`の場合の参照先のエンティティ名一覧	`null`
options	optionオブジェクトの配列	NO	データ型が`option`の場合、または、サブデータ型が`combobox`の場合の選択肢一覧	`[]`
default_value	-	NO	レコード作成時に画面表示されるデフォルト値デフォルト値が存在しない場合は`null` データ型が`text`の場合: 文字列データ型が`numeric`の場合: 数値データ型が`boolean`の場合: 真偽値データ型が`date`の場合サブデータ型が`date`の場合: ISO8601日付形式の文字列（`YYYY-MM-DD`）サブデータ型が`datetime`の場合: ISO8601日時形式の文字列（`YYYY-MM-DDTHH:MM[:SS[.s+]]Z`）サブデータ型が`time`の場合: ISO8601時刻形式の文字列（`HH:MM[:SS[.s+]]`）データ型が`option`の場合サブデータ型が`single`の場合: optionオブジェクトの`name`の値サブデータ型が`multi`の場合: optionオブジェクトの`name`の配列データ型が`reference`の場合サブデータ型が`single`の場合: レコード参照オブジェクトサブデータ型が`multi`の場合: レコード参照オブジェクトの配列	`null`

optionオブジェクト

フィールド	形式	必須	説明	値の例
name	文字列	YES	オプション名	`finance`
display_name	文字列	YES	オプションの表示名	`金融業`

レコード参照オブジェクト

フィールド	形式	必須	説明	値の例
entity_name	文字列	YES	参照レコードのエンティティ名	`lead`
id	文字列	YES	参照レコードのID	`lead-00000001`

レスポンスボディのサンプル

{
  "name": "name",
  "display_name": "取引先名",
  "type": "text",
  "sub_type": null,
  "is_required": true,
  "is_filterable": true,
  "is_creatable": true,
  "is_updatable": true,
  "is_formula": false,
  "max_length": 256,
  "precision": null,
  "scale": null,
  "reference_entities": null,
  "options": [],
  "default_value": null
}

{
  "name": "revenue",
  "display_name": "売上高",
  "type": "numeric",
  "sub_type": "integer",
  "is_required": false,
  "is_filterable": true,
  "is_creatable": true,
  "is_updatable": true,
  "is_formula": false,
  "max_length": null,
  "precision": 16,
  "scale": 0,
  "reference_entities": null,
  "options": [],
  "default_value": null
}

{
  "name": "industry",
  "display_name": "業種",
  "type": "option",
  "sub_type": "single",
  "is_required": false,
  "is_filterable": true,
  "is_creatable": true,
  "is_updatable": true,
  "is_formula": false,
  "max_length": null,
  "precision": null,
  "scale": null,
  "reference_entities": null,
  "options": [
    {
      "name": "finance",
      "display_name": "金融業"
    },
    {
      "name": "real_estate",
      "display_name": "不動産業"
    },
    ...
  ],
  "default_value": "finance"
}

{
  "name": "originating_lead",
  "display_name": "元のリード",
  "type": "reference",
  "sub_type": null,
  "is_required": false,
  "is_filterable": true,
  "is_creatable": true,
  "is_updatable": false,
  "is_formula": false,
  "max_length": null,
  "precision": null,
  "scale": null,
  "reference_entities": [
    "lead"
  ],
  "options": [],
  "default_value": null
}

💬 具体的な要求事項

検索対象のエンティティ項目名が存在しない場合は、「404 : Not Found」エラーを返却してください
「sub_type」フィールド : combobox
- 任意のテキスト入力を受け付けながら、選択肢による入力補助機能を利用するフィールドの場合にcombobox を設定します
- 「options」フィールドに対しての選択肢一覧の設定も必要になります（comboboxフィールドの挙動サンプル）
「is_formula」フィールド
- このフィールドの値が true である場合（計算によって表現されるフィールドである場合）、以下のフィールドと値の組み合わせを設定してください
  - is_required: false
  - is_filterable: true
  - is_creatable: false
  - is_updatable: false

📚 参考資料

なし