アプリ項目取得API(sheet)

各アプリの項目の詳細を取得できます。

Request

URL

https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/sheet/sheetdef/{sheetName}

HTTP Method

GET

Parameter

Path Parameter

No.	パラメータ	必須	タイプ	デフォルト値	説明
1	tenant	○	string	-	会社ID
2	sheetName	○	string	-	対象アプリ名

Response

itemTypeごとに返却される項目が異なります。

共通で返却される項目

No.	プロパティ名	項目名	タイプ	備考
1	sheetName	アプリ名	string
2	itemDefs	項目定義	object
	- {itemKey}	アイテムキー	object	各itemKeyに対して、項目定義情報がobjectとして返却される。
	-- itemId	アイテムID	string
	-- labelName	項目名	string
	-- itemType	アイテムタイプ	string
	-- itemTypeDef	アイテムタイプ定義	object
	-- isKeywordSearchItem	キーワード検索対象フラグ	boolean
	-- isEditable	編集可能フラグ	boolean
	-- 各itemTypeごとに定義された項目が追加で返却

itemTypeごとに定義された追加で返却される項目

STRING, TEXT, MEMO

No.	プロパティ名	項目名	タイプ	備考
1	isNameItem	名前項目フラグ	boolean

RELATION

No.	プロパティ名	項目名	タイプ	備考
1	isMultiple	複数指定フラグ	boolean
2	relationItemType	relation型項目名	string	CHARGE_TARGET(担当者系), RECEIVER(受取人), CHARGE_WORK(担当業務), INTRODUCTION_SOURCE(紹介元), OUTSIDE_MANAGER(社外担当者), INTERVIEWER(当日面談者), NON(その他)のいずれか
3	itemDefs	項目定義群	object

SB_RELATION

No.	プロパティ名	項目名	タイプ	備考
1	isMultiple	複数指定フラグ	boolean
2	relationItemType	relation型項目名	string	CHARGE_TARGET(担当者系), RECEIVER(受取人), CHARGE_WORK(担当業務), INTRODUCTION_SOURCE(紹介元), OUTSIDE_MANAGER(社外担当者), INTERVIEWER(当日面談者), NON(その他)のいずれか
3	itemDefs	項目定義群	object
4	isJoinReference	テーブル結合フラグ	boolean	TODO

FILE

No.	プロパティ名	項目名	タイプ	備考
1	isMultiSelectable	複数ファイル選択可能フラグ	boolean

SELECT, UNUSABLE_FLG

No.	プロパティ名	項目名	タイプ	備考
1	options	選択肢	array(string)	選択肢名が配列で返却される
2	isMultiSelect	複数選択可能フラグ	boolean

MASTER

No.	プロパティ名	項目名	タイプ	備考
1	options	選択肢	array(string)	選択肢名が配列で返却される
2	isMultiSelect	複数選択可能フラグ	boolean
3	masterItemName	マスタ名	string

NUMBER

No.	プロパティ名	項目名	タイプ	備考
1	decimalDigit	小数点以下桁数	number

FUNCTIONAL_NUMBER

No.	プロパティ名	項目名	タイプ	備考
1	decimalDigit	小数点以下桁数	number

USER, USER_INFO

No.	プロパティ名	項目名	タイプ	備考
1	masterItemName	マスタ名	string

URL

No.	プロパティ名	項目名	タイプ	備考
1	isFixedDefault	初期値固定フラグ	boolean
2	displayText	表示文字列	string

その他のitemTypeに関しては追加項目なし

example

