GET /api/organizations
List all organizations

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

search
選填

篩選結果

Validations:

  • Must be a String

order
選填

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
選填

頁數,從 1 開始

Validations:

  • Must be a number.

per_page
選填

每頁要傳回的結果數量

Validations:

  • Must be a number.

Search fields

Field name 類型 Possible values
description
id
name
organization_id
title

GET /api/organizations/:id
Show an organization

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

show_hidden_parameters
選填

Display hidden parameter values

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

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

organization
必填

Validations:

  • Must be a Hash

organization[name]
必填

Validations:

  • Must be a String

organization[description]
選填 , 允許空值

Validations:

  • Must be a String

organization[user_ids]
選填 , 允許空值

使用者 ID

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
選填 , 允許空值

智慧型代理伺服器的 ID

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
選填 , 允許空值

運算資源 ID

Validations:

  • Must be an array of any type

organization[medium_ids]
選填 , 允許空值

Medium IDs

Validations:

  • Must be an array of any type

organization[ptable_ids]
選填 , 允許空值

分割區範本 ID

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
選填 , 允許空值

佈建範本 ID

Validations:

  • Must be an array of any type

organization[domain_ids]
選填 , 允許空值

區域 ID

Validations:

  • Must be an array of any type

organization[realm_ids]
選填 , 允許空值

領域 ID

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
選填 , 允許空值

主機群組 ID

Validations:

  • Must be an array of any type

organization[environment_ids]
選填 , 允許空值

環境 ID

Validations:

  • Must be an array of any type

organization[subnet_ids]
選填 , 允許空值

子網路的 ID

Validations:

  • Must be an array of any type

organization[parent_id]
選填 , 允許空值

父 ID

Validations:

  • Must be a number.

organization[ignore_types]
選填 , 允許空值

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

organization[location_ids]
選填 , 允許空值

Associated location IDs

Validations:

  • Must be an array of any type


PUT /api/organizations/:id
Update an organization

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

organization
必填

Validations:

  • Must be a Hash

organization[name]
選填

Validations:

  • Must be a String

organization[description]
選填 , 允許空值

Validations:

  • Must be a String

organization[user_ids]
選填 , 允許空值

使用者 ID

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
選填 , 允許空值

智慧型代理伺服器的 ID

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
選填 , 允許空值

運算資源 ID

Validations:

  • Must be an array of any type

organization[medium_ids]
選填 , 允許空值

Medium IDs

Validations:

  • Must be an array of any type

organization[ptable_ids]
選填 , 允許空值

分割區範本 ID

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
選填 , 允許空值

佈建範本 ID

Validations:

  • Must be an array of any type

organization[domain_ids]
選填 , 允許空值

區域 ID

Validations:

  • Must be an array of any type

organization[realm_ids]
選填 , 允許空值

領域 ID

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
選填 , 允許空值

主機群組 ID

Validations:

  • Must be an array of any type

organization[environment_ids]
選填 , 允許空值

環境 ID

Validations:

  • Must be an array of any type

organization[subnet_ids]
選填 , 允許空值

子網路的 ID

Validations:

  • Must be an array of any type

organization[parent_id]
選填 , 允許空值

父 ID

Validations:

  • Must be a number.

organization[ignore_types]
選填 , 允許空值

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

organization[location_ids]
選填 , 允許空值

Associated location IDs

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

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

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.