Get Host Company and All Partner Organizations
get
/rest/v16/companies
This endpoint retrieves a list that includes the host company and all partner organizations.
Request
Query Parameters
-
expand: string
Allows expansion of relationships.Allowed Values:
[ "users", "styleSheets", "translations" ]
-
limit: integer
The requested page size, which limits the number of elements the collection should max return.
-
offset: integer
The offset of the page. By default, offset is 0, which means first page will be returned.
-
q: string
Criteria to filter the companies. By default no filtering is applied.
-
totalResults: boolean
Specifies that the total count of records should be included in the response when doing pagination.
Response
Supported Media Types
- application/json
Default Response
List of companies.
Root Schema : company-collection
Type:
Show Source
object
-
items:
array List of Companies
Title:
List of Companies
List of companies.
Nested Schema : List of Companies
Type:
array
Title:
List of Companies
List of companies.
Show Source
-
Array of:
object Company Details
Title:
Company Details
Nested Schema : Company Details
Type:
object
Title:
Show Source
Company Details
-
access:
string
Title:
Access
Company access status to login granted/denied. -
activeLicensedUsers:
number
Title:
Active Licensed Users
Number of active users. -
address1:
string
Title:
Address 1
Company address 1. -
address2:
string
Title:
Address 2
Company address 2. -
baseCurrency:
object Currency
Title:
Currency
Base currency of the company. Value holds currency code. -
baseLanguage:
object Base Language
Title:
Base Language
Base language of the company. Value holds the language code. -
city:
string
Title:
City
City of the company. -
country:
string
Title:
Country
Country of the company. -
dateTimeFormat:
object Date/Time Format
Title:
Date/Time Format
Company preferred date time format. -
email:
string
Title:
Email
Email of the company. -
enabledForSSO:
boolean
Title:
Enabled for SSO
Is the company enabled for user login with SSO credentials? -
faxNumber:
string
Title:
Fax Number
Fax of the company. -
links:
array Links
Title:
Links
Links to the related objects. -
login:
string
Title:
Login Name
Company login name. -
maximumUsers:
number
Title:
Maximum Users
The maximum number of active users that the company allows to provide access. -
name:
string
Title:
Name
Name of the company. -
numberFormat:
object Number Format
Title:
Number Format
Preferred number format of the company. -
phoneNumber:
integer
Title:
Phone Number
Phone number of the company. -
state:
string
Title:
State
State province of the company. -
styleSheets:
object Style Sheets
Title:
Style Sheets
StyleSheets of the company. -
subscriptionPlan:
string
Title:
Subscription Plan
Subscription plan. -
supportedCurrencies:
object Supported Currencies
Title:
Supported Currencies
Currencies that are supported by the company. -
supportedLanguages:
object Supported Languages
Title:
Supported Languages
Languages that are supported by the company (supported languages are mandatory only for host company updates). -
timeZone:
object TimeZone of the company
Title:
TimeZone of the company
Company preferred timezone. -
translations:
object Translations
Title:
Translations
Translations of the company. -
units:
object Units
Title:
Units
Company preferred units. -
zip:
string
Title:
Zip Code
Zip code.
Nested Schema : Currency
Type:
object
Title:
Currency
Base currency of the company. Value holds currency code.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : Base Language
Type:
object
Title:
Base Language
Base language of the company. Value holds the language code.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : Date/Time Format
Type:
object
Title:
Date/Time Format
Company preferred date time format.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : Links
Type:
array
Title:
Links
Links to the related objects.
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Number Format
Type:
object
Title:
Number Format
Preferred number format of the company.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : Style Sheets
Type:
object
Title:
Style Sheets
StyleSheets of the company.
Show Source
Nested Schema : Supported Currencies
Type:
object
Title:
Supported Currencies
Currencies that are supported by the company.
Show Source
Nested Schema : Supported Languages
Type:
object
Title:
Supported Languages
Languages that are supported by the company (supported languages are mandatory only for host company updates).
Show Source
Nested Schema : TimeZone of the company
Type:
object
Title:
TimeZone of the company
Company preferred timezone.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : Translations
Type:
object
Title:
Translations
Translations of the company.
Show Source
Nested Schema : Units
Type:
object
Title:
Units
Company preferred units.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : reference links
Type:
object
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related object
URL to the related object -
name:
string
-
rel:
string
Title:
Link Relationship to the current object
Default Value:self
Link Relationship to the current object
Nested Schema : companyStyleSheet-collection
Type:
Show Source
object
-
items:
array Style Sheet Collection
Title:
Style Sheet Collection
List of style sheets. -
links:
array Links
Title:
Links
Links to current objects.
Nested Schema : Style Sheet Collection
Type:
array
Title:
Style Sheet Collection
List of style sheets.
Show Source
-
Array of:
object Style Sheet
Title:
Style Sheet
Nested Schema : Links
Type:
array
Title:
Links
Links to current objects.
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Style Sheet
Type:
object
Title:
Show Source
Style Sheet
-
links:
array Links
Title:
Links
Links to current objects. -
name:
string
Title:
Style Sheet Name
Unique name for the style sheet.
Nested Schema : Links
Type:
array
Title:
Links
Links to current objects.
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Currency Details
Title:
Currency Details
Nested Schema : Currency Details
Type:
object
Title:
Show Source
Currency Details
-
currencyCode:
string
Title:
Currency Code
Currency code. -
currencyName:
string
Title:
Currency Name
Currency name. -
isBaseCurrency:
boolean
Title:
Is Base Currency
Is base currency? -
isEnabled:
boolean
Title:
Is Enabled
Is enabled? -
precision:
integer
Title:
Precision Value
Precision value.
Nested Schema : language
Type:
Show Source
object
-
languageCode:
string
Title:
Language Code
Language Code -
languageNumber:
integer
Title:
Language Number
Unique language number.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Company Translations
Title:
Company Translations
Nested Schema : Company Translations
Type:
object
Title:
Show Source
Company Translations
-
items:
array Company Translations List
Title:
Company Translations List
-
links:
array Links
Title:
Links
Links to current objects.
Nested Schema : Company Translations List
Type:
array
Title:
Show Source
Company Translations List
-
Array of:
object Company Translation
Title:
Company Translation
Nested Schema : Links
Type:
array
Title:
Links
Links to current objects.
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Company Translation
Type:
object
Title:
Show Source
Company Translation
-
language:
object Translation Language
Title:
Translation Language
-
links:
array Links
Title:
Links
Links to current objects. -
name:
string
Title:
Company Translation Name
Company translation name in specific language.
Nested Schema : Translation Language
Type:
object
Title:
Show Source
Translation Language
-
languageCode:
string
Title:
Language Code
Translation message language name. -
languageNumber:
string
Title:
Language Number
Language sequence number in supported language list. -
links:
array Links
Title:
Links
Links to current objects.
Nested Schema : Links
Type:
array
Title:
Links
Links to current objects.
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Links
Type:
array
Title:
Links
Links to current objects.
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Examples
The following example shows how to retrieve a list that includes the host company and all partner organizations by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Content-type: application/json" -H "Accept: application/json" https://sitename.oracle.com/rest/v16/companies
Response Body Sample
{ "items": [{ "name": "system123", "login": "system123", "subscriptionPlan": "FullAccessWithESales", "baseLanguage": { "value": "en", "displayValue": "English" }, "units": { "value": 1, "displayValue": "English" }, "numberFormat": { "value": 0, "displayValue": "####.##" }, "dateTimeFormat": { "value": 0, "displayValue": "MM/dd/yyyy h:mm a" }, "timeZone": { "value": "America/Chicago", "displayValue": "(GMT-6:00 GMT-5:00) Chicago" }, "baseCurrency": { "value": "USD", "displayValue": "US Dollar" }, "country": "United States", "email": "system123@yourcompany.com", "supportedLanguages": { "items": [{ "languageCode": "ar_SA", "languageName": "Arabic [Saudi Arabia]", "iso2LanguageCode": "ar", "isBaseLanguage": false, "isEnabled": true } ] }, "supportedCurrencies": { "items": [{ "currencyCode": "ALL", "currencyName": "Lek", "precision": 2, "isBaseCurrency": false, "isEnabled": true }, { "currencyCode": "AUD", "currencyName": "Australian Dollar", "precision": 2, "isBaseCurrency": false, "isEnabled": false } ] }, "access": "Granted", "isEnabledSSO": true, "activeUserLicense": 10, "maximumUsers": 15, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v16/companies/system123" }, { "rel": "child", "name": "styleSheets", "href": "http://sitename.oracle.com/rest/v16/companies/system123/styleSheets" }, { "rel": "child", "name": "users", "href": "http://sitename.oracle.com/rest/v16/companies/system123/users" } ] } ], "offset": 0, "limit": 1000, "count": 23, "hasMore": false, "links": [{ "rel": "canonical", "href": "http://sitename.oracle.com/rest/v16/companies" }, { "rel": "self", "href": "http://sitename.oracle.com/rest/v16/companies?offset=0&limit=1000" } ] }