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

Validations:

  • Must be a String

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

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

Validations:

  • Must be an array of any type

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

Код капсулы

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be an array of any type

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

Medium IDs

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be an array of any type

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

Код домена

Validations:

  • Must be an array of any type

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

Код области

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be an array of any type

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

Код подсети

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be a number.

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

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be an array of any type

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

Код капсулы

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be an array of any type

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

Medium IDs

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be an array of any type

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

Код домена

Validations:

  • Must be an array of any type

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

Код области

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be an array of any type

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

Код подсети

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be a number.

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

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

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

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.