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

エンティティ項目の情報を一覧で返却する

📬 リクエスト

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

リクエストヘッダ

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

パスパラメータ

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

クエリパラメータ

なし

✨ 成功レスポンス

ステータスコード

200 : OK

レスポンスヘッダ

キー	値
Content-Type	application/json

レスポンスボディ

単一エンティティ項目の取得 - レスポンスボディと同内容の配列

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

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

[
  {
    "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
  },
  ...
]

💬 具体的な要求事項

• 配列のソート順は任意ですが、冪等になるようルールを設定してください
• UPWARDで完全に使用しないエンティティ項目は返却対象から除外しても構いません

📚 参考資料

なし