{
    "sheetName": "businessplan",
    "itemDefs": [
        {
            "itemId": "businessplans.businessplan.id",
            "itemType": "ID",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "案件ID"
        },
        {
            "itemId": "businessplans.businessplan.businessplan_name",
            "itemType": "STRING",
            "isEditable": true,
            "isKeywordSearchItem": true,
            "labelName": "案件名",
            "isNameItem": true
        },
        {
            "itemId": "businessplans.businessplan.businessplan_name_other",
            "itemType": "STRING",
            "isEditable": true,
            "isKeywordSearchItem": false,
            "labelName": "案件名（呼称）",
            "isNameItem": false
        },
        {
            "itemId": "businessplans.businessplan.relational_customer",
            "itemType": "SB_RELATION",
            "sheetName": "customer",
            "relationItemType": "NON",
            "isEditable": true,
            "isKeywordSearchItem": true,
            "labelName": "顧客",
            "isMultiple": false,
            "isJoinReference": true
        },
        {
            "itemId": "businessplans.businessplan.business_type",
            "itemType": "MASTER",
            "options": [
                "営業",
                "ルート型"
            ],
            "masterItemName": "BUSINESSTYPE",
            "isEditable": true,
            "isKeywordSearchItem": false,
            "labelName": "業務タイプ",
            "isMultiSelect": false
        },
        {
            "itemId": "businessplans.businessplan.continue_or_terminate_flg",
            "itemType": "SELECT",
            "options": [
                "継続",
                "終了"
            ],
            "isEditable": true,
            "isKeywordSearchItem": false,
            "labelName": "継続／終了",
            "isMultiSelect": false
        },
        {
            "itemId": "businessplans.businessplan.progress",
            "itemType": "MASTER",
            "options": [
                "アプローチ",
                "案件化",
                "提案",
                "内示",
                "受注",
                "納品",
                "検収",
                "中断",
                "失注",
                "--"
            ],
            "masterItemName": "PROGRESS",
            "isEditable": true,
            "isKeywordSearchItem": false,
            "labelName": "進捗状況",
            "isMultiSelect": false
        },
        {
            "itemId": "businessplans.businessplan.relational_milestone",
            "itemType": "SB_RELATION",
            "sheetName": "milestone",
            "relationItemType": "NON",
            "isEditable": true,
            "isKeywordSearchItem": false,
            "labelName": "案件シナリオ",
            "isMultiple": true,
            "isJoinReference": true
        },
        {
            "itemId": "businessplans.businessplan.address",
            "itemType": "ADDRESS",
            "isEditable": true,
            "isKeywordSearchItem": false,
            "labelName": "住所"
        },
        {
            "itemId": "businessplans.businessplan.order_price",
            "itemType": "NUMBER",
            "isEditable": true,
            "isKeywordSearchItem": false,
            "labelName": "受注（予定）金額"
        },
        {
            "itemId": "businessplans.businessplan.memo",
            "itemType": "MEMO",
            "isEditable": true,
            "isKeywordSearchItem": false,
            "labelName": "メモ",
            "isNameItem": false
        },
        {
            "itemId": "businessplans.businessplan.relational_business_card_info",
            "itemType": "SB_RELATION",
            "itemDefs": {
                "businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.position": {
                    "itemId": "business_cards.business_card_info.position",
                    "itemType": "MASTER",
                    "options": [
                        "決裁者",
                        "推進者",
                        "担当者"
                    ],
                    "masterItemName": "POSITION",
                    "isEditable": true,
                    "isKeywordSearchItem": false,
                    "labelName": "立場",
                    "isMultiSelect": false
                },
                "businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.contact_master": {
                    "itemId": "business_cards.business_card_info.contact_master",
                    "itemType": "MASTER",
                    "options": [
                        "キーマン",
                        "担当者"
                    ],
                    "masterItemName": "CONTACTMASTER",
                    "isEditable": true,
                    "isKeywordSearchItem": false,
                    "labelName": "コンタクト先",
                    "isMultiSelect": false
                },
                "businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.valid_contact_date": {
                    "itemId": "business_cards.business_card_info.valid_contact_date",
                    "itemType": "DATETIME",
                    "isEditable": false,
                    "isKeywordSearchItem": false,
                    "labelName": "有効接触日"
                },
                "businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.counter": {
                    "itemId": "business_cards.business_card_info.counter",
                    "itemType": "MASTER",
                    "options": [
                        null
                    ],
                    "masterItemName": "COUNTERMASTER",
                    "isEditable": true,
                    "isKeywordSearchItem": false,
                    "labelName": "窓口",
                    "isMultiSelect": false
                },
                "businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.remarks": {
                    "itemId": "business_cards.business_card_info.remarks",
                    "itemType": "MEMO",
                    "isEditable": true,
                    "isKeywordSearchItem": false,
                    "labelName": "備考",
                    "isNameItem": false
                },
                "businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.relational_businesscard": {
                    "itemId": "business_cards.business_card_info.relational_businesscard",
                    "itemType": "SB_RELATION",
                    "sheetName": "businesscard",
                    "relationItemType": "NON",
                    "isEditable": false,
                    "isKeywordSearchItem": false,
                    "labelName": "名刺",
                    "isMultiple": false,
                    "isJoinReference": true
                },
                "businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.id": {
                    "itemId": "business_cards.business_card_info.id",
                    "itemType": "ID",
                    "isEditable": false,
                    "isKeywordSearchItem": false,
                    "labelName": "名刺情報ID"
                },
                "businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.text_business_card_name": {
                    "itemId": "business_cards.business_card_info.text_business_card_name",
                    "itemType": "STRING",
                    "isEditable": true,
                    "isKeywordSearchItem": false,
                    "labelName": "テキスト名刺氏名",
                    "isNameItem": true
                },
                "businessplans.businessplan.relational_business_card_info@business_cards.business_card_info.motivation": {
                    "itemId": "business_cards.business_card_info.motivation",
                    "itemType": "MASTER",
                    "options": [
                        "不明",
                        "前向き",
                        "中立",
                        "後ろ向き"
                    ],
                    "masterItemName": "MOTIVATION",
                    "isEditable": true,
                    "isKeywordSearchItem": false,
                    "labelName": "意欲",
                    "isMultiSelect": false
                }
            },
            "sheetName": "businesscardinfo",
            "relationItemType": "NON",
            "isEditable": true,
            "isKeywordSearchItem": false,
            "labelName": "案件コンタクト先",
            "isMultiple": true,
            "isJoinReference": true
        },
        {
            "itemId": "businessplans.businessplan.relational_trading_product",
            "itemType": "SB_RELATION",
            "sheetName": "deal",
            "relationItemType": "NON",
            "isEditable": true,
            "isKeywordSearchItem": false,
            "labelName": "取引商品",
            "isMultiple": true,
            "isJoinReference": true
        },
        {
            "itemId": "businessplans.businessplan.businessplan_group",
            "itemType": "STRING",
            "isEditable": true,
            "isKeywordSearchItem": false,
            "labelName": "案件グループ",
            "isNameItem": false
        },
        {
            "itemId": "businessplans.businessplan.charge_group@businessplans.charge_group.main_charge",
            "itemType": "SELECT",
            "options": [
                "主担当に設定する",
                "主担当に設定しない"
            ],
            "isEditable": true,
            "isKeywordSearchItem": false,
            "labelName": "主担当フラグ",
            "isMultiSelect": false
        },
        {
            "itemId": "businessplans.businessplan.charge_group@businessplans.charge_group.target_group@employees.group.id",
            "itemType": "ID",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "社員グループID"
        },
        {
            "itemId": "businessplans.businessplan.charge_employee@businessplans.charge_employee.main_charge",
            "itemType": "SELECT",
            "options": [
                "主担当に設定する",
                "主担当に設定しない"
            ],
            "isEditable": true,
            "isKeywordSearchItem": false,
            "labelName": "主担当フラグ",
            "isMultiSelect": false
        },
        {
            "itemId": "businessplans.businessplan.charge_employee@businessplans.charge_employee.target_employee@employees.employee.id",
            "itemType": "ID",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "社員ID"
        },
        {
            "itemId": "businessplans.businessplan.charge_department@businessplans.charge_department.main_charge",
            "itemType": "SELECT",
            "options": [
                "主担当に設定する",
                "主担当に設定しない"
            ],
            "isEditable": true,
            "isKeywordSearchItem": false,
            "labelName": "主担当フラグ",
            "isMultiSelect": false
        },
        {
            "itemId": "businessplans.businessplan.charge_department@businessplans.charge_department.target_department@employees.department.id",
            "itemType": "ID",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "部署コード"
        },
        {
            "itemId": "businessplans.businessplan.relational_activity",
            "itemType": "SB_RELATION",
            "sheetName": "activity",
            "relationItemType": "NON",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "活動",
            "isMultiple": true,
            "isJoinReference": true
        },
        {
            "itemId": "businessplans.businessplan.relational_task",
            "itemType": "SB_RELATION",
            "sheetName": "task",
            "relationItemType": "NON",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "次回タスク",
            "isMultiple": true,
            "isJoinReference": true
        },
        {
            "itemId": "businessplans.businessplan.relational_schedule",
            "itemType": "SB_RELATION",
            "sheetName": "schedule",
            "relationItemType": "NON",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "次回スケジュール",
            "isMultiple": true,
            "isJoinReference": true
        },
        {
            "itemId": "businessplans.businessplan.valid_contact_period",
            "itemType": "DATETIME",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "有効接触日"
        },
        {
            "itemId": "businessplans.businessplan.address_for_email_import",
            "itemType": "EMAIL",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "メール取り込み用アドレス"
        },
        {
            "itemId": "businessplans.businessplan.latest_active_progress",
            "itemType": "MASTER",
            "options": [
                "アプローチ",
                "案件化",
                "提案",
                "内示",
                "受注",
                "納品",
                "検収",
                "中断",
                "失注",
                "--"
            ],
            "masterItemName": "PROGRESS",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "最終有効進捗状況",
            "isMultiSelect": false
        },
        {
            "itemId": "system_reg_date",
            "itemType": "DATETIME",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "登録日"
        },
        {
            "itemId": "system_reg_user",
            "itemType": "USER",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "登録者"
        },
        {
            "itemId": "system_reg_employee",
            "itemType": "ID",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "登録者"
        },
        {
            "itemId": "system_upd_date",
            "itemType": "DATETIME",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "最終更新日"
        },
        {
            "itemId": "system_upd_user",
            "itemType": "USER",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "最終更新者"
        },
        {
            "itemId": "system_upd_employee",
            "itemType": "ID",
            "isEditable": false,
            "isKeywordSearchItem": false,
            "labelName": "最終更新者"
        }
    ]
}