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]
необязательно , nil разрешен

Validations:

  • Must be a String

location[user_ids]
необязательно , nil разрешен

Код пользователя

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
необязательно , nil разрешен

Код капсулы

Validations:

  • Must be an array of any type

location[compute_resource_ids]
необязательно , nil разрешен

Код вычислительного ресурса

Validations:

  • Must be an array of any type

location[medium_ids]
необязательно , nil разрешен

Medium IDs

Validations:

  • Must be an array of any type

location[ptable_ids]
необязательно , nil разрешен

Код шаблона таблицы разделов

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
необязательно , nil разрешен

Код подготовительного шаблона

Validations:

  • Must be an array of any type

location[domain_ids]
необязательно , nil разрешен

Код домена

Validations:

  • Must be an array of any type

location[realm_ids]
необязательно , nil разрешен

Код области

Validations:

  • Must be an array of any type

location[hostgroup_ids]
необязательно , nil разрешен

Код группы узлов

Validations:

  • Must be an array of any type

location[environment_ids]
необязательно , nil разрешен

Код окружения

Validations:

  • Must be an array of any type

location[subnet_ids]
необязательно , nil разрешен

Код подсети

Validations:

  • Must be an array of any type

location[parent_id]
необязательно , nil разрешен

Родительский код

Validations:

  • Must be a number.

location[ignore_types]
необязательно , nil разрешен

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

location[organization_ids]
необязательно , nil разрешен

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]
необязательно , nil разрешен

Validations:

  • Must be a String

location[user_ids]
необязательно , nil разрешен

Код пользователя

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
необязательно , nil разрешен

Код капсулы

Validations:

  • Must be an array of any type

location[compute_resource_ids]
необязательно , nil разрешен

Код вычислительного ресурса

Validations:

  • Must be an array of any type

location[medium_ids]
необязательно , nil разрешен

Medium IDs

Validations:

  • Must be an array of any type

location[ptable_ids]
необязательно , nil разрешен

Код шаблона таблицы разделов

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
необязательно , nil разрешен

Код подготовительного шаблона

Validations:

  • Must be an array of any type

location[domain_ids]
необязательно , nil разрешен

Код домена

Validations:

  • Must be an array of any type

location[realm_ids]
необязательно , nil разрешен

Код области

Validations:

  • Must be an array of any type

location[hostgroup_ids]
необязательно , nil разрешен

Код группы узлов

Validations:

  • Must be an array of any type

location[environment_ids]
необязательно , nil разрешен

Код окружения

Validations:

  • Must be an array of any type

location[subnet_ids]
необязательно , nil разрешен

Код подсети

Validations:

  • Must be an array of any type

location[parent_id]
необязательно , nil разрешен

Родительский код

Validations:

  • Must be a number.

location[ignore_types]
необязательно , nil разрешен

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

location[organization_ids]
необязательно , nil разрешен

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.