GET /api/organizations
List all organizations

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Orden y campo de clasificación, p. ej., 'id DESC'

Validations:

  • Must be a String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.

Campos de búsqueda

Nombre del campo Tipo Valores posibles
description
id
name
organization_id
title

GET /api/organizations/:id
Show an organization

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

show_hidden_parameters
opcional

Mostrar valores de parámetros ocultos

Validations:

  • Must be one of: true, false, 1, 0.

id
requerido

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

organization
requerido

Validations:

  • Must be a Hash

organization[name]
requerido

Validations:

  • Must be a String

organization[description]
opcional , nil permitido

Validations:

  • Must be a String

organization[user_ids]
opcional , nil permitido

ID de usuario

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
opcional , nil permitido

ID de proxy inteligente

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
opcional , nil permitido

ID de recursos de cómputo

Validations:

  • Must be an array of any type

organization[medium_ids]
opcional , nil permitido

ID de medio

Validations:

  • Must be an array of any type

organization[ptable_ids]
opcional , nil permitido

ID de la plantilla de partición

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
opcional , nil permitido

ID de plantilla de aprovisionamiento

Validations:

  • Must be an array of any type

organization[domain_ids]
opcional , nil permitido

ID de dominio

Validations:

  • Must be an array of any type

organization[realm_ids]
opcional , nil permitido

ID de reino

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
opcional , nil permitido

ID de grupos de host

Validations:

  • Must be an array of any type

organization[environment_ids]
opcional , nil permitido

ID de entorno

Validations:

  • Must be an array of any type

organization[subnet_ids]
opcional , nil permitido

ID de subred

Validations:

  • Must be an array of any type

organization[parent_id]
opcional , nil permitido

ID de padre

Validations:

  • Must be a number.

organization[ignore_types]
opcional , nil permitido

Lista de tipos de recurso que se asociarán automáticamente

Validations:

  • Must be an array of any type

organization[location_ids]
opcional , nil permitido

Associated location IDs

Validations:

  • Must be an array of any type


PUT /api/organizations/:id
Update an organization

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

organization
requerido

Validations:

  • Must be a Hash

organization[name]
opcional

Validations:

  • Must be a String

organization[description]
opcional , nil permitido

Validations:

  • Must be a String

organization[user_ids]
opcional , nil permitido

ID de usuario

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
opcional , nil permitido

ID de proxy inteligente

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
opcional , nil permitido

ID de recursos de cómputo

Validations:

  • Must be an array of any type

organization[medium_ids]
opcional , nil permitido

ID de medio

Validations:

  • Must be an array of any type

organization[ptable_ids]
opcional , nil permitido

ID de la plantilla de partición

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
opcional , nil permitido

ID de plantilla de aprovisionamiento

Validations:

  • Must be an array of any type

organization[domain_ids]
opcional , nil permitido

ID de dominio

Validations:

  • Must be an array of any type

organization[realm_ids]
opcional , nil permitido

ID de reino

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
opcional , nil permitido

ID de grupos de host

Validations:

  • Must be an array of any type

organization[environment_ids]
opcional , nil permitido

ID de entorno

Validations:

  • Must be an array of any type

organization[subnet_ids]
opcional , nil permitido

ID de subred

Validations:

  • Must be an array of any type

organization[parent_id]
opcional , nil permitido

ID de padre

Validations:

  • Must be a number.

organization[ignore_types]
opcional , nil permitido

Lista de tipos de recurso que se asociarán automáticamente

Validations:

  • Must be an array of any type

organization[location_ids]
opcional , nil permitido

Associated location IDs

Validations:

  • Must be an array of any type

id
requerido

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.