項目定義取得API(sheet)

各アプリの項目定義を取得できます。

Request

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

GET

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

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

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

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

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

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

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

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

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

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

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

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

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

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