GET /api/locations
List all locations

Params

Param Name Description
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer

organization_id
Optional

Scope met organisaties

Validations:

  • Must be a Integer

search
Optional

filter resultaten

Validations:

  • Must be a String

order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
Optional

Pagineer de resultaten

Validations:

  • Must be a String

per_page
Optional

Aantal items per aanvraag

Validations:

  • Must be a String


GET /api/locations/:id
Show a location

Params

Param Name Description
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer

organization_id
Optional

Scope met organisaties

Validations:

  • Must be a Integer

show_hidden_parameters
Optional

Display hidden parameter values

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

Scope met locaties

Validations:

  • Must be a Integer

organization_id
Optional

Scope met organisaties

Validations:

  • Must be a Integer

location
Required

Validations:

  • Must be a Hash

location[name]
Required

Validations:

  • Must be a String

location[description]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

location[user_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Gebruikers IDs

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Smart proxy IDs

Validations:

  • Must be an array of any type

location[compute_resource_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Compute resource IDs

Validations:

  • Must be an array of any type

location[medium_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Medium IDs

Validations:

  • Must be an array of any type

location[config_template_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Uitrol template IDs

Validations:

  • Must be an array of any type

location[ptable_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Partitie template IDs

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Uitrol template IDs

Validations:

  • Must be an array of any type

location[domain_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Domein IDs

Validations:

  • Must be an array of any type

location[realm_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Realm IDs

Validations:

  • Must be an array of any type

location[hostgroup_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Host groep IDs

Validations:

  • Must be an array of any type

location[environment_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Omgeving IDs

Validations:

  • Must be an array of any type

location[subnet_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Subnet IDs

Validations:

  • Must be an array of any type

location[parent_id]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Parent ID

Validations:

  • Must be a number.

location[ignore_types]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Som alle resource types op die automatisch geassocieerd zullen worden

Validations:

  • Must be an array of any type


PUT /api/locations/:id
Update a location

Params

Param Name Description
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer

organization_id
Optional

Scope met organisaties

Validations:

  • Must be a Integer

location
Required

Validations:

  • Must be a Hash

location[name]
Optional

Validations:

  • Must be a String

location[description]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

location[user_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Gebruikers IDs

Validations:

  • Must be an array of any type

location[smart_proxy_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Smart proxy IDs

Validations:

  • Must be an array of any type

location[compute_resource_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Compute resource IDs

Validations:

  • Must be an array of any type

location[medium_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Medium IDs

Validations:

  • Must be an array of any type

location[config_template_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Uitrol template IDs

Validations:

  • Must be an array of any type

location[ptable_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Partitie template IDs

Validations:

  • Must be an array of any type

location[provisioning_template_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Uitrol template IDs

Validations:

  • Must be an array of any type

location[domain_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Domein IDs

Validations:

  • Must be an array of any type

location[realm_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Realm IDs

Validations:

  • Must be an array of any type

location[hostgroup_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Host groep IDs

Validations:

  • Must be an array of any type

location[environment_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Omgeving IDs

Validations:

  • Must be an array of any type

location[subnet_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Subnet IDs

Validations:

  • Must be an array of any type

location[parent_id]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Parent ID

Validations:

  • Must be a number.

location[ignore_types]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Som alle resource types op die automatisch geassocieerd zullen worden

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

Scope met locaties

Validations:

  • Must be a Integer

organization_id
Optional

Scope met organisaties

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.