GET /api/locations
List all locations

參數

參數名字 描述
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
location_id
name
title

GET /api/locations/:id
Show a location

參數

參數名字 描述
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/locations
Create a location

參數

參數名字 描述
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

location
必填

Validations:

  • Must be a Hash

location[name]
必填

Validations:

  • Must be a String

location[description]
選填 , 允許空值

Validations:

  • Must be a String

location[user_ids]
選填 , 允許空值

使用者 ID

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
選填 , 允許空值

智慧型代理伺服器的 ID

Validations:

  • Must be an array of any type

location[compute_resource_ids]
選填 , 允許空值

運算資源 ID

Validations:

  • Must be an array of any type

location[medium_ids]
選填 , 允許空值

Medium IDs

Validations:

  • Must be an array of any type

location[ptable_ids]
選填 , 允許空值

分割區範本 ID

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
選填 , 允許空值

佈建範本 ID

Validations:

  • Must be an array of any type

location[domain_ids]
選填 , 允許空值

區域 ID

Validations:

  • Must be an array of any type

location[realm_ids]
選填 , 允許空值

領域 ID

Validations:

  • Must be an array of any type

location[hostgroup_ids]
選填 , 允許空值

主機群組 ID

Validations:

  • Must be an array of any type

location[environment_ids]
選填 , 允許空值

環境 ID

Validations:

  • Must be an array of any type

location[subnet_ids]
選填 , 允許空值

子網路的 ID

Validations:

  • Must be an array of any type

location[parent_id]
選填 , 允許空值

父 ID

Validations:

  • Must be a number.

location[ignore_types]
選填 , 允許空值

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

location[organization_ids]
選填 , 允許空值

Associated organization IDs

Validations:

  • Must be an array of any type


PUT /api/locations/:id
Update a location

參數

參數名字 描述
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

location
必填

Validations:

  • Must be a Hash

location[name]
選填

Validations:

  • Must be a String

location[description]
選填 , 允許空值

Validations:

  • Must be a String

location[user_ids]
選填 , 允許空值

使用者 ID

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
選填 , 允許空值

智慧型代理伺服器的 ID

Validations:

  • Must be an array of any type

location[compute_resource_ids]
選填 , 允許空值

運算資源 ID

Validations:

  • Must be an array of any type

location[medium_ids]
選填 , 允許空值

Medium IDs

Validations:

  • Must be an array of any type

location[ptable_ids]
選填 , 允許空值

分割區範本 ID

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
選填 , 允許空值

佈建範本 ID

Validations:

  • Must be an array of any type

location[domain_ids]
選填 , 允許空值

區域 ID

Validations:

  • Must be an array of any type

location[realm_ids]
選填 , 允許空值

領域 ID

Validations:

  • Must be an array of any type

location[hostgroup_ids]
選填 , 允許空值

主機群組 ID

Validations:

  • Must be an array of any type

location[environment_ids]
選填 , 允許空值

環境 ID

Validations:

  • Must be an array of any type

location[subnet_ids]
選填 , 允許空值

子網路的 ID

Validations:

  • Must be an array of any type

location[parent_id]
選填 , 允許空值

父 ID

Validations:

  • Must be a number.

location[ignore_types]
選填 , 允許空值

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

location[organization_ids]
選填 , 允許空值

Associated organization 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/locations/:id
Delete a location

參數

參數名字 描述
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.