エンドポイント 基本設定/詳細設定一覧

API画面では、APIエンドポイントの追加/更新ができます。
各エンドポイントにはその動作を制御するためのパラメータが設定可能です。

ここでは、エンドポイントに設定できるパラメータについて説明します。

エンドポイントの設定画面

エンドポイントの設定で、モデルを選択すると、選択したモデルに設定できるパラメータが表示されます。

認証

Login

login_challenge

項目	パラメータ	説明
基本設定	login_method	認証方式を選択します。選択可能値: api_key/signature（APIキーとシグネチャによる認証）。未設定の場合はメールアドレスとパスワードによる認証になります。
	twofactor_method	二要素認証を有効にする場合、その方式を選択します。選択可能値: code（TOTP）, email（メール）, SMS（SMS）
詳細設定	use_recaptcha	チェックを入れると、ログイン時にreCAPTCHAを使用します。

login_challenge_mfa

設定できるパラメータなし。

token

項目	パラメータ	説明
基本設定	use_refresh_token	チェックを入れるとリフレッシュトークンを利用します。
	access_token_lifespan	アクセストークンが有効である秒数を設定します。
	refresh_token_lifespan	リフレッシュトークンが有効である秒数を設定します。

file_access_token

項目	パラメータ	説明
基本設定	access_token_lifespan	ファイルアクセストークンが有効である秒数を設定します。デフォルトは300秒（5分）です。

alias_login

設定できるパラメータなし。

logout

設定できるパラメータなし。

reminder

項目	パラメータ	説明
基本設定	password_reset_page_url	ユーザーのメールに表示されるパスワードリセットページのURL。トークンはクエリパラメータとして自動的に追加されます。
詳細設定	token_fragment_flg	チェックを入れると、トークンをURLフラグメントの形式で渡します。(デフォルトではクエリパラメータを利用)
	use_recaptcha	チェックを入れると、リマインドメール送信時にreCAPTCHAを使用します。詳しくはreCAPTCHAを利用したパスワードリマインダーを作成するを参照してください。

reset_password

設定できるパラメータなし。

profile

項目	パラメータ	説明
基本設定	basic_info	取得するユーザ情報の属性を指定します。(複数可能) 例) email,nickname

gcs_info

設定できるパラメータなし。

firebaseToken

項目	パラメータ	説明
基本設定	firebaseConfig	addを選択すると、firebaseConfigの情報をレスポンスに追加します。

LoginHistory

list

項目	パラメータ	説明
基本設定	cnt	1ページの表示件数を指定します。
	allowed_group_ids	閲覧を許可するグループIDを指定します。指定したグループに所属するメンバーのログイン履歴のみが対象になります。
	self_only	チェックを入れると、自分自身のログイン履歴のみを対象にします。
	from_date	検索する開始日を指定します。
	to_date	検索する終了日を指定します。
	login_type	ログインの種類を指定します。
	member_id	対象のメンバーIDを指定します。
	add_member_info_cols	取得したいメンバー属性を指定します。(複数可能) 例) email,nickname
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

LoginFailed

list

項目	パラメータ	説明
基本設定	cnt	1ページの表示件数を指定します。
	allowed_group_ids	閲覧を許可するグループIDを指定します。指定したグループに所属するメンバーのログイン失敗履歴のみが対象になります。
	self_only	チェックを入れると、自分自身のログイン失敗履歴のみを対象にします。
	from_date	検索する開始日を指定します。
	to_date	検索する終了日を指定します。
	member_id	対象のメンバーIDを指定します。
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

TwofactorMethod

reserve

設定できるパラメータなし。

regist

設定できるパラメータなし。

reminder

項目	パラメータ	説明
基本設定	use_sms	チェックを入れると、二要素認証のリセットコードをSMSで送信します。

reset

設定できるパラメータなし。

delete

設定できるパラメータなし。

コンテンツ

Topics

list

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	contents_type	表示するカテゴリIDを指定します。設定がない場合はすべてのカテゴリが対象になります。
	filter	データを絞り込むクエリパラメータです。詳しくは検索機能の使い方を参照してください。
	filter_lang	フィルターの言語を指定します。
	filter_request_allow_list	filterリクエストに指定可能な項目を指定します。指定が無い場合はクエリによるフィルタはできません。全項目を許可したい場合は:ALLを設定してください。
	cnt	1ページの表示件数を指定します。
	order_query	並び順を指定します。 例）topics_id:asc、topics_id:desc 指定可能な項目： topics_id, order_no, ymd, post_time, contents_type, subject, regular_flg, inst_ymdhi, update_ymdhi, topics_group_id, favorite_cnt, comment_cnt
	groupBy	カテゴリ毎にグルーピングをする場合、categoryを選択します。
	ext_group	チェックを入れるとグループ化された拡張項目をまとめる。
詳細設定	type	グルーピングの種類を選択します。(array or object), default: array
	group_by_category_id	カテゴリでグルーピングした場合に、絞り込むカテゴリIDを指定します。
	show_empty_categories	カテゴリでグルーピングした場合にチェックを入れると、コンテンツが存在しないカテゴリも表示します。
	order_by_category_count	カテゴリでグルーピングした場合にチェックを入れると、カテゴリごとの件数で並べ替えます。
	has_permissions	エンドポイントにアクセスするユーザーが、パラメータに設定した権限('insert', 'update', 'delete')を有する場合にのみレスポンスを返します。例えば、has_permissions=deleteが設定されているエンドポイントに、コンテンツの更新権限のみを持つ編集ユーザーがアクセスした場合は権限が無いので0件でレスポンスされます。
	category_grouping_type	カテゴリのグルーピングのキーの形式を選択します。選択可能値: object
	category_grouping_type_use_slug	カテゴリグルーピングでスラッグをキーとして利用します。
	max_distance	最大距離を指定します。（位置情報による検索に使用）
	category_parent_id	絞り込む親カテゴリを指定します。
	exclude_category_parent_id	表示しないカテゴリIDを指定します。
	ext_column	拡張項目の値で一覧を絞りこみます。 指定した値で絞り込む例：ext_column=ext_col_02:15 指定した値以外で絞り込む例：ext_column=ext_col_02!:15
	ymd_sort_change	コンテンツの並び順を日付の昇順に変更したい場合、ymd_sort_change=onを入力します。（デフォルトは降順です。）
	shuffle	ランダム表示にするかどうか(yes/no) 通常はランダムではありません。
	target_col_for_keyword	キーワード検索の対象カラムを指定します。 設定がない場合はタイトル、本文、カテゴリ、拡張項目が対象になります。 補足) subject,contents,contents_typeまたは拡張項目no(ext_col_01,ext_col_10など)を設定します。
	use_target_col_for_keyword_from_request	リクエストでキーワード検索の対象項目の絞り込むを利用する。
	topics_keyword_cond	topics_keywordによる検索でキーワード毎の絞り込み方を変える。(デフォルト：AND)
	full_text_search_cond	全文検索のキーワード毎の絞り込み方を変えます。選択可能値: AND, OR
	tag_category_id	表示対象になるタグカテゴリIDを指定します。設定がない場合はすべてのカテゴリが対象になります。
	exclude_tag_category_id	表示対象から除外するタグカテゴリIDを指定します。
	tag_id	表示対象になるタグIDを指定します。
	exclude_tag_id	表示対象から除外するタグIDを指定します。
	tag_cond	タグの絞り込み方を変える(デフォルト：OR)
	topics_id	表示するコンテンツIDを設定します。
	order_by_id	topics_idで並び順を指定できます。指定したtopics_idのデータが上位表示されます。
	exclude_topics_id	除外するコンテンツIDを指定します。
	get_comment_cnt	チェックを入れるとレスポンスにコメント数が追加されます。
	get_unlisted_data	チェックを入れるとレスポンスに一覧に載せないデータも含まれるようになります。
	comment_cond_date	コメント数を取得する際の日付条件を設定します。（例：7日前の場合「-7 day」）
	get_favorite_cnt	チェックを入れるとレスポンスにお気に入り数が追加されます。
	my_favorite_list	チェックを入れると自分のお気に入りでコンテンツを絞り込みます。
	my_comment_list	チェックを入れると自分のコメントしたコンテンツを絞り込みます。
	my_own_list	チェックを入れると自分の所有コンテンツを絞り込みます。
	add_owner_info_cols	取得したいコンテンツ所有者属性を指定します。(複数可能) 例: email,nickname
	required_param	必須にしたいクエリパラメータを指定します。
	add_my_favorite_flg	チェックを入れると、エンドポイントを呼び出したユーザーが対象のコンテンツをお気に入り登録しているかがレスポンスに追加されます。 お気に入り登録している=>"my_favorite_flg": true お気に入り登録していない=>"my_favorite_flg": false
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。
	favorite_action_type	my_favorite_listを有効にした場合、お気に入りのアクションタイプを指定してさらに詳しく絞り込みます。
	exclude_favorited_topics	お気に入り済みのデータを対象外とします。
	get_tag_flg	チェックを入れるとレスポンスにタグ情報が追加されます。
	get_tag_order_by_tag_category	get_tag_flgが有効な場合にチェックを入れると、カテゴリ毎にタグを並べます。
	ignore_open_flg	チェックを入れると非公開コンテンツをレスポンスに含めます。
	ignore_category_open_flg	チェックを入れると非公開カテゴリのコンテンツもレスポンスに含めます。
	ignore_tag_open_flg	チェックを入れると非公開タグのコンテンツもレスポンスに含めます。
	central_id	取得の中心にするIDを指定します。
	add_open_ymdhi	チェックを入れると公開開始・終了日時をレスポンスに含めます。
	ignore_restrict_flg	チェックを入れるとアクセス制限を無視します。
	use_pre_embedding_text	チェックを入れると事前に生成されたembeddingテキストを使用します。
	max_list_chars	一覧表示時の最大文字数を指定します。0の場合は制限なし。

