GET /api/templates/:template_id/foreign_input_sets
外部入力セットを一覧表示

Params

Param Name Description
template_id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

search
Optional

結果のフィルター

Validations:

  • Must be a String

order
Optional

結果のソート

Validations:

  • Must be a String

page
Optional

結果のページネーション

Validations:

  • Must be a String

per_page
Optional

要求ごとのエントリー数

Validations:

  • Must be a String


GET /api/templates/:template_id/foreign_input_sets/:id
外部入力セット詳細を表示

Params

Param Name Description
template_id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/templates/:template_id/foreign_input_sets
外部入力セットを作成

Params

Param Name Description
template_id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

foreign_input_set
Required

Validations:

  • Must be a Hash

foreign_input_set[target_template_id]
Required

ターゲットテンプレート ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

foreign_input_set[include_all]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Include all inputs from the foreign template

Validations:

  • Must be one of: true, false, 1, 0

foreign_input_set[include]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

外部テンプレートから含める入力名のコンマ区切り一覧。

Validations:

  • Must be a String

foreign_input_set[exclude]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

外部テンプレートから含める入力名のコンマ区切り一覧。

Validations:

  • Must be a String

foreign_input_set[description]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

入力セットの説明

Validations:

  • Must be a String


DELETE /api/templates/:template_id/foreign_input_sets/:id
外部入力セットを削除

Params

Param Name Description
template_id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


PUT /api/templates/:template_id/foreign_input_sets/:id
外部入力セットを更新

Params

Param Name Description
template_id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

foreign_input_set
Required

Validations:

  • Must be a Hash

foreign_input_set[target_template_id]
Optional

ターゲットテンプレート ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

foreign_input_set[include_all]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Include all inputs from the foreign template

Validations:

  • Must be one of: true, false, 1, 0

foreign_input_set[include]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

外部テンプレートから含める入力名のコンマ区切り一覧。

Validations:

  • Must be a String

foreign_input_set[exclude]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

外部テンプレートから含める入力名のコンマ区切り一覧。

Validations:

  • Must be a String

foreign_input_set[description]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

入力セットの説明

Validations:

  • Must be a String