GET /api/organizations
List all organizations

Parâmentros

Nome parâmetro Descrição
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

Classificar campo e ordem, ex.: ‘id DESC’

Validations:

  • Must be a String

page
opcional

Número de página, iniciando em 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para retornar

Validations:

  • Must be a number.

Pesquisar campos

Nome do campo Tipo Valores possíveis
description
id
name
organization_id
title

GET /api/organizations/:id
Show an organization

Parâmentros

Nome parâmetro Descrição
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

Exibir 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âmentros

Nome parâmetro Descrição
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 , nulo permitido

Validations:

  • Must be a String

organization[user_ids]
opcional , nulo permitido

IDs dos Usuários

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
opcional , nulo permitido

IDs do proxy inteligente

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
opcional , nulo permitido

IDs do recurso de computação

Validations:

  • Must be an array of any type

organization[medium_ids]
opcional , nulo permitido

IDs de mídia

Validations:

  • Must be an array of any type

organization[ptable_ids]
opcional , nulo permitido

IDs do modelo de partição

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
opcional , nulo permitido

IDs de modelo de provisionamento

Validations:

  • Must be an array of any type

organization[domain_ids]
opcional , nulo permitido

IDs de Domínio

Validations:

  • Must be an array of any type

organization[realm_ids]
opcional , nulo permitido

IDs de Realm

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
opcional , nulo permitido

IDs do grupo de host

Validations:

  • Must be an array of any type

organization[environment_ids]
opcional , nulo permitido

IDs de Ambiente

Validations:

  • Must be an array of any type

organization[subnet_ids]
opcional , nulo permitido

Ids de Subrede

Validations:

  • Must be an array of any type

organization[parent_id]
opcional , nulo permitido

ID Pai

Validations:

  • Must be a number.

organization[ignore_types]
opcional , nulo permitido

Lista de tipos de recurso que serão associados automaticamente

Validations:

  • Must be an array of any type

organization[location_ids]
opcional , nulo permitido

Associated location IDs

Validations:

  • Must be an array of any type


PUT /api/organizations/:id
Update an organization

Parâmentros

Nome parâmetro Descrição
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 , nulo permitido

Validations:

  • Must be a String

organization[user_ids]
opcional , nulo permitido

IDs dos Usuários

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
opcional , nulo permitido

IDs do proxy inteligente

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
opcional , nulo permitido

IDs do recurso de computação

Validations:

  • Must be an array of any type

organization[medium_ids]
opcional , nulo permitido

IDs de mídia

Validations:

  • Must be an array of any type

organization[ptable_ids]
opcional , nulo permitido

IDs do modelo de partição

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
opcional , nulo permitido

IDs de modelo de provisionamento

Validations:

  • Must be an array of any type

organization[domain_ids]
opcional , nulo permitido

IDs de Domínio

Validations:

  • Must be an array of any type

organization[realm_ids]
opcional , nulo permitido

IDs de Realm

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
opcional , nulo permitido

IDs do grupo de host

Validations:

  • Must be an array of any type

organization[environment_ids]
opcional , nulo permitido

IDs de Ambiente

Validations:

  • Must be an array of any type

organization[subnet_ids]
opcional , nulo permitido

Ids de Subrede

Validations:

  • Must be an array of any type

organization[parent_id]
opcional , nulo permitido

ID Pai

Validations:

  • Must be a number.

organization[ignore_types]
opcional , nulo permitido

Lista de tipos de recurso que serão associados automaticamente

Validations:

  • Must be an array of any type

organization[location_ids]
opcional , nulo 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âmentros

Nome parâmetro Descrição
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.