details

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	contents_type	表示するカテゴリIDを指定します。設定がない場合はすべてのカテゴリが対象になります。
	filter	データを絞り込むクエリパラメータです。詳しくは検索機能の使い方を参照してください。
	filter_lang	フィルターの言語を指定します。
	filter_request_allow_list	filterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は:ALLを設定してください)
	ext_group	チェックを入れるとグループ化された拡張項目をまとめる。
詳細設定	category_parent_id	絞り込む親カテゴリを指定します。
	exclude_category_parent_id	表示しないカテゴリIDを指定します。
	ext_column	拡張項目の値で一覧を絞り込みます。 指定した値で絞り込む例：ext_column=ext_col_02:15 指定した値以外で絞り込む例：ext_column=ext_col_02!:15
	target_col_for_keyword	キーワード検索の対象カラムを指定します。設定がない場合はタイトル、本文、カテゴリ、拡張項目が対象になります。 補足) subject,contents,contents_typeまたは拡張項目no(ext_col_01,ext_col_10など)を設定します。
	use_target_col_for_keyword_from_request	リクエストでキーワード検索の対象項目の絞り込みを利用する。
	topics_keyword_cond	キーワード検索のキーワード毎の絞り込み方を変える。（デフォルト：AND)
	full_text_search_cond	全文検索のキーワード毎の絞り込み方を変えます。選択可能値: AND, OR
	tag_category_id	表示対象になるタグカテゴリIDを指定します。設定がない場合はすべてのカテゴリが対象になります。
	exclude_tag_category_id	表示対象から除外するタグカテゴリIDを指定します。
	tag_id	表示対象になるタグIDを指定します。
	exclude_tag_id	表示対象から除外するタグIDを指定します。
	tag_cond	タグの絞り込み方を変える（デフォルト：OR)
	exclude_topics_id	除外するコンテンツIDを指定します。
	get_comment_cnt	チェックを入れるとレスポンスにコメント数が追加されます。
	get_unlisted_data	チェックを入れるとレスポンスに一覧に載せないデータも含まれるようになります。
	comment_cond_date	コメント数を取得する際の日付条件を設定します。（例：7日前の場合「-7 day」）
	get_favorite_cnt	チェックを入れるとレスポンスにお気に入り数が追加されます。
	my_favorite_list	チェックを入れると自分のお気に入りでコンテンツを絞り込みます。
	my_comment_list	チェックを入れると自分のコメントしたコンテンツを絞り込みます。
	my_own_list	チェックを入れると自分の所有コンテンツを絞り込みます。
	add_owner_info_cols	取得したいコンテンツ所有者属性を指定します。(複数可能) 例) email,nickname
	required_param	必須にしたいクエリパラメータを指定します。
	add_my_favorite_flg	チェックを入れると、エンドポイントを呼び出したユーザーが対象のコンテンツをお気に入り登録しているかがレスポンスに追加されます。 お気に入り登録している=>"my_favorite_flg": true お気に入り登録していない=>"my_favorite_flg": false
	favorite_action_type	my_favorite_listを有効にした場合、お気に入りのアクションタイプを指定してさらに詳しく絞り込みます。
	exclude_favorited_topics	お気に入り済みのデータを対象外とします。
	get_tag_flg	チェックを入れるとレスポンスにタグ情報が追加されます。
	get_tag_order_by_tag_category	get_tag_flgが有効な場合にチェックを入れると、カテゴリ毎にタグを並べます。
	ignore_open_flg	チェックを入れると非公開コンテンツをレスポンスに含めます。
	ignore_category_open_flg	チェックを入れると非公開カテゴリのコンテンツもレスポンスに含めます。
	ignore_tag_open_flg	チェックを入れると非公開タグのコンテンツもレスポンスに含めます。
	add_open_ymdhi	チェックを入れると公開開始・終了日時をレスポンスに含めます。
	ignore_restrict_flg	チェックを入れるとアクセス制限を無視します。
	use_pre_embedding_text	チェックを入れると事前に生成されたembeddingテキストを使用します。
	max_list_chars	一覧表示時の最大文字数を指定します。0の場合は制限なし。

preview

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	contents_type	表示するカテゴリIDを指定します。設定がない場合はすべてのカテゴリが対象になります。
	filter	データを絞り込むクエリパラメータです。詳しくは検索機能の使い方を参照してください。
	filter_lang	フィルターの言語を指定します。
	filter_request_allow_list	filterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は:ALLを設定してください)
	ext_group	チェックを入れるとグループ化された拡張項目をまとめる。
詳細設定	category_parent_id	絞り込む親カテゴリを指定します。
	exclude_category_parent_id	表示しないカテゴリIDを指定します。
	ext_column	拡張項目の値で一覧を絞り込みます。 指定した値で絞り込む例：ext_column=ext_col_02:15 指定した値以外で絞り込む例：ext_column=ext_col_02!:15
	target_col_for_keyword	キーワード検索の対象カラムを指定します。設定がない場合はタイトル、本文、カテゴリ、拡張項目が対象になります。 補足) subject,contents,contents_typeまたは拡張項目no(ext_col_01,ext_col_10など)を設定します。
	use_target_col_for_keyword_from_request	リクエストでキーワード検索の対象項目の絞り込みを利用する。
	topics_keyword_cond	キーワード検索のキーワード毎の絞り込み方を変える。（デフォルト：AND)
	full_text_search_cond	全文検索のキーワード毎の絞り込み方を変えます。選択可能値: AND, OR
	tag_category_id	表示対象になるタグカテゴリIDを指定します。設定がない場合はすべてのカテゴリが対象になります。
	exclude_tag_category_id	表示対象から除外するタグカテゴリIDを指定します。
	tag_id	表示対象になるタグIDを指定します。
	exclude_tag_id	表示対象から除外するタグIDを指定します。
	tag_cond	タグの絞り込み方を変える（デフォルト：OR)
	exclude_topics_id	除外するコンテンツIDを指定します。
	get_comment_cnt	チェックを入れるとレスポンスにコメント数が追加されます。
	get_unlisted_data	チェックを入れるとレスポンスに一覧に載せないデータも含まれるようになります。
	comment_cond_date	コメント数を取得する際の日付条件を設定します。（例：7日前の場合「-7 day」）
	get_favorite_cnt	チェックを入れるとレスポンスにお気に入り数が追加されます。
	my_favorite_list	チェックを入れると自分のお気に入りでコンテンツを絞り込みます。
	my_comment_list	チェックを入れると自分のコメントしたコンテンツを絞り込みます。
	my_own_list	チェックを入れると自分の所有コンテンツを絞り込みます。
	add_owner_info_cols	取得したいコンテンツ所有者属性を指定します。(複数可能) 例) email,nickname
	required_param	必須にしたいクエリパラメータを指定します。
	add_my_favorite_flg	チェックを入れると、エンドポイントを呼び出したユーザーが対象のコンテンツをお気に入り登録しているかがレスポンスに追加されます。 お気に入り登録している=>"my_favorite_flg": true お気に入り登録していない=>"my_favorite_flg": false
	favorite_action_type	my_favorite_listを有効にした場合、お気に入りのアクションタイプを指定してさらに詳しく絞り込みます。
	exclude_favorited_topics	お気に入り済みのデータを対象外とします。
	get_tag_flg	チェックを入れるとレスポンスにタグ情報が追加されます。
	get_tag_order_by_tag_category	get_tag_flgが有効な場合にチェックを入れると、カテゴリ毎にタグを並べます。
	ignore_open_flg	チェックを入れると非公開コンテンツをレスポンスに含めます。
	ignore_category_open_flg	チェックを入れると非公開カテゴリのコンテンツもレスポンスに含めます。
	ignore_tag_open_flg	チェックを入れると非公開タグのコンテンツもレスポンスに含めます。
	add_open_ymdhi	チェックを入れると公開開始・終了日時をレスポンスに含めます。
	ignore_restrict_flg	チェックを入れるとアクセス制限を無視します。
	use_pre_embedding_text	チェックを入れると事前に生成されたembeddingテキストを使用します。
	max_list_chars	一覧表示時の最大文字数を指定します。0の場合は制限なし。

