GET /api/locations
List all locations

Parameter

Parametername Beschreibung
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

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Feld und Reihenfolge sortieren, z.B. 'id DESC'

Validations:

  • Must be a String

page
optional

Seitennummer, beginnend bei 1

Validations:

  • Must be a number.

per_page
optional

Anzahl der angezeigten Ergebnisse pro Seite

Validations:

  • Must be a number.

Suchfelder

Feld Name Typ Mögliche Werte
description
id
location_id
name
title

GET /api/locations/:id
Show a location

Parameter

Parametername Beschreibung
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

Versteckte Parameter Werte anzeigen

Validations:

  • Must be one of: true, false, 1, 0.

id
verpflichtend

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

Parameter

Parametername Beschreibung
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
verpflichtend

Validations:

  • Must be a Hash

location[name]
verpflichtend

Validations:

  • Must be a String

location[description]
optional , nil erlaubt

Validations:

  • Must be a String

location[user_ids]
optional , nil erlaubt

Benutzerkennungen

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
optional , nil erlaubt

Smart-Proxy-Kennungen

Validations:

  • Must be an array of any type

location[compute_resource_ids]
optional , nil erlaubt

Rechenressourcen-Kennungen

Validations:

  • Must be an array of any type

location[medium_ids]
optional , nil erlaubt

Medium Kennungen

Validations:

  • Must be an array of any type

location[ptable_ids]
optional , nil erlaubt

Partitionsvorlagenkennungen

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
optional , nil erlaubt

Bereitstellungsvorlagen-Kennungen

Validations:

  • Must be an array of any type

location[domain_ids]
optional , nil erlaubt

Domänen-Kennungen

Validations:

  • Must be an array of any type

location[realm_ids]
optional , nil erlaubt

Realm-Kennungen

Validations:

  • Must be an array of any type

location[hostgroup_ids]
optional , nil erlaubt

Hostgruppen-Kennungen

Validations:

  • Must be an array of any type

location[environment_ids]
optional , nil erlaubt

Umgebungskennungen

Validations:

  • Must be an array of any type

location[subnet_ids]
optional , nil erlaubt

Subnetz-Kennungen

Validations:

  • Must be an array of any type

location[parent_id]
optional , nil erlaubt

Übergeordnete ID

Validations:

  • Must be a number.

location[ignore_types]
optional , nil erlaubt

Auflisten aller Ressourcetypen die automatisch zugewiesen werden

Validations:

  • Must be an array of any type

location[organization_ids]
optional , nil erlaubt

Associated organization IDs

Validations:

  • Must be an array of any type


PUT /api/locations/:id
Update a location

Parameter

Parametername Beschreibung
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
verpflichtend

Validations:

  • Must be a Hash

location[name]
optional

Validations:

  • Must be a String

location[description]
optional , nil erlaubt

Validations:

  • Must be a String

location[user_ids]
optional , nil erlaubt

Benutzerkennungen

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
optional , nil erlaubt

Smart-Proxy-Kennungen

Validations:

  • Must be an array of any type

location[compute_resource_ids]
optional , nil erlaubt

Rechenressourcen-Kennungen

Validations:

  • Must be an array of any type

location[medium_ids]
optional , nil erlaubt

Medium Kennungen

Validations:

  • Must be an array of any type

location[ptable_ids]
optional , nil erlaubt

Partitionsvorlagenkennungen

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
optional , nil erlaubt

Bereitstellungsvorlagen-Kennungen

Validations:

  • Must be an array of any type

location[domain_ids]
optional , nil erlaubt

Domänen-Kennungen

Validations:

  • Must be an array of any type

location[realm_ids]
optional , nil erlaubt

Realm-Kennungen

Validations:

  • Must be an array of any type

location[hostgroup_ids]
optional , nil erlaubt

Hostgruppen-Kennungen

Validations:

  • Must be an array of any type

location[environment_ids]
optional , nil erlaubt

Umgebungskennungen

Validations:

  • Must be an array of any type

location[subnet_ids]
optional , nil erlaubt

Subnetz-Kennungen

Validations:

  • Must be an array of any type

location[parent_id]
optional , nil erlaubt

Übergeordnete ID

Validations:

  • Must be a number.

location[ignore_types]
optional , nil erlaubt

Auflisten aller Ressourcetypen die automatisch zugewiesen werden

Validations:

  • Must be an array of any type

location[organization_ids]
optional , nil erlaubt

Associated organization IDs

Validations:

  • Must be an array of any type

id
verpflichtend

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

Parameter

Parametername Beschreibung
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
verpflichtend

Validations:

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