GET /api/locations
List all locations

パラメーター

パラメーター名 記述
search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

結果のソート

Validations:

  • Must be a String

page
任意

結果のページネーション

Validations:

  • Must be a String

per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String


GET /api/locations/:id
Show a location

パラメーター

パラメーター名 記述
show_hidden_parameters
任意

非表示のパラメーター値の表示

Validations:

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

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.


POST /api/locations
Create a location

パラメーター

パラメーター名 記述
location
必須

Validations:

  • Must be a Hash

location[name]
必須

Validations:

  • Must be a String

location[description]
任意 , nil可

Validations:

  • Must be a String

location[user_ids]
任意 , nil可

ユーザー ID

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
任意 , nil可

スマートプロキシー ID

Validations:

  • Must be an array of any type

location[compute_resource_ids]
任意 , nil可

コンピュートリソース ID

Validations:

  • Must be an array of any type

location[medium_ids]
任意 , nil可

メディア ID

Validations:

  • Must be an array of any type

location[config_template_ids]
任意 , nil可

プロビジョニングテンプレート ID

Validations:

  • Must be an array of any type

location[ptable_ids]
任意 , nil可

パーティションテンプレート ID

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
任意 , nil可

プロビジョニングテンプレート ID

Validations:

  • Must be an array of any type

location[domain_ids]
任意 , nil可

ドメイン ID

Validations:

  • Must be an array of any type

location[realm_ids]
任意 , nil可

レルム ID

Validations:

  • Must be an array of any type

location[hostgroup_ids]
任意 , nil可

ホストグループ ID

Validations:

  • Must be an array of any type

location[environment_ids]
任意 , nil可

環境 ID

Validations:

  • Must be an array of any type

location[subnet_ids]
任意 , nil可

サブネット ID

Validations:

  • Must be an array of any type

location[parent_id]
任意 , nil可

親 ID

Validations:

  • Must be a number.

location[ignore_types]
任意 , nil可

自動的に関連付けられるリソースタイプの一覧

Validations:

  • Must be an array of any type


PUT /api/locations/:id
Update a location

パラメーター

パラメーター名 記述
location
必須

Validations:

  • Must be a Hash

location[name]
任意

Validations:

  • Must be a String

location[description]
任意 , nil可

Validations:

  • Must be a String

location[user_ids]
任意 , nil可

ユーザー ID

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
任意 , nil可

スマートプロキシー ID

Validations:

  • Must be an array of any type

location[compute_resource_ids]
任意 , nil可

コンピュートリソース ID

Validations:

  • Must be an array of any type

location[medium_ids]
任意 , nil可

メディア ID

Validations:

  • Must be an array of any type

location[config_template_ids]
任意 , nil可

プロビジョニングテンプレート ID

Validations:

  • Must be an array of any type

location[ptable_ids]
任意 , nil可

パーティションテンプレート ID

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
任意 , nil可

プロビジョニングテンプレート ID

Validations:

  • Must be an array of any type

location[domain_ids]
任意 , nil可

ドメイン ID

Validations:

  • Must be an array of any type

location[realm_ids]
任意 , nil可

レルム ID

Validations:

  • Must be an array of any type

location[hostgroup_ids]
任意 , nil可

ホストグループ ID

Validations:

  • Must be an array of any type

location[environment_ids]
任意 , nil可

環境 ID

Validations:

  • Must be an array of any type

location[subnet_ids]
任意 , nil可

サブネット ID

Validations:

  • Must be an array of any type

location[parent_id]
任意 , nil可

親 ID

Validations:

  • Must be a number.

location[ignore_types]
任意 , nil可

自動的に関連付けられるリソースタイプの一覧

Validations:

  • Must be an array of any type

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.


DELETE /api/locations/:id
Delete a location

パラメーター

パラメーター名 記述
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.