insert

項目	パラメータ	説明
基本設定	topics_group_id	追加するコンテンツ定義IDを指定します。
	use_columns	利用する項目を指定します。
	unuse_columns	利用しない項目を指定します。
	require_columns	必須項目を指定します。
	ext_group	チェックを入れるとグループ化された拡張項目をまとめる。
詳細設定	validate_only	入力チェックのみを行い、実際のデータ更新は行いません。
	lightweight_mode	軽量モード: 有効な場合、後処理バッチの実行をスキップしますが、代わりにパフォーマンスが向上します。
	upsert_by_columns	指定したカラムにpostされた値があれば、その値を持つレコードを更新します。
	compare_by_columns	指定したカラムの値を比較し、変更がある場合のみ更新します。

update

項目	パラメータ	説明
基本設定	topics_group_id	更新するコンテンツ定義IDを指定します。
	use_columns	利用する項目を指定します。
	unuse_columns	利用しない項目を指定します。
	require_columns	必須項目を指定します。
	ext_group	チェックを入れるとグループ化された拡張項目をまとめる。
詳細設定	validate_only	入力チェックのみを行い、実際のデータ更新は行いません。
	lightweight_mode	軽量モード: 有効な場合、後処理バッチの実行をスキップしますが、代わりにパフォーマンスが向上します。

delete

項目	パラメータ	説明
基本設定	topics_group_id	削除するコンテンツ定義IDを指定します。

draft_list

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	self_only	ログインしているユーザー（自分のデータ）に対応するデータのみを返す／更新可能
	cnt	1ページの表示件数を指定します。
	filter	データを絞り込むクエリパラメータです。詳しくは検索機能の使い方を参照してください。
	filter_request_allow_list	filterリクエストに指定可能な項目を指定します。指定が無い場合はクエリによるフィルタはできません。全項目を許可したい場合は:ALLを設定してください。

draft_detail

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	self_only	ログインしているユーザー（自分のデータ）に対応するデータのみを返す／更新可能
	ext_group	グループ化された拡張項目をまとめる。

draft_save

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	topics_id	draft_save時に、対象にするtopics_idを指定します。
	use_columns	利用する項目を指定します。
	unuse_columns	利用しない項目を指定します。
	require_columns	必須項目を指定します。
	ext_group	チェックを入れるとグループ化された拡張項目をまとめる。
詳細設定	upsert_by_columns	指定したカラムにpostされた値があれば、その値を持つレコードを更新します。
	compare_by_columns	指定したカラムの値を比較し、変更がある場合のみ更新します。

draft_delete

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。

draft_update

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	topics_id	対象にするコンテンツIDを指定します。

waiting_for_approval_list

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	self_only	ログインしているユーザー（自分のデータ）に対応するデータのみを返す／更新可能
	cnt	1ページの表示件数を指定します。
	filter	データを絞り込むクエリパラメータです。詳しくは検索機能の使い方を参照してください。
	filter_request_allow_list	filterリクエストに指定可能な項目を指定します。指定が無い場合はクエリによるフィルタはできません。全項目を許可したい場合は:ALLを設定してください。
	get_workflow_info	チェックを入れるとワークフロー情報をレスポンスに追加します。

waiting_for_approval_details

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	self_only	ログインしているユーザー（自分のデータ）に対応するデータのみを返す／更新可能
	ext_group	グループ化された拡張項目をまとめる。

history_list

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
詳細設定	diff_only	項目のみ取得する。(detail要素がレスポンスされない形になります。)

accept

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	use_columns	利用する項目を指定します。
	unuse_columns	利用しない項目を指定します。
	require_columns	必須項目を指定します。
	ext_group	チェックを入れるとグループ化された拡張項目をまとめる。
詳細設定	validate_only	入力チェックのみを行い、実際のデータ更新は行いません。

reject

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。

bulk_upsert

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	use_columns	利用する項目を指定します。
	unuse_columns	利用しない項目を指定します。
	require_columns	必須項目を指定します。
	ext_group	チェックを入れるとグループ化された拡張項目をまとめる。
詳細設定	postprocess_min_after	更新の後処理バッチを何分後に登録するか (デフォルト: 1)
	lightweight_mode	軽量モード: 有効な場合、後処理バッチの実行をスキップしますが、代わりにパフォーマンスが向上します。
	id_reference_allow_list	外部システムのデータIDを指定します。
	ignore_errors	エラーが発生しても無視して処理を続行します。
	validate_only	入力チェックのみを行い、実際のデータ更新は行いません。

bulk_download

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	file_type	ファイルタイプを選択します。(デフォルトはcsvです。ファイルダウンロードの場合はfileを選択してください)
	filter	データを絞り込むクエリパラメータです。詳しくは検索機能の使い方を参照してください。
	order_query	並び順を指定します。例）topics_id=ASC
	filter_request_allow_list	filterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は:ALLを設定してください)
	output_columns	出力する列を指定します。

increment

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	ext_nm	対象の拡張項目名(ID/Slug)を指定します。
	index	配列型の拡張項目の場合、対象のインデックスを指定します。
詳細設定	nums	増減できる数値の制限を指定します。
	num	増減する固定数値を指定します。
	use_recaptcha	チェックを入れると、reCAPTCHAを使用します。

TopicsCategory

list

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	contents_type	表示するカテゴリIDを指定します。設定がない場合はすべてのカテゴリが対象になります。
	cnt	1ページの表示件数を指定します。
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。
詳細設定	count_by_category	カテゴリごとの件数を取得する。取得しない:0(デフォルト) 取得する:1
	count_by_category_method	カテゴリ件数の集計方法を選択します。親カテゴリのみの件数、または子カテゴリを含めた件数を指定できます。
	order_by_count	カテゴリごとの件数で並べ替えます。
	ignore_open_flg	チェックを入れると非公開カテゴリもレスポンスに含めます。

TopicsGroup

list

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	cnt	1ページの表示行数を指定します。

details

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	ext_config_flg	拡張項目設定を取得するか指定します、取得した拡張情報は$extensions_configにassignされます。
	ext_no_for_count	件数を取得したい選択系拡張番号を指定します。

insert

項目	パラメータ	説明
基本設定	open_flg	公開フラグを設定します。

メンバー

Member

list

項目	パラメータ	説明
基本設定	filter	データを絞り込むクエリパラメータです。詳しくは検索機能の使い方を参照してください。
	filter_request_allow_list	filterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は:ALLを設定してください)
	cnt	1ページの表示件数を指定します。
	order_query	並び順を指定します。
詳細設定	response_ec_data	チェックを入れるとEC関連データをレスポンスに含めます。
	custom_search_id	対象にするメンバーのカスタムメンバーフィルターIDを指定します。
	group_id	対象にするメンバーのグループIDを指定します。
	member_id	対象にするメンバーIDを指定します。
	assign_group_flg	チェックを入れるとグループ情報をレスポンスに含めます。
	open_by_group	チェックを入れるとグループ権限で表示を絞り込みます。
	get_tag_flg	チェックを入れるとレスポンスにタグ情報が追加されます。
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。
	check_login_lock	チェックを入れるとログインロック状態を確認します。

