GET /api/locations
List all locations

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

search
opcjonalny

rezultat filtrowania

Validations:

  • Must be a String

order
opcjonalny

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
opcjonalny

Page number, starting at 1

Validations:

  • Must be a number.

per_page
opcjonalny

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Typ Possible values
description
id
location_id
name
title

GET /api/locations/:id
Show a location

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

show_hidden_parameters
opcjonalny

Display hidden parameter values

Validations:

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

id
wymagany

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

location
wymagany

Validations:

  • Must be a Hash

location[name]
wymagany

Validations:

  • Must be a String

location[description]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a String

location[user_ids]
opcjonalny , nil dopuszczalny

identyfikatory użytkowników

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
opcjonalny , nil dopuszczalny

ID inteligentnych proxy

Validations:

  • Must be an array of any type

location[compute_resource_ids]
opcjonalny , nil dopuszczalny

ID zasobów obliczeniowych

Validations:

  • Must be an array of any type

location[medium_ids]
opcjonalny , nil dopuszczalny

Medium IDs

Validations:

  • Must be an array of any type

location[ptable_ids]
opcjonalny , nil dopuszczalny

ID szablonów partycji

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
opcjonalny , nil dopuszczalny

ID szablonów zaopatrzenia

Validations:

  • Must be an array of any type

location[domain_ids]
opcjonalny , nil dopuszczalny

ID domeny

Validations:

  • Must be an array of any type

location[realm_ids]
opcjonalny , nil dopuszczalny

ID Domeny

Validations:

  • Must be an array of any type

location[hostgroup_ids]
opcjonalny , nil dopuszczalny

ID grupy hostów

Validations:

  • Must be an array of any type

location[environment_ids]
opcjonalny , nil dopuszczalny

ID środowiska

Validations:

  • Must be an array of any type

location[subnet_ids]
opcjonalny , nil dopuszczalny

ID podsieci

Validations:

  • Must be an array of any type

location[parent_id]
opcjonalny , nil dopuszczalny

ID rodzica

Validations:

  • Must be a number.

location[ignore_types]
opcjonalny , nil dopuszczalny

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

location[organization_ids]
opcjonalny , nil dopuszczalny

Associated organization IDs

Validations:

  • Must be an array of any type


PUT /api/locations/:id
Update a location

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

location
wymagany

Validations:

  • Must be a Hash

location[name]
opcjonalny

Validations:

  • Must be a String

location[description]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a String

location[user_ids]
opcjonalny , nil dopuszczalny

identyfikatory użytkowników

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
opcjonalny , nil dopuszczalny

ID inteligentnych proxy

Validations:

  • Must be an array of any type

location[compute_resource_ids]
opcjonalny , nil dopuszczalny

ID zasobów obliczeniowych

Validations:

  • Must be an array of any type

location[medium_ids]
opcjonalny , nil dopuszczalny

Medium IDs

Validations:

  • Must be an array of any type

location[ptable_ids]
opcjonalny , nil dopuszczalny

ID szablonów partycji

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
opcjonalny , nil dopuszczalny

ID szablonów zaopatrzenia

Validations:

  • Must be an array of any type

location[domain_ids]
opcjonalny , nil dopuszczalny

ID domeny

Validations:

  • Must be an array of any type

location[realm_ids]
opcjonalny , nil dopuszczalny

ID Domeny

Validations:

  • Must be an array of any type

location[hostgroup_ids]
opcjonalny , nil dopuszczalny

ID grupy hostów

Validations:

  • Must be an array of any type

location[environment_ids]
opcjonalny , nil dopuszczalny

ID środowiska

Validations:

  • Must be an array of any type

location[subnet_ids]
opcjonalny , nil dopuszczalny

ID podsieci

Validations:

  • Must be an array of any type

location[parent_id]
opcjonalny , nil dopuszczalny

ID rodzica

Validations:

  • Must be a number.

location[ignore_types]
opcjonalny , nil dopuszczalny

List of resources types that will be automatically associated

Validations:

  • Must be an array of any type

location[organization_ids]
opcjonalny , nil dopuszczalny

Associated organization IDs

Validations:

  • Must be an array of any type

id
wymagany

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Validations:

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