Documentation

Skip to end of metadata
Go to start of metadata

EnterpriseProperties Resource

The Enterprise Properties Resource enables you to manage generic enterprise metadata. In Abiquo 3.8.4+ you can edit the properties in the user interface and the administrator can set predefine property keys and default values.

Main URI of the Resource

This class operates mainly over the Resource URI: /admin/enterprises/{enterprise}/properties

Exposed Methods

Retrieve enterprise properties

Retrieves the properties of an enterprise.

Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/properties
Roles Required: ROLE_ENTERPRISE_ADMINISTER_ALL
Request Headers: Accept: application/vnd.abiquo.enterpriseproperties+json; version=3.8; application/vnd.abiquo.enterpriseproperties+xml; version=3.8;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: EnterpriseProperties Media Type
Request Example:

 Click here to show or hide the request example

API example removed: GET_adm_ents_X_props_AC_entprops_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

Update enterprise properties

Updates the properties of an enterprise, overwriting all existing properties.

Synopsis: PUT http://example.com/api/admin/enterprises/{enterprise}/properties
Roles Required: ROLE_ENTERPRISE_ADMINISTER_ALL
Request Headers: Accept: application/vnd.abiquo.enterpriseproperties+json; version=3.8; application/vnd.abiquo.enterpriseproperties+xml; version=3.8;  Content-type:  application/vnd.abiquo.enterpriseproperties+json; version=3.8; application/vnd.abiquo.enterpriseproperties+xml; version=3.8;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: EnterpriseProperties Media Type
Response Message Body Entity: EnterpriseProperties Media Type
Request Example:

 Click here to show or hide the request example

API example removed: PUT_adm_ents_X_props_CT_entprops_j_AC_entprops_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

Minimum Request Message Body:

You can send only the properties that you wish to update.

{
  "properties": {"property_input": "Head Office", "property_multi": "Barcelona", "property_combo": "London"}
}