details

項目	パラメータ	説明
基本設定	self_only	自分の情報のみにAPIリクエストできます。
	filter	データを絞り込むクエリパラメータです。詳しくは検索機能の使い方を参照してください。
	filter_request_allow_list	filterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は:ALLを設定してください)
	order_query	並び順を指定します。
詳細設定	response_ec_data	チェックを入れるとEC関連データをレスポンスに含めます。
	custom_search_id	対象にするメンバーのカスタムメンバーフィルターIDを指定します。
	group_id	対象にするメンバーのグループIDを指定します。
	assign_group_flg	チェックを入れるとグループ情報をレスポンスに含めます。
	open_by_group	チェックを入れるとグループ権限で表示を絞り込みます。
	get_tag_flg	チェックを入れるとレスポンスにタグ情報が追加されます。
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。
	check_login_lock	チェックを入れるとログインロック状態を確認します。

invite

項目	パラメータ	説明
基本設定	default_group_ids	メンバーが最初に所属するグループIDを指定します。ここでのグループID指定は、メンバー管理機能の初期グループ設定より優先されます。
	admin_regist_ok	管理者(スーパーユーザー)として登録する。
詳細設定	use_recaptcha	チェックを入れると、reCAPTCHAを使用します。

insert

項目	パラメータ	説明
基本設定	default_group_id	メンバーが最初に所属するグループIDを指定します。ここでのグループID指定は、メンバー管理機能の初期グループ設定より優先されます。
	not_login_after_insert	チェックを入れると登録後にログインを行いません。
	login_ok_flg	チェックを入れるとログインを許可します。
	use_columns	利用する項目を指定します。
	unuse_columns	利用しない項目を指定します。
	require_columns	必須項目を指定します。
詳細設定	validate_only	入力チェックのみを行い、実際のデータ更新は行いません。
	send_email_flg	チェックを入れるとメンバー情報登録完了時にユーザーへメール送信します。
	ignore_force_chpwd	チェックを入れると初回ログイン時のパスワード変更をスキップします。
	use_recaptcha	チェックを入れると、reCAPTCHAを使用します。

update

項目	パラメータ	説明
基本設定	allowed_group_ids	更新許可するグループを指定します。
	self_only	自分の情報のみにAPIリクエストできます。
	use_columns	利用する項目を指定します。
	unuse_columns	利用しない項目を指定します。
	require_columns	必須項目を指定します。
詳細設定	validate_only	入力チェックのみを行い、実際のデータ更新は行いません。
	send_email_flg	チェックを入れるとメンバー情報更新完了時にユーザーへメール送信します。
	check_current_pwd	チェックを入れると現在のパスワードの確認を行います。
	keep_without_allowed_group_ids	チェックを入れると許可グループ外のメンバーも更新対象に含めます。

delete

項目	パラメータ	説明
基本設定	allowed_group_ids	削除許可するグループを指定します。
	self_only	自分の情報のみにAPIリクエストできます。

bulk_upsert

項目	パラメータ	説明
基本設定	init_group_id	メンバーが最初に所属するグループIDを指定します。ここでのグループID指定は、メンバー管理機能の初期グループ設定より優先されます。
	allow_set_group	CSVに入力した「グループID」での登録を有効にする。
	use_columns	利用する項目を指定します。
	unuse_columns	利用しない項目を設定する。
	require_columns	必須項目を指定する。
	login_ok_flg	ログイン許可する。

MemberProvisional

list

項目	パラメータ	説明
基本設定	registration_status	登録状況によるフィルタを選択します。選択可能値: registered, unregistered
	cnt	1ページの表示件数を指定します。
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

insert

項目	パラメータ	説明
基本設定	default_group_ids	メンバー登録時、設定されるメンバーグループIDを指定します。
	admin_regist_ok	管理者(スーパーユーザー)として登録する。

update

設定できるパラメータなし。

delete

設定できるパラメータなし。

MemberCustomSearch

list

項目	パラメータ	説明
基本設定	cnt	1ページの表示件数を指定します。
	share_type	共有区分を選択します。(1: 全体、2: 自分のみ、3: グループ指定)
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

details

設定できるパラメータなし。

insert

項目	パラメータ	説明
基本設定	member_allow_list	メンバーのfilterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は:ALLを設定してください)
	inquiry_allow_list	お問い合わせのfilterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は:ALLを設定してください)
	ec_allow_list	ECのfilterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は:ALLを設定してください)
	staticcontents_allow_list	静的コンテンツのfilterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は:ALLを設定してください)

update

項目	パラメータ	説明
基本設定	member_allow_list	メンバーのfilterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は:ALLを設定してください)
	inquiry_allow_list	お問い合わせのfilterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は:ALLを設定してください)
	ec_allow_list	ECのfilterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は:ALLを設定してください)
	staticcontents_allow_list	静的コンテンツのfilterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は:ALLを設定してください)

delete

設定できるパラメータなし。

identify

項目	パラメータ	説明
基本設定	self_only	自分の情報のみにAPIリクエストできます。
詳細設定	use_recaptcha	チェックを入れると、reCAPTCHAを使用します。

MemberForm

details

項目	パラメータ	説明
基本設定	use_columns	利用する項目を指定します。
	unuse_columns	利用しない項目を指定します。
	require_columns	必須項目を指定します。

MemberGroup

list

項目	パラメータ	説明
基本設定	group_ids	表示したいグループIDを指定します。
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

アクティビティ

Comment

list

項目	パラメータ	説明
基本設定	id	対象にするアクティビティIDを指定します。
	module_id	モジュールIDを指定して下さい。
	module_type	モジュールタイプを指定して下さい。例) topics or ec_product or tag or member or comment or csvtable
	filter	データを絞り込むクエリパラメータです。詳しくはこちらを確認してください。
	filter_request_allow_list	filterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は :ALL を設定します。)
	order_query	並び順を指定します。 例) foo=ASC,bar=DESC
	cnt	1ページの表示件数を指定します。
詳細設定	groupBy	グルーピングの単位を選択します。
	type	グルーピングの種類を選択します。(array or object), デフォルト: array
	new_order_flg	新着順に表示する。
	my_list	自分がしたコメント一覧を取得する。
	to_me_list	自分宛のコメント一覧を取得する。
	from_date	コメント抽出期間を指定します。（開始）（例：「2020－01－01」形式、または過去1ヶ月分を指定したい場合は「-1 month」と設定可能）
	to_date	コメント抽出期間を指定します。（終了）（例：「2020－01－01」形式、または過去1ヶ月前までと指定したい場合は「-1 month」と設定可能）
	member_info	取得したいコメントユーザ情報の属性を指定します。(複数可能) 例) email,nickname
	to_member_info	取得したい被コメントユーザ情報の属性を指定します。(複数可能) 例) email,nickname
	root	ツリー階層の親コメントIDを指定します。
	depth	コメントの階層数を指定します。
	children_cnt	子コメントの表示件数を指定します。
	children_pageID	取得したい子コメントのpageID(何ページ目のデータ)を指定します。
	flatten_hierarchy	ツリー構造をフラット構造に変換する。
	explain_reason_hidden	レスポンスオブジェクトに、コメントを非表示にする理由を説明するフィールドを追加する。
	show_hidden_comments	レスポンスオブジェクトに非表示のコメントを表示する。

insert

項目	パラメータ	説明
基本設定	id	対象にするアクティビティIDを指定します。
	order_desc_flg	初期投稿日時降順で表示します。
詳細設定	use_recaptcha	reCAPTCHAを使用する。

update

項目	パラメータ	説明
基本設定	id	対象にするアクティビティIDを指定します。
	order_desc_flg	初期投稿日時降順で表示します。

delete

項目	パラメータ	説明
基本設定	id	対象にするアクティビティIDを指定します。
	order_desc_flg	初期投稿日時降順で表示します。

お気に入り

Favorite

list

項目	パラメータ	説明
基本設定	action_type	対象にするアクション種別を指定します。数値またはスラッグ名で指定可能です。(デフォルト:0)
	filter	データを絞り込むクエリパラメータです。詳しくはこちらを確認してください。
	filter_request_allow_list	filterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は :ALL を設定します。)
	module_type	対象にするモジュールタイプを指定します。(デフォルト:topics)
	cnt	1ページの表示件数を指定します。
	order	並び順を指定します。例) inst_ymdhi:desc
	self_only	自分の情報のみにAPIリクエストできます。
