GET api/Companies
Retrieves a list of companies
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Returns companies list
Collection of CompanyModelName | Description | Type | Additional information |
---|---|---|---|
Id |
Company Id |
globally unique identifier |
None. |
Name |
Company Name |
string |
None. |
StorageLimit |
Company backup limit. A negative value indicates the resource is unconstrained by a quota. |
integer |
None. |
LicenseSettings |
Company license settings: 0 - Custom (Users have custom license settings) 1 - Global Pool(Users activate paid licenses from the global pool automatically) 2 - Company Pool(Users can activate only limited number of paid licenses from the company pool) |
LicensingMode |
None. |
Destinations | Collection of CompanyDestinationModel |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": "66e98b3f-0794-41e1-8544-db3b32fa586c", "Name": "sample string 2", "StorageLimit": 1, "LicenseSettings": 0, "Destinations": [ { "DestinationId": "33c302cd-872c-4dbc-9fad-69ca759c5c9b" }, { "DestinationId": "33c302cd-872c-4dbc-9fad-69ca759c5c9b" } ] }, { "Id": "66e98b3f-0794-41e1-8544-db3b32fa586c", "Name": "sample string 2", "StorageLimit": 1, "LicenseSettings": 0, "Destinations": [ { "DestinationId": "33c302cd-872c-4dbc-9fad-69ca759c5c9b" }, { "DestinationId": "33c302cd-872c-4dbc-9fad-69ca759c5c9b" } ] } ]
application/xml, text/xml
Sample:
<ArrayOfCompanyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models"> <CompanyModel> <Destinations> <CompanyDestinationModel> <DestinationId>33c302cd-872c-4dbc-9fad-69ca759c5c9b</DestinationId> </CompanyDestinationModel> <CompanyDestinationModel> <DestinationId>33c302cd-872c-4dbc-9fad-69ca759c5c9b</DestinationId> </CompanyDestinationModel> </Destinations> <LicenseSettings>CustomUsersSettings</LicenseSettings> <Name>sample string 2</Name> <StorageLimit>1</StorageLimit> <Id>66e98b3f-0794-41e1-8544-db3b32fa586c</Id> </CompanyModel> <CompanyModel> <Destinations> <CompanyDestinationModel> <DestinationId>33c302cd-872c-4dbc-9fad-69ca759c5c9b</DestinationId> </CompanyDestinationModel> <CompanyDestinationModel> <DestinationId>33c302cd-872c-4dbc-9fad-69ca759c5c9b</DestinationId> </CompanyDestinationModel> </Destinations> <LicenseSettings>CustomUsersSettings</LicenseSettings> <Name>sample string 2</Name> <StorageLimit>1</StorageLimit> <Id>66e98b3f-0794-41e1-8544-db3b32fa586c</Id> </CompanyModel> </ArrayOfCompanyModel>