Enterprise resource

Cloud Admin	Enterprise Admin	User

Contents:

Enterprise Resource offers the functionality of managing the enterprise infrastructure in a logical way.

Enterprise Data Model

Methods related to Enterprise Resource

Retrieve a list of enterprises

Synopsis: GET http://example.com/api/admin/enterprises/
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: Enterprise.
Request example: Retrieve all the enterprises

Response Headers: Content-Length, Content-Type.
*Response Message Body: Enterprises
Response Status: 201, 400, 401, 403.
Response example: The creation response

Create a new Enterprise

Synopsis: POST http://example.com/api/admin/enterprises/
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
*Request Message Body: Enterprise.
Request example: Create new Enterprise

Response Headers: Content-Length, Content-Type.
*Response Message Body: Enterprise
Response Status: 201, 400, 401, 403.
Response example: The creation response

Retrieve a Enterprise

Synopsis: GET http://example.com/api/admin/enterprises/{$enterpriseId}
Request Headers: Accept, Content-Type.
*Request Parameters: N/A.
*Request Message Body: N/A.
Example Request: Retrieve information about a Enterprise.

Response Headers: Content-Length, Content-Type.
*Response Message Body: Enterprise.
Response Status: 200, 401, 403.
Example Response: Response of the GET over a enterprise

Updates an existing Enterprise.

Synopsis: PUT http://example.com/api/admin/enterprises/{$enterpriseId}
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
*Request Message Body: Enterprise.
Example Request: Update information about an enterprise.

Response Headers: Content-Length, Content-Type.
Response Message Body: N/A.
Response Status: 200, 400, 401, 403.
Example Response: Response of the update

Delete an existing Enterprise.

New Feature This feature has been available since version 1.6.8

RESTRICTIONS: The enterprise cannot have virtual datacenters assigned.
ON DELETE: This method also removes the virtual images downloaded by the enterprise.

Synopsis: DELETE http://example.com/server/admin/enterprises/{$enterpriseId}
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: N/A.
Example Request: Delete information about an enterprise.

Response Headers: Content-Length, Content-Type.
Response Message Body: N/A.
Response Status: 204, 401, 403, 409
Example Response: Response of the deletion