詳細設定	groupBy	グルーピングの単位を選択します。
	type	グルーピングの種類を選択します。(array or object), デフォルト: array
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。
	my_list	ログインしているユーザーのお気に入り一覧を取得する。
	member_info	取得したいユーザ情報の属性を指定します。(複数可能) 例) email,nickname

insert

項目	パラメータ	説明
基本設定	action_type	対象にするアクション種別を数値で指定します。(デフォルト:0)
	module_type	対象にするモジュールタイプを指定します。(デフォルト:topics)
詳細設定	skip_cache_clear_on_favorite	お気に入り登録時にCDNキャッシュのパージをスキップする。
	use_recaptcha	reCAPTCHAを使用する。

delete

項目	パラメータ	説明
基本設定	action_type	対象にするアクション種別を指定します。数値またはスラッグ名で指定可能です。(デフォルト:0)
	module_type	対象にするモジュールタイプを指定します。(デフォルト:topics)
	identify_by	リソースの識別方法を選択します。(favorite_id or body)
詳細設定	skip_cache_clear_on_favorite	お気に入り削除時にCDNキャッシュのパージをスキップする。

フォーム

InquiryMessage

list

項目	パラメータ	説明
基本設定	inquiry_id	対象にしたいフォームIDを指定します。
	self_only	自分の情報のみにAPIリクエストできます。
	filter	データを絞り込むクエリパラメータです。詳しくはこちらを確認してください。
	filter_request_allow_list	filterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は :ALL を設定します。)
	order_query	並び順を指定します。 例) foo=ASC,bar=DESC
	member_info	取得したい回答ユーザ情報の属性を指定します。(複数可能) 例) email,nickname
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。
詳細設定	include_child	振り分け回答も取得する。
	cnt	1ページの表示件数を指定します。

details

項目	パラメータ	説明
基本設定	inquiry_id	対象にしたいフォームIDを指定します。
	self_only	自分の情報のみにAPIリクエストできます。
	member_info	取得したい回答ユーザ情報の属性を指定します。(複数可能) 例) email,nickname

send

項目	パラメータ	説明
基本設定	id	対象にしたいフォームIDを指定します。
	assign_status	回答に割り当てるステータスを指定します。
詳細設定	validate_only	入力チェックする。
	member_info_flg	ログインしているメンバー情報を取得してメッセージテンプレートで$member_infoとしてアサインする。
	allow_parent_inquiry_bn_id	リクエストボディでの親回答ID(parent_inquiry_bn_id)の指定を許可する。
	use_recaptcha	reCAPTCHAを使用する。

update

項目	パラメータ	説明
基本設定	id	対象にしたいフォームIDを指定します。
	self_only	自分の情報のみにAPIリクエストできます。
	use_columns	利用する項目を指定します。
詳細設定	validate_only	入力チェックする。

delete

項目	パラメータ	説明
基本設定	id	対象にしたいフォームIDを指定します。
	self_only	自分の情報のみにAPIリクエストできます。

bulk_upsert

項目	パラメータ	説明
基本設定	id	対象にしたいフォームIDを指定します。
	self_only	自分の情報のみにAPIリクエストできます。
	permission	許可するオペレーションを選択します。(insert or update)

InquiryForm

list

項目	パラメータ	説明
基本設定	inquiry_id	対象にしたいフォームIDを指定します。
	filter	データを絞り込むクエリパラメータです。詳しくはこちらを確認してください。
	filter_request_allow_list	filterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は :ALL を設定します。)
	cnt	1ページの表示件数を指定します。
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。
詳細設定	cols_type	カラムタイプを選択します。
	show_all_status	全てのステータスを表示する。

details

項目	パラメータ	説明
基本設定	target_inquiry_id	対象にしたいフォームIDを指定します。
	filter	データを絞り込むクエリパラメータです。詳しくはこちらを確認してください。
	filter_request_allow_list	filterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は :ALL を設定します。)
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。
詳細設定	cols_type	カラムタイプを選択します。
	show_all_status	全てのステータスを表示する。

insert

項目	パラメータ	説明
基本設定	validate_only	入力チェックする。

update

項目	パラメータ	説明
基本設定	validate_only	入力チェックする。

delete

設定できるパラメータなし。

report

項目	パラメータ	説明
基本設定	inquiry_id	対象にしたいフォームIDを指定します。

配信

MagazineInfo

list

項目	パラメータ	説明
基本設定	magazine_id	対象にする配信IDを指定します。
	exclude_magazine_id	除外する配信IDを指定します。
	cnt	1ページの表示件数を指定します。
	self_only	自分の情報のみにAPIリクエストできます。
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

MagazineSubscriber

list

項目	パラメータ	説明
基本設定	magazine_id	対象にする配信IDを指定します。
	cnt	1ページの表示件数を指定します。
	filter	データを絞り込むクエリパラメータです。詳しくはこちらを確認してください。
	filter_request_allow_list	filterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は :ALL を設定します。)
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

subscribe

項目	パラメータ	説明
基本設定	allow_magazine_id	購読許可するIDを指定します。
	self_only	自分の情報のみにAPIリクエストできます。

unsubscribe

項目	パラメータ	説明
基本設定	allow_magazine_id	購読解除許可するIDを指定します。
	self_only	自分の情報のみにAPIリクエストできます。
	required_key	購読者キーを要求する。

Magazine

send

項目	パラメータ	説明
基本設定	allow_magazine_id	送信許可する配信IDを指定します。
	destination_id	送信するカスタムメンバーフィルターIDを指定します。
	allow_destination_id	送信許可するカスタムメンバーフィルターIDを指定します。
	mail_type	mail_typeを選択します。0:テキストメール 1:HTMLメール 3:モバイルメール
	mail_template_name	HTML用メールテンプレート名を指定します。
	mail_text_template_name	テキストメール用テンプレート名を指定します。
	subject	件名を指定します。

delete

項目	パラメータ	説明
基本設定	allow_magazine_id	削除許可する配信IDを指定します。

subscribe

項目	パラメータ	説明
基本設定	allow_magazine_id	購読許可する配信IDを指定します。

unsubscribe

項目	パラメータ	説明
基本設定	allow_magazine_id	購読解除許可する配信IDを指定します。

list

項目	パラメータ	説明
基本設定	allow_magazine_id	閲覧許可する配信IDを指定します。
	cnt	1ページの表示件数を指定します。
	self_only	自分の情報のみにAPIリクエストできます。
	filter	データを絞り込むクエリパラメータです。詳しくはこちらを確認してください。
	filter_request_allow_list	filterリクエストに指定可能な項目のリスト (デフォルト: 対象項目なし / 全項目を許可したい場合は :ALL を設定します。)
	order_query	並び順を指定します。 例) foo=ASC,bar=DESC
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

EC

ECOrderSubscription

list

項目	パラメータ	説明
基本設定	self_only	自分の情報のみにAPIリクエストできます。
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

details

項目	パラメータ	説明
基本設定	self_only	自分の情報のみにAPIリクエストできます。

insert

設定できるパラメータなし。

auth_sp_career

設定できるパラメータなし。

ECOrder

list

項目	パラメータ	説明
基本設定	self_only	自分の情報のみにAPIリクエストできます。
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

details

項目	パラメータ	説明
基本設定	self_only	自分の情報のみにAPIリクエストできます。

total

設定できるパラメータなし。

purchase

項目	パラメータ	説明
基本設定	validate_only	入力チェックする。

cancel

項目	パラメータ	説明
基本設定	self_only	自分の情報のみにAPIリクエストできます。
	send_mail	メール送信する。

insert

設定できるパラメータなし。

auth_sp_career

設定できるパラメータなし。

ECDelivery

list

設定できるパラメータなし。

details

設定できるパラメータなし。

ECCart

details

設定できるパラメータなし。

add

設定できるパラメータなし。

update

設定できるパラメータなし。

ECShop

list

項目	パラメータ	説明
基本設定	show_email_properties	問い合わせ受付などのEメールプロパティの表示・非表示オプション。
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

details

項目	パラメータ	説明
基本設定	show_email_properties	問い合わせ受付などのEメールプロパティの表示・非表示オプション。

ECProduct

