Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Abiquo 2.4


Skip to end of metadata
Go to start of metadata

EnterpriseProperties Resource

Exposed Resources Hierarchy
EnterpriseProperties Resource

Contents:

The Enterprise Properties Resource enables you to manage generic enterprise metadata.

Main URI of the Resource

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

Exposed Methods

Retrieve the properties of an enterprise

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+xml; version=2.4; 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
Retrieve the properties of an enterprise example
$ curl -X GET http://10.60.20.60:80/api/admin/enterprises/2/properties\
	 -H 'Accept: application/vnd.abiquo.enterpriseproperties+xml; version=2.4'	\
	 -u user:password --verbose


GET http://10.60.20.60:80/api/admin/enterprises/2/properties HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.enterpriseproperties+xml;version=2.4


HTTP/1.1 200 OK
Date: Wed, 16 Jan 2013 14:07:13 GMT
Set-Cookie: JSESSIONID=381BE5C2A5920F31EFC6D5776AAA7956; Path=/api
Set-Cookie: auth=YWRtaW46MTM1ODM0NzAzNDA5NTowMDcwNDVkMDhjNTQwYjk1ZDhkOGY3ODFmNDkyZDMxODpBQklRVU8; Expires=Wed, 16-Jan-2013 14:37:14 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.enterpriseproperties+xml;version=2.4
Content-Length: 382

<?xml version="1.0" encoding="UTF-8"?>
<enterpriseProperties>
  <link href="http://10.60.20.60:80/api/admin/enterprises/2/properties"
    rel="edit" type="application/vnd.abiquo.enterpriseproperties+xml"/>
  <link href="http://10.60.20.60:80/api/admin/enterprises/2"
    rel="enterprise" type="application/vnd.abiquo.enterprise+xml"/>
  <id>2</id>
  <properties/>
</enterpriseProperties>


Update enterprise information

Updates the properties of an enterprise

Synopsis: PUT http://example.com/api/admin/enterprises/{enterprise}/properties
Roles Required: ROLE_ENTERPRISE_ADMINISTER_ALL
Request Headers: Accept: application/vnd.abiquo.enterpriseproperties+xml; version=2.4; Content-type: application/vnd.abiquo.enterpriseproperties+xml; version=2.4;
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
Update enterprise information example
$ curl -X PUT http://10.60.20.60:80/api/admin/enterprises/2/properties\
	 -H 'Accept: application/vnd.abiquo.enterpriseproperties+xml; version=2.4'	\
	 -H 'Content-Type: application/vnd.abiquo.enterpriseproperties+xml; version=2.4'	\
	 -d @entity.xml	\
	 -u user:password --verbose


PUT http://10.60.20.60:80/api/admin/enterprises/2/properties HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.enterpriseproperties+xml;version=2.4
Content-Type: application/vnd.abiquo.enterpriseproperties+xml;version=2.4
Content-Length: 516


HTTP/1.1 200 OK
Date: Wed, 16 Jan 2013 14:07:13 GMT
Set-Cookie: JSESSIONID=A7D3E8CDC65E00A0879638C54F3F2706; Path=/api
Set-Cookie: auth=YWRtaW46MTM1ODM0NzAzNDE3OTphN2UzNTMyN2Y0YzUxNjQ2Y2Q0ZTJhZGZkODhkMGI1ZDpBQklRVU8; Expires=Wed, 16-Jan-2013 14:37:14 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.enterpriseproperties+xml;version=2.4
Content-Length: 434

<?xml version="1.0" encoding="UTF-8"?>
<enterpriseProperties>
  <link href="http://10.60.20.60:80/api/admin/enterprises/2/properties"
    rel="edit" type="application/vnd.abiquo.enterpriseproperties+xml"/>
  <link href="http://10.60.20.60:80/api/admin/enterprises/2"
    rel="enterprise" type="application/vnd.abiquo.enterprise+xml"/>
  <properties>
    <entry>
      <key>Prop</key>
      <value>Value</value>
    </entry>
  </properties>
</enterpriseProperties>


Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

  • No labels