GET /api/organizations
List all organizations

パラメーター

パラメーター名 記述
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/organizations/:id
Show an organization

パラメーター

パラメーター名 記述
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/organizations
Create an organization

パラメーター

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

Validations:

  • Must be a Hash

organization[name]
必須

Validations:

  • Must be a String

organization[description]
任意 , nil可

Validations:

  • Must be a String

organization[user_ids]
任意 , nil可

ユーザー ID

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
任意 , nil可

スマートプロキシー ID

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
任意 , nil可

コンピュートリソース ID

Validations:

  • Must be an array of any type

organization[medium_ids]
任意 , nil可

メディア ID

Validations:

  • Must be an array of any type

organization[config_template_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

organization[ptable_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

organization[domain_ids]
任意 , nil可

ドメイン ID

Validations:

  • Must be an array of any type

organization[realm_ids]
任意 , nil可

レルム ID

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
任意 , nil可

ホストグループ ID

Validations:

  • Must be an array of any type

organization[environment_ids]
任意 , nil可

環境 ID

Validations:

  • Must be an array of any type

organization[subnet_ids]
任意 , nil可

サブネット ID

Validations:

  • Must be an array of any type

organization[parent_id]
任意 , nil可

親 ID

Validations:

  • Must be a number.

organization[ignore_types]
任意 , nil可

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

Validations:

  • Must be an array of any type


PUT /api/organizations/:id
Update an organization

パラメーター

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

Validations:

  • Must be a Hash

organization[name]
任意

Validations:

  • Must be a String

organization[description]
任意 , nil可

Validations:

  • Must be a String

organization[user_ids]
任意 , nil可

ユーザー ID

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
任意 , nil可

スマートプロキシー ID

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
任意 , nil可

コンピュートリソース ID

Validations:

  • Must be an array of any type

organization[medium_ids]
任意 , nil可

メディア ID

Validations:

  • Must be an array of any type

organization[config_template_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

organization[ptable_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

organization[domain_ids]
任意 , nil可

ドメイン ID

Validations:

  • Must be an array of any type

organization[realm_ids]
任意 , nil可

レルム ID

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
任意 , nil可

ホストグループ ID

Validations:

  • Must be an array of any type

organization[environment_ids]
任意 , nil可

環境 ID

Validations:

  • Must be an array of any type

organization[subnet_ids]
任意 , nil可

サブネット ID

Validations:

  • Must be an array of any type

organization[parent_id]
任意 , nil可

親 ID

Validations:

  • Must be a number.

organization[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/organizations/:id
Delete an organization

パラメーター

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