list

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	contents_type	表示するカテゴリIDを指定します。設定がない場合はすべてのカテゴリが対象になります。
	filter	データを絞り込むクエリパラメータです。詳しくは検索機能の使い方を参照してください。
	filter_request_allow_list	filterリクエストに指定可能な項目を指定します。指定が無い場合はクエリによるフィルタはできません。全項目を許可したい場合は:ALLを設定してください。
	cnt	1ページの表示件数を指定します。
	order_query	並び順を指定します。 例）topics_id:asc、topics_id:desc 指定可能な項目： topics_id, order_no, ymd, post_time, contents_type, subject, regular_flg, inst_ymdhi, update_ymdhi, topics_group_id, favorite_cnt, comment_cnt
	product_id	表示する商品ID、設定がない場合は全ての商品が対象となる。
	ec_ext_options_search	商品一覧を拡張項目のオプションで絞り込むか指定します。指定する:1 指定しない:0
	my_order_flg	自分が購入した商品を表示する。
	ignore_product_open_flg	非公開商品を表示する。
詳細設定	category_parent_id	親カテゴリで絞り込む。絞り込む親カテゴリを指定します。
	exclude_category_parent_id	表示しないカテゴリIDを指定します。
	ext_column	拡張項目の値で一覧を絞り込む。 例 指定した値で絞り込む場合）ext_column=ext_col_02:15 例 指定した値以外で絞り込む場合) ext_column=ext_col_02!:15
	ymd_sort_change	コンテンツの並び順を日付の昇順に変更したい場合、ymd_sort_change=onを入力します。（デフォルトは降順です。）
	shuffle	ランダム表示にするかどうか(yes/no) 通常はランダムではありません。
	target_col_for_keyword	キーワード検索の対象カラムを指定します。 設定がない場合はタイトル、本文、カテゴリ、拡張項目が対象になります。 補足) subject,contents,contents_typeまたは拡張項目no(ext_col_01,ext_col_10など)を設定します。
	use_target_col_for_keyword_from_request	リクエストでキーワード検索の対象項目の絞り込むを利用する。
	topics_keyword_cond	キーワード検索のキーワード毎の絞り込み方を変える。（デフォルト：AND)
	full_text_search_cond	全文検索のキーワード毎の絞り込み方を変えます。選択可能値: AND, OR
	tag_category_id	表示対象になるタグカテゴリIDを指定します。設定がない場合はすべてのカテゴリが対象になります。
	exclude_tag_category_id	表示対象から除外するタグカテゴリIDを指定します。
	tag_id	表示対象になるタグIDを指定します。
	exclude_tag_id	表示対象から除外するタグIDを指定します。
	tag_cond	タグの絞り込み方を変える（デフォルト：OR)
	topics_id	表示するコンテンツIDを設定します。
	order_by_id	topics_idで並び順を指定できます。指定したtopics_idのデータが上位表示されます。
	exclude_topics_id	除外するコンテンツIDを指定します。
	get_comment_cnt	コメント数を取得する。
	get_unlisted_data	一覧に載せないデータも取得する。
	comment_cond_date	コメント数を取得する際の日付条件を設定する。（例：7日前の場合「-7 day」）
	get_favorite_cnt	お気に入り数を取得する。
	my_favorite_list	自分のお気に入りでコンテンツ絞り込む。
	my_comment_list	自分のコメントしたコンテンツで絞り込む。
	my_own_list	自分の所有コンテンツで絞り込む。
	add_owner_info_cols	取得したいコンテンツ所有者属性を指定します。(複数可能) 例) email,nickname
	required_param	必須にしたいクエリパラメータを指定します。
	add_my_favorite_flg	チェックを入れると、エンドポイントを呼び出したユーザーが対象のコンテンツをお気に入り登録しているかがレスポンスに追加されます。 お気に入り登録している=>"my_favorite_flg": true お気に入り登録していない=>"my_favorite_flg": false
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。
	favorite_action_type	my_favorite_listを有効にした場合、お気に入りのアクションタイプを指定してさらに詳しく絞り込みます。
	exclude_favorited_topics	お気に入り済みのデータを対象外とする。
	get_tag_flg	チェックを入れるとレスポンスにタグ情報が追加されます。
	get_tag_order_by_tag_category	get_tag_flgが有効な場合にチェックを入れると、カテゴリ毎にタグを並べます。
	ignore_open_flg	チェックを入れると非公開コンテンツをレスポンスに含めます。
	ignore_category_open_flg	チェックを入れると非公開カテゴリのコンテンツもレスポンスに含めます。
	ignore_tag_open_flg	チェックを入れると非公開タグのコンテンツもレスポンスに含めます。
	central_id	取得の中心にするIDを指定します。
	add_open_ymdhi	チェックを入れると公開開始・終了日時をレスポンスに含めます。
	ignore_restrict_flg	チェックを入れるとアクセス制限を無視します。
	use_pre_embedding_text	チェックを入れると事前に生成されたembeddingテキストを使用します。
	max_list_chars	一覧表示時の最大文字数を指定します。0の場合は制限なし。

details

項目	パラメータ	説明
基本設定	topics_group_id	対象にするコンテンツ定義IDを指定します。
	contents_type	表示するカテゴリIDを指定します。設定がない場合はすべてのカテゴリが対象になります。
	filter	データを絞り込むクエリパラメータです。詳しくは検索機能の使い方を参照してください。
	filter_lang	フィルターの言語を指定します。
	filter_request_allow_list	filterリクエストに指定可能な項目を指定します。指定が無い場合はクエリによるフィルタはできません。全項目を許可したい場合は:ALLを設定してください。
	cnt	1ページの表示件数を指定します。
	order_query	並び順を指定します。 例）topics_id:asc、topics_id:desc 指定可能な項目： topics_id, order_no, ymd, post_time, contents_type, subject, regular_flg, inst_ymdhi, update_ymdhi, topics_group_id, favorite_cnt, comment_cnt
	ec_ext_options_search	商品一覧を拡張項目のオプションで絞り込むか指定します。指定する:1 指定しない:0
	my_order_flg	自分が購入した商品を表示する。
	ignore_product_open_flg	非公開商品を表示する。
詳細設定	category_parent_id	親カテゴリで絞り込む。絞り込む親カテゴリを指定します。
	exclude_category_parent_id	表示しないカテゴリIDを指定します。
	ext_column	拡張項目の値で一覧を絞り込む。 例 指定した値で絞り込む場合）ext_column=ext_col_02:15 例 指定した値以外で絞り込む場合) ext_column=ext_col_02!:15
	ymd_sort_change	コンテンツの並び順を日付の昇順に変更したい場合、ymd_sort_change=onを入力します。（デフォルトは降順です。）
	shuffle	ランダム表示にするかどうか(yes/no) 通常はランダムではありません。
	target_col_for_keyword	キーワード検索の対象カラムを指定します。 設定がない場合はタイトル、本文、カテゴリ、拡張項目が対象になります。 補足) subject,contents,contents_typeまたは拡張項目no(ext_col_01,ext_col_10など)を設定します。
	use_target_col_for_keyword_from_request	リクエストでキーワード検索の対象項目の絞り込むを利用する。
	topics_keyword_cond	キーワード検索のキーワード毎の絞り込み方を変える。（デフォルト：AND)
	full_text_search_cond	全文検索のキーワード毎の絞り込み方を変えます。選択可能値: AND, OR
	tag_category_id	表示対象になるタグカテゴリIDを指定します。設定がない場合はすべてのカテゴリが対象になります。
	exclude_tag_category_id	表示対象から除外するタグカテゴリIDを指定します。
	tag_id	表示対象になるタグIDを指定します。
	exclude_tag_id	表示対象から除外するタグIDを指定します。
	tag_cond	タグの絞り込み方を変える（デフォルト：OR)
	topics_id	表示するコンテンツIDを設定します。
	order_by_id	topics_idで並び順を指定できます。指定したtopics_idのデータが上位表示されます。
	exclude_topics_id	除外するコンテンツIDを指定します。
	get_comment_cnt	コメント数を取得する。
	get_unlisted_data	一覧に載せないデータも取得する。
	comment_cond_date	コメント数を取得する際の日付条件を設定する。（例：7日前の場合「-7 day」）
	get_favorite_cnt	お気に入り数を取得する。
	my_favorite_list	自分のお気に入りでコンテンツ絞り込む。
	my_comment_list	自分のコメントしたコンテンツで絞り込む。
	my_own_list	自分の所有コンテンツで絞り込む。
	add_owner_info_cols	取得したいコンテンツ所有者属性を指定します。(複数可能) 例) email,nickname
	required_param	必須にしたいクエリパラメータを指定します。
	add_my_favorite_flg	チェックを入れると、エンドポイントを呼び出したユーザーが対象のコンテンツをお気に入り登録しているかがレスポンスに追加されます。 お気に入り登録している=>"my_favorite_flg": true お気に入り登録していない=>"my_favorite_flg": false
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。
	favorite_action_type	my_favorite_listを有効にした場合、お気に入りのアクションタイプを指定してさらに詳しく絞り込みます。
	exclude_favorited_topics	お気に入り済みのデータを対象外とする。
	get_tag_flg	チェックを入れるとレスポンスにタグ情報が追加されます。
	get_tag_order_by_tag_category	get_tag_flgが有効な場合にチェックを入れると、カテゴリ毎にタグを並べます。
	ignore_open_flg	チェックを入れると非公開コンテンツをレスポンスに含めます。
	ignore_category_open_flg	チェックを入れると非公開カテゴリのコンテンツもレスポンスに含めます。
	ignore_tag_open_flg	チェックを入れると非公開タグのコンテンツもレスポンスに含めます。
	central_id	取得の中心にするIDを指定します。
	add_open_ymdhi	チェックを入れると公開開始・終了日時をレスポンスに含めます。
	ignore_restrict_flg	チェックを入れるとアクセス制限を無視します。
	use_pre_embedding_text	チェックを入れると事前に生成されたembeddingテキストを使用します。
	max_list_chars	一覧表示時の最大文字数を指定します。0の場合は制限なし。

