GET /api/organizations
List all organizations

Ejemplos

GET /api/organizations
200
{
  "total": 3,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": "name = \"Empty Organization\"",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-09-11 14:41:48 UTC",
      "updated_at": "2019-09-11 14:41:48 UTC",
      "id": 114267492,
      "name": "Empty Organization",
      "title": "Empty Organization",
      "description": null
    }
  ]
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

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.


GET /api/organizations/:id
Show an organization

Ejemplos

GET /api/organizations/447626452-org226
404
{
  "error": {
    "message": "Resource organization not found by id '447626452-org226'"
  }
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

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

Ejemplos

POST /api/organizations
{
  "organization": {
    "name": ""
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

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[config_template_ids]
opcional , nil permitido

ID de plantilla de aprovisionamiento

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

Ejemplos

POST /api/organizations/447626439
{
  "organization": {
    "name": "iMjmeEtMTo",
    "description": "sNpnzwhOEk"
  }
}
201
{
  "select_all_types": [],
  "description": "sNpnzwhOEk",
  "created_at": "2019-09-11 14:41:49 UTC",
  "updated_at": "2019-09-11 14:41:49 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626439,
  "name": "iMjmeEtMTo",
  "title": "iMjmeEtMTo",
  "users": [],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "config_templates": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "environments": [],
  "hostgroups": [],
  "locations": [],
  "hosts_count": 0,
  "parameters": []
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

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[config_template_ids]
opcional , nil permitido

ID de plantilla de aprovisionamiento

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

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

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.