GET /api/organizations
List all organizations

Examples

GET /api/organizations
200
{
  "total": 3,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": "name = \"Empty Organization\"",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-09-11 14:41:48 UTC",
      "updated_at": "2019-09-11 14:41:48 UTC",
      "id": 114267492,
      "name": "Empty Organization",
      "title": "Empty Organization",
      "description": null
    }
  ]
}

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

Page number, starting at 1

Validations:

  • Must be a number.

per_page
Optional

Number of results per page to return

Validations:

  • Must be a number.


GET /api/organizations/:id
Show an organization

Examples

GET /api/organizations/447626452-org226
404
{
  "error": {
    "message": "Resource organization not found by id '447626452-org226'"
  }
}

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/organizations
Create an organization

Examples

POST /api/organizations
{
  "organization": {
    "name": ""
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

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

organization
Required

Validations:

  • Must be a Hash

organization[name]
Required

Validations:

  • Must be a String

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

Validations:

  • Must be a String

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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.

organization[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

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

Associated location IDs

Validations:

  • Must be an array of any type


PUT /api/organizations/:id
Update an organization

Examples

POST /api/organizations/447626439
{
  "organization": {
    "name": "iMjmeEtMTo",
    "description": "sNpnzwhOEk"
  }
}
201
{
  "select_all_types": [],
  "description": "sNpnzwhOEk",
  "created_at": "2019-09-11 14:41:49 UTC",
  "updated_at": "2019-09-11 14:41:49 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626439,
  "name": "iMjmeEtMTo",
  "title": "iMjmeEtMTo",
  "users": [],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "config_templates": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "environments": [],
  "hostgroups": [],
  "locations": [],
  "hosts_count": 0,
  "parameters": []
}

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

organization
Required

Validations:

  • Must be a Hash

organization[name]
Optional

Validations:

  • Must be a String

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

Validations:

  • Must be a String

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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

organization[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.

organization[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

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

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

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.