ECPayment

list

項目	パラメータ	説明
基本設定	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

details

設定できるパラメータなし。

ファイル

Files

upload

項目	パラメータ	説明
基本設定	storage	アップロードストレージを選択します。選択可能値: KurocoFiles, GCS, S3
	access_control	アップロードしたファイルのアクセス制御を指定します。選択可能値: public, private
	size	アップロード許可する最大ファイルサイズを指定します。
	types	アップロード許可する拡張子を指定します。

temp_upload_url

設定できるパラメータなし。

タグ

Tag

list

項目	パラメータ	説明
基本設定	filter	データを絞り込むクエリパラメータです。詳しくは検索機能の使い方を参照してください。
	filter_request_allow_list	filterリクエストに指定可能な項目を指定します。指定が無い場合はクエリによるフィルタはできません。全項目を許可したい場合は:ALLを設定してください。
	order_query	並び順を指定します。例）foo=ASC,bar=DESC
	tag_id	表示対象になるタグIDを指定します。
	tag_category_id	表示対象になるタグカテゴリIDを指定します。設定がない場合はすべてのカテゴリが対象になります。
	cnt	1ページの表示件数を指定します。
	order	並び順を設定します。例）tag_id:asc、tag_id:desc 指定可能な項目： tag_id, open_contents_cnt, tag_category_id, weight, tag_nm
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。
詳細設定	groupBy	グルーピングの単位を指定します。選択可能値: module_id, category
	type	グルーピングの結果形式を指定します。選択可能値: array, object
	shuffle	ランダム表示にするかどうか(yes/no) 通常はランダムではありません。
	exclude_tag_category_id	表示対象から除外するタグカテゴリIDを指定します。
	exclude_tag_id	表示対象から除外するタグIDを指定します。
	ignore_open_flg	チェックを入れると非公開タグもレスポンスに含めます。
	target_topics_group_id	フィルタリング対象のコンテンツ定義IDを指定します。

insert

設定できるパラメータなし。

update

設定できるパラメータなし。

delete

設定できるパラメータなし。

TagCategory

list

項目	パラメータ	説明
基本設定	tag_category_id	表示対象になるタグカテゴリIDを指定します。設定がない場合はすべてのカテゴリが対象になります。
	parent_tag_category_id	表示対象になる親タグカテゴリIDを指定します。設定がない場合はすべてのカテゴリが対象になります。
	without_tag_info	チェックを入れるとタグ情報を取得しません。
詳細設定	no_classified_flg	タグカテゴリごとのタグ一覧を取得する場合に、どのタグカテゴリにも属さないタグを無視します。デフォルトではタグカテゴリの存在しないタグは「未設定」というカテゴリの下に入れて返されます。

テーブル

Master

list

項目	パラメータ	説明
基本設定	csvtable_id	対象にするcsvテーブルIDを指定します。
	key_idx	レスポンス時、key:valueのkeyになる要素のインデックスを指定します。
	value_idx	レスポンス時、key:valueのvalueになる要素のインデックスを指定します。
	multiple	key_idxの要素で多次元にするかを指定します。
	filter	データを絞り込むクエリパラメータです。詳しくは検索機能の使い方を参照してください。
	filter_request_allow_list	filterリクエストに指定可能な項目を指定します。指定が無い場合はクエリによるフィルタはできません。全項目を許可したい場合は:ALLを設定してください。
	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。
詳細設定	outputAs	アウトプットフォーマットを指定します。選択可能値: array, object
	groupBy	グルーピングの単位を指定します。
	type	グルーピングの結果形式を指定します。選択可能値: array, object（デフォルト: array）

insert

設定できるパラメータなし。

update

項目	パラメータ	説明
基本設定	csvtable_id	対象にするcsvテーブルIDを指定します。

delete

設定できるパラメータなし。

非同期タスク

Batch

webhook

項目	パラメータ	説明
基本設定	batch_id	対象にするバッチIDを指定します。
	identifier	バッチの識別子を指定します。

list

項目	パラメータ	説明
詳細設定	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

check_batch

設定できるパラメータなし。

API

Api

bulk

設定できるパラメータなし。

list

項目	パラメータ	説明
基本設定	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

openapi_data

設定できるパラメータなし。

request_api

項目	パラメータ	説明
基本設定	function_id	対象にするfunction_idを指定します。
	name	対象にする識別子を指定します。
	show_contents	内容を表示する。
	use_path_param	パスパラメータを使用する。

request_api_post

項目	パラメータ	説明
基本設定	function_id	対象にするfunction_idを指定します。
	name	対象にする識別子を指定します。
	show_contents	内容を表示する。
	use_path_param	パスパラメータを使用する。
詳細設定	use_recaptcha	reCAPTCHAを使用する。

proxy

項目	パラメータ	説明
基本設定	proxy_end_point	プロキシ先のエンドポイントを指定します。
	add_headers	追加するリクエストヘッダーを指定します。
	add_request_params	追加するリクエストパラメータを指定します。
	proxy_read_timeout	タイムアウトの制限時間を指定します。(秒)
	allow_request_params	許可するリクエストパラメータを指定します。
	allow_proxy_params	許可するプロキシパラメータを指定します。

proxy_post

項目	パラメータ	説明
基本設定	proxy_end_point	プロキシ先のエンドポイントを指定します。
	add_headers	追加するリクエストヘッダーを指定します。
	add_request_params	追加するリクエストパラメータを指定します。
	proxy_read_timeout	タイムアウトの制限時間を指定します。(秒)
	allow_request_params	許可するリクエストパラメータを指定します。
	allow_proxy_params	許可するプロキシパラメータを指定します。

aggregate

項目	パラメータ	説明
基本設定	endpoints	エンドポイントを指定します。
	order_by_columns	カラムによる並び順を指定します。
	from_date	集計開始日を指定します。
	to_date	集計終了日を指定します。
	cnt	1ページの表示件数を指定します。

add_site

項目	パラメータ	説明
基本設定	copy_from_site_key	コピー元のサイトキーを指定します。
	callback_batch_nm	コールバックバッチ名を指定します。
	init_batch_nm	初期化バッチ名を指定します。
	sign_up_as_superuser	スーパーユーザーによるサインアップをする。(する:1、しない:0)
	release_level	リリースレベルを選択します。(α版:0、β版:1、RC版:20、RC版:90、正式版:100)
詳細設定	use_recaptcha	reCAPTCHAを使用する。

site_list

項目	パラメータ	説明
基本設定	cnt	1ページの表示件数を指定します。

sso_credentials

項目	パラメータ	説明
基本設定	site_keys	対象にするサイトキーを指定します。
	emails	クレデンシャルを発行するメンバーのEメールを指定します。
	member_ids	クレデンシャルを発行するメンバーのメンバーIDを指定します。
	member_register_flg	クレデンシャル発行時にメンバー登録をする。
	use_login_id_flg	クレデンシャル発行時にログインIDでユーザーの有無をチェックする。
	sso_group_ids	クレデンシャル発行時に登録グループIDを指定します。
	expire	有効期限を指定します。(秒)

