GET /api/organizations
List all organizations

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

search
optional

filtra els resultats

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Nombre de resultats per pàgina a retornar

Validations:

  • Must be a number.

Search fields

Field name Tipus Possible values
description
id
name
organization_id
title

GET /api/organizations/:id
Show an organization

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

show_hidden_parameters
optional

Mostra els valors dels paràmetres ocults

Validations:

  • Must be one of: true, false, 1, 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
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

organization
required

Validations:

  • Must be a Hash

organization[name]
required

Validations:

  • Must be a String

organization[description]
optional , nil allowed

Validations:

  • Must be a String

organization[user_ids]
optional , nil allowed

ID d'usuaris

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
optional , nil allowed

Els ID dels servidors intermediaris intel·ligents

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
optional , nil allowed

Els ID dels recursos computacionals

Validations:

  • Must be an array of any type

organization[medium_ids]
optional , nil allowed

Medium IDs

Validations:

  • Must be an array of any type

organization[ptable_ids]
optional , nil allowed

Els ID de les plantilles de particions

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
optional , nil allowed

Els ID de les plantilles d'aprovisionament

Validations:

  • Must be an array of any type

organization[domain_ids]
optional , nil allowed

Els ID dels dominis

Validations:

  • Must be an array of any type

organization[realm_ids]
optional , nil allowed

Els ID dels reialmes

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
optional , nil allowed

Els ID dels grups d'amfitrions

Validations:

  • Must be an array of any type

organization[environment_ids]
optional , nil allowed

Els ID dels entorns

Validations:

  • Must be an array of any type

organization[subnet_ids]
optional , nil allowed

Els ID de les subxarxes

Validations:

  • Must be an array of any type

organization[parent_id]
optional , nil allowed

Parent ID

Validations:

  • Must be a number.

organization[ignore_types]
optional , nil allowed

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

organization[location_ids]
optional , nil allowed

Associated location IDs

Validations:

  • Must be an array of any type


PUT /api/organizations/:id
Update an organization

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

organization
required

Validations:

  • Must be a Hash

organization[name]
optional

Validations:

  • Must be a String

organization[description]
optional , nil allowed

Validations:

  • Must be a String

organization[user_ids]
optional , nil allowed

ID d'usuaris

Validations:

  • Must be an array of any type

organization[smart_proxy_ids]
optional , nil allowed

Els ID dels servidors intermediaris intel·ligents

Validations:

  • Must be an array of any type

organization[compute_resource_ids]
optional , nil allowed

Els ID dels recursos computacionals

Validations:

  • Must be an array of any type

organization[medium_ids]
optional , nil allowed

Medium IDs

Validations:

  • Must be an array of any type

organization[ptable_ids]
optional , nil allowed

Els ID de les plantilles de particions

Validations:

  • Must be an array of any type

organization[provisioning_template_ids]
optional , nil allowed

Els ID de les plantilles d'aprovisionament

Validations:

  • Must be an array of any type

organization[domain_ids]
optional , nil allowed

Els ID dels dominis

Validations:

  • Must be an array of any type

organization[realm_ids]
optional , nil allowed

Els ID dels reialmes

Validations:

  • Must be an array of any type

organization[hostgroup_ids]
optional , nil allowed

Els ID dels grups d'amfitrions

Validations:

  • Must be an array of any type

organization[environment_ids]
optional , nil allowed

Els ID dels entorns

Validations:

  • Must be an array of any type

organization[subnet_ids]
optional , nil allowed

Els ID de les subxarxes

Validations:

  • Must be an array of any type

organization[parent_id]
optional , nil allowed

Parent ID

Validations:

  • Must be a number.

organization[ignore_types]
optional , nil allowed

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

organization[location_ids]
optional , nil allowed

Associated location IDs

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
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

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.