GET /api/organizations
List all organizations

Params

Param Name Description
search
Optional

filtra i risultati

Validations:

  • Must be String

order
Optional

ordina risultati

Validations:

  • Must be String

page
Optional

paginazione risultati

Validations:

  • Must be String

per_page
Optional

numero di voci per richiesta

Validations:

  • Must be String


GET /api/organizations/:id
Show an organization

Params

Param Name Description
show_hidden_parameters
Optional

Display hidden parameter values

Validations:

  • Must be 'true' or 'false' or '1' or '0'

id
Required

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

Params

Param Name Description
organization
Required

Validations:

  • Must be a Hash

organization[name]
Required

Validations:

  • Must be String

organization[description]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

organization[user_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID Utenti

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID Smart proxy

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID risorsa di calcolo

Validations:

  • Must be an array of any type

organization[medium_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Medium IDs

Validations:

  • Must be an array of any type

organization[config_template_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID template di provisioning

Validations:

  • Must be an array of any type

organization[ptable_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Partition template IDs

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID template di provisioning

Validations:

  • Must be an array of any type

organization[domain_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID del dominio

Validations:

  • Must be an array of any type

organization[realm_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID realm

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID gruppo di host

Validations:

  • Must be an array of any type

organization[environment_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID ambiente

Validations:

  • Must be an array of any type

organization[subnet_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID sottoreti

Validations:

  • Must be an array of any type

organization[parent_id]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Parent ID

Validations:

  • Must be a number.

organization[ignore_types]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type


PUT /api/organizations/:id
Update an organization

Params

Param Name Description
organization
Required

Validations:

  • Must be a Hash

organization[name]
Optional

Validations:

  • Must be String

organization[description]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

organization[user_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID Utenti

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID Smart proxy

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID risorsa di calcolo

Validations:

  • Must be an array of any type

organization[medium_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Medium IDs

Validations:

  • Must be an array of any type

organization[config_template_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID template di provisioning

Validations:

  • Must be an array of any type

organization[ptable_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Partition template IDs

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID template di provisioning

Validations:

  • Must be an array of any type

organization[domain_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID del dominio

Validations:

  • Must be an array of any type

organization[realm_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID realm

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID gruppo di host

Validations:

  • Must be an array of any type

organization[environment_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID ambiente

Validations:

  • Must be an array of any type

organization[subnet_ids]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

ID sottoreti

Validations:

  • Must be an array of any type

organization[parent_id]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

Parent ID

Validations:

  • Must be a number.

organization[ignore_types]
Optional , <span class="translation_missing" title="translation missing: it.apipie.nil_allowed">Nil Allowed</span>

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

id
Required

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

Params

Param Name Description
id
Required

Validations:

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