GET /api/locations
List all locations

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
location_id
name
title

GET /api/locations/:id
Show a location

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/locations
Create a location

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

location
required

Validations:

  • Must be a Hash

location[name]
required

Validations:

  • Must be a String

location[description]
optional , nil allowed

Validations:

  • Must be a String

location[user_ids]
optional , nil allowed

ID d'usuaris

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
optional , nil allowed

Els ID dels servidors intermediaris intel·ligents

Validations:

  • Must be an array of any type

location[compute_resource_ids]
optional , nil allowed

Els ID dels recursos computacionals

Validations:

  • Must be an array of any type

location[medium_ids]
optional , nil allowed

Medium IDs

Validations:

  • Must be an array of any type

location[ptable_ids]
optional , nil allowed

Els ID de les plantilles de particions

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
optional , nil allowed

Els ID de les plantilles d'aprovisionament

Validations:

  • Must be an array of any type

location[domain_ids]
optional , nil allowed

Els ID dels dominis

Validations:

  • Must be an array of any type

location[realm_ids]
optional , nil allowed

Els ID dels reialmes

Validations:

  • Must be an array of any type

location[hostgroup_ids]
optional , nil allowed

Els ID dels grups d'amfitrions

Validations:

  • Must be an array of any type

location[environment_ids]
optional , nil allowed

Els ID dels entorns

Validations:

  • Must be an array of any type

location[subnet_ids]
optional , nil allowed

Els ID de les subxarxes

Validations:

  • Must be an array of any type

location[parent_id]
optional , nil allowed

Parent ID

Validations:

  • Must be a number.

location[ignore_types]
optional , nil allowed

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

location[organization_ids]
optional , nil allowed

Associated organization IDs

Validations:

  • Must be an array of any type


PUT /api/locations/:id
Update a location

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

location
required

Validations:

  • Must be a Hash

location[name]
optional

Validations:

  • Must be a String

location[description]
optional , nil allowed

Validations:

  • Must be a String

location[user_ids]
optional , nil allowed

ID d'usuaris

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
optional , nil allowed

Els ID dels servidors intermediaris intel·ligents

Validations:

  • Must be an array of any type

location[compute_resource_ids]
optional , nil allowed

Els ID dels recursos computacionals

Validations:

  • Must be an array of any type

location[medium_ids]
optional , nil allowed

Medium IDs

Validations:

  • Must be an array of any type

location[ptable_ids]
optional , nil allowed

Els ID de les plantilles de particions

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
optional , nil allowed

Els ID de les plantilles d'aprovisionament

Validations:

  • Must be an array of any type

location[domain_ids]
optional , nil allowed

Els ID dels dominis

Validations:

  • Must be an array of any type

location[realm_ids]
optional , nil allowed

Els ID dels reialmes

Validations:

  • Must be an array of any type

location[hostgroup_ids]
optional , nil allowed

Els ID dels grups d'amfitrions

Validations:

  • Must be an array of any type

location[environment_ids]
optional , nil allowed

Els ID dels entorns

Validations:

  • Must be an array of any type

location[subnet_ids]
optional , nil allowed

Els ID de les subxarxes

Validations:

  • Must be an array of any type

location[parent_id]
optional , nil allowed

Parent ID

Validations:

  • Must be a number.

location[ignore_types]
optional , nil allowed

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

location[organization_ids]
optional , nil allowed

Associated organization 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/locations/:id
Delete a location

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.