単一エンティティの取得

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

📬 リクエスト

GET {resource_api_url}/entities/{name}

リクエストヘッダ

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

パスパラメータ

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

クエリパラメータ

なし

✨ 成功レスポンス

ステータスコード

200 : OK

レスポンスヘッダ

キー	値
Content-Type	application/json

レスポンスボディ

フィールド	形式	必須	説明	値の例
name	文字列	YES	エンティティ名	account
type	user（ユーザーエンティティ） account（取引先エンティティ） lead（リードエンティティ） contact（取引先責任者エンティティ） activity（活動エンティティ） phone_call（電話履歴エンティティ）	NO	エンティティの種別 UPWARDが標準的に扱うエンティティに該当する場合、その種別を設定する 該当しない場合は、nullを設定する	account
display_name	文字列	YES	エンティティの表示名	取引先名
record_url_format	record_url_formatオブジェクト	NO	レコードのURLを表す文字列フォーマット	{ "app": "sampleapp://record_detail?entity=account&id={id}", "browser": "https://example.com/record_detail?entity=account&id={id}" }
has_location	真偽値	YES	エンティティが位置情報を保持しているかどうか	true
item_mapping	item_mappingオブジェクト	YES	UPWARDが標準的に扱う項目名のマッピング	{ "id": "id", "title": "name", "owner": "owner", "created_at": "created_at", "created_by": "created_by", "modified_at": "modified_at", "modified_by": "modified_by", "latitude": "latitude", "longitude": "longitude" }

record_url_formatオブジェクト

フィールド	形式	必須	説明	値の例
app	文字列	NO	このエンティティのレコードをモバイルアプリで開く際のURL形式	sampleapp://record_detail?entity=account&id={id}
browser	文字列	NO	このエンティティのレコードをPC（Webブラウザ）で開く際のURL形式	https://example.com/record_detail?entity=account&id={id}

item_mappingオブジェクト

フィールド	形式	必須	説明	値の例
id	文字列	YES	レコードのID（一意識別子）が設定されている項目名	id
title	文字列	YES	レコードのタイトルが設定されている項目名	name
owner	文字列	NO	レコードの所有者（ユーザーエンティティへの参照）が設定されている項目名 「type」がactivity, phone_callであるエンティティの場合は必須	owner
created_at	文字列	NO	レコードの作成日時が設定されている項目名	created_at
created_by	文字列	NO	レコードの作成者（ユーザーエンティティへの参照）が設定されている項目名	created_by
modified_at	文字列	NO	レコードの最終更新日時が設定されている項目名	modified_at
modified_by	文字列	NO	レコードの最終更新者（ユーザーエンティティへの参照）が設定されている項目名	modified_by
latitude	文字列	NO	レコードの緯度が設定されている項目名 「has_location」がtrueであるエンティティの場合は必須	latitude
longitude	文字列	NO	レコードの経度が設定されている項目名 「has_location」がtrueであるエンティティの場合は必須	longitude

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

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

{
  "name": "account",
  "type": "account",
  "display_name": "取引先",
  "record_url_format": {
    "app": "http://url-test.app.localhost/records/account/{id}",
    "browser": "http://url-test.browser.localhost/records/account/{id}"
  },
  "has_location": true,
  "item_mapping": {
    "id": "id",
    "title": "name",
    "owner": "owner",
    "created_at": "created_at",
    "created_by": "created_by",
    "modified_at": "modified_at",
    "modified_by": "modified_by",
    "latitude": "latitude",
    "longitude": "longitude"
  }
}

💬 具体的な要求事項

• 検索対象のエンティティ名が存在しない場合は、「404 : Not Found」エラーを返却してください

📚 参考資料

なし