承認ワークフロー

Approvalflow

list

項目	パラメータ	説明
基本設定	module_type	対象にするモジュールタイプを指定します。(対応しているモジュールはtopicsだけになります。)
	module_id	対象にするモジュールIDを指定します。

details

設定できるパラメータなし。

insert

設定できるパラメータなし。

update

設定できるパラメータなし。

update_flow_settings

設定できるパラメータなし。

delete

設定できるパラメータなし。

review

項目	パラメータ	説明
基本設定	module_type	対象にするモジュールタイプを指定します。(対応しているモジュールはtopicsだけになります。)

list_pending

項目	パラメータ	説明
基本設定	module_type	対象にするモジュールタイプを指定します。(対応しているモジュールはtopicsだけになります。)

pending_detail

項目	パラメータ	説明
基本設定	module_type	対象にするモジュールタイプを指定します。(対応しているモジュールはtopicsだけになります。)

Payments

Stripe

checkout

項目	パラメータ	説明
基本設定	products_list	StripeのPrice ID。同じPrice IDが複数ある場合は、それに応じて課金されます。
	return_url	決済成功時のURLを設定します。
	return_err_url	決済失敗時のURLを設定します。
	trial_end	( 定期購入 ) 試用終了時期を設定します。
	trial_period_days	( 定期購入 ) 試用期間の日数を指定します。

cancel_order

設定できるパラメータなし。

Site

Site

update_site

項目	パラメータ	説明
基本設定	use_columns	更新対象のカラムを指定します。

list

項目	パラメータ	説明
基本設定	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

create_backup

項目	パラメータ	説明
基本設定	site_id	対象にするサイトIDを指定します。

get_backup_list

項目	パラメータ	説明
基本設定	site_id	対象にするサイトIDを指定します。

generate_backup_download_url

項目	パラメータ	説明
基本設定	site_id	対象にするサイトIDを指定します。

delete_backup

項目	パラメータ	説明
基本設定	site_id	対象にするサイトIDを指定します。

get_env_edit_data

項目	パラメータ	説明
基本設定	site_id	対象にするサイトIDを指定します。

add_site

項目	パラメータ	説明
基本設定	copy_from_site_key	コピー元のサイトキーを指定します。
	callback_batch_nm	コールバックバッチ名を指定します。
	init_batch_nm	初期化バッチ名を指定します。
	sign_up_as_superuser	スーパーユーザーによるサインアップをする。(する:1、しない:0)
	release_level	リリースレベルを選択します。(RC版:20、RC版:90、正式版:100)
詳細設定	use_recaptcha	reCAPTCHAを使用する。

update_env_info

項目	パラメータ	説明
基本設定	site_id	対象にするサイトIDを指定します。
	use_columns	更新対象のカラムを指定します。

close_site

設定できるパラメータなし。

sync_sites

設定できるパラメータなし。

backup_site

設定できるパラメータなし。

sync_topics

項目	パラメータ	説明
基本設定	topics_sync_source_site_id	同期元のサイトIDを指定します。
	topics_sync_target_site_id	同期先のサイトIDを指定します。
	topics_sync_group	同期対象のコンテンツ定義IDを指定します。

get_mng_data

設定できるパラメータなし。

update_mng

項目	パラメータ	説明
基本設定	use_columns	更新対象のカラムを指定します。

AI

OpenAI

chat

項目	パラメータ	説明
基本設定	model	言語モデルを選択します。
	prompt	モデルに与える入力テキストで、モデルが生成するテキストの出発点となります。モデルは、この入力に基づいて文脈に適した応答や続きを生成します。プロンプトは、質問の形式、指示、またはシナリオの形式で与えることができます。モデルは、プロンプトに関連する情報に基づいて、意味のあるテキストを生成しようとします。
	max_tokens_out	出力の最大トークン数を指定します。
	input_dict_sys_nm	入力辞書のシステム名を指定します。
	output_dict_sys_nm	出力辞書のシステム名を指定します。
	safe_check	入力テキストの安全性チェックを行う。
	max_input_length	入力テキストの最大文字数を指定します。

rag_search

項目	パラメータ	説明
基本設定	model	言語モデルを選択します。
	topics_group_id	対象にするコンテンツ定義IDを指定します。
	cnt	1ページの表示件数を指定します。
	prompt	モデルに与える入力テキストで、モデルが生成するテキストの出発点となります。モデルは、この入力に基づいて文脈に適した応答や続きを生成します。プロンプトは、質問の形式、指示、またはシナリオの形式で与えることができます。モデルは、プロンプトに関連する情報に基づいて、意味のあるテキストを生成しようとします。
	max_distance	ベクトル検索の最大距離を指定します。
	use_tags	タグ情報を検索条件に使用する。
	ext_info	レスポンスに含める拡張項目を指定します。
	skip_proper_noun_detection	固有名詞の検出をスキップする。
	date_column	日付絞り込みに使用するカラムを指定します。
	input_dict_sys_nm	入力辞書のシステム名を指定します。
	max_list_chars	レスポンスに含まれるコンテンツの最大文字数を指定します。
	data_title	データのタイトルを指定します。
	max_input_length	入力テキストの最大文字数を指定します。
	safe_check	入力テキストの安全性チェックを行う。
	required_categories	カテゴリによる絞り込みを必須にする。
	required_tags	タグによる絞り込みを必須にする。
	filter	検索機能の使い方を参照してください。
	filter_request_allow_list	フロントエンドからのリクエストで許可するfilterのキーを指定します。

chat_contents_search

項目	パラメータ	説明
基本設定	model	言語モデルを選択します。
	topics_group_id	対象にするコンテンツ定義IDを指定します。
	cnt	1ページの表示件数を指定します。
	prompt	モデルに与える入力テキストで、モデルが生成するテキストの出発点となります。モデルは、この入力に基づいて文脈に適した応答や続きを生成します。プロンプトは、質問の形式、指示、またはシナリオの形式で与えることができます。モデルは、プロンプトに関連する情報に基づいて、意味のあるテキストを生成しようとします。
	max_distance	ベクトル検索の最大距離を指定します。
	use_tags	タグ情報を検索条件に使用する。
	ext_info	レスポンスに含める拡張項目を指定します。
	max_tokens_out	出力の最大トークン数を指定します。
	skip_proper_noun_detection	固有名詞の検出をスキップする。
	date_column	日付絞り込みに使用するカラムを指定します。
	max_referenced_contents_length	参照コンテンツの最大文字数を指定します。
	input_dict_sys_nm	入力辞書のシステム名を指定します。
	output_dict_sys_nm	出力辞書のシステム名を指定します。
	data_title	データのタイトルを指定します。
	max_input_length	入力テキストの最大文字数を指定します。
	safe_check	入力テキストの安全性チェックを行う。
	required_categories	カテゴリによる絞り込みを必須にする。
	required_tags	タグによる絞り込みを必須にする。
	filter	検索機能の使い方を参照してください。
	filter_request_allow_list	フロントエンドからのリクエストで許可するfilterのキーを指定します。

routing_rules

項目	パラメータ	説明
基本設定	ai_router_id	対象にするAIルーターIDを指定します。

Spider

SpiderHistory

list

項目	パラメータ	説明
基本設定	spider_settings_id	対象にするスパイダー設定IDを指定します。

detail

項目	パラメータ	説明
基本設定	spider_settings_id	対象にするスパイダー設定IDを指定します。

logs

項目	パラメータ	説明
基本設定	spider_settings_id	対象にするスパイダー設定IDを指定します。

Spider

insert

設定できるパラメータなし。

update

設定できるパラメータなし。

webhook

項目	パラメータ	説明
基本設定	spider_settings_id	対象にするスパイダー設定IDを指定します。
	spider_history_id	対象にするスパイダー履歴IDを指定します。
	target_urls	クロール対象のURLを指定します。

Integrations

EdgeIntegration

process

項目	パラメータ	説明
基本設定	integration	受信したデータを処理する連携実装を定義します。

list

項目	パラメータ	説明
基本設定	only_count	パフォーマンス向上のため検索結果データを含まない結果件数のみを返します。

details

設定できるパラメータなし。