Get Sales Companies
get
/rest/v16/salesCompanies
Use this endpoint to retrieve a list of sales companies.
Request
Query Parameters
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
totalResults: boolean
The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Default Response
The response for getting the sales companies.
Root Schema : SalesCompanyCollectionModelResponse
Type:
Show Source
object
-
count:
integer
-
hasMore:
boolean
Default Value:
false
-
items:
array items
-
limit:
integer
-
links:
array links
-
offset:
integer
-
totalResutls:
integer
Nested Schema : links
Type:
Show Source
array
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : salesCompanyItem
Type:
Show Source
object
-
links:
array links
-
login:
string
Example:
companyOne
-
name:
string
Example:
companyOne
Nested Schema : links
Type:
Show Source
array
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
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
Examples
The following example shows how to retrieve a list of sales companies accessible for the current user 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" https://sitename.oracle.com/rest/v16/salesCompanies
Response Body Sample
{ "items": [{ "name": "A1BM1", "login": "a_Co1BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users", "name": "users" } ] }, { "name": "A2BM1", "login": "a_Co2BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co2BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co2BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co2BM/users", "name": "users" } ] }, { "name": "A3BM1", "login": "a_Co3BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co3BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co3BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co3BM/users", "name": "users" } ] }, { "name": "A4BM1", "login": "a_Co4BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co4BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co4BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co4BM/users", "name": "users" } ] }, { "name": "A5BM1", "login": "a_Co5BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co5BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co5BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co5BM/users", "name": "users" } ] }, { "name": "A6BM1", "login": "a_Co6BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co6BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co6BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co6BM/users", "name": "users" } ] }, { "name": "A7BM1", "login": "a_Co7BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co7BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co7BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co7BM/users", "name": "users" } ] }, { "name": "cpqqa214", "login": "cpqqa214", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/cpqqa214" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/cpqqa214/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/cpqqa214/users", "name": "users" } ] }, { "name": "po1", "login": "po1", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po1" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po1/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po1/users", "name": "users" } ] }, { "name": "po2", "login": "po2", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po2" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po2/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po2/users", "name": "users" } ] }, { "name": "po3", "login": "po3", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po3" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po3/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po3/users", "name": "users" } ] }, { "name": "po4", "login": "po4", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po4" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po4/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po4/users", "name": "users" } ] }, { "name": "po5", "login": "po5", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po5" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po5/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/po5/users", "name": "users" } ] }, { "name": "A8BM1", "login": "s_Co8BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/s_Co8BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/s_Co8BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/s_Co8BM/users", "name": "users" } ] }, { "name": "Test", "login": "test", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/test" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/test/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/test/users", "name": "users" } ] }, { "name": "test2", "login": "test2", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/test2" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/test2/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/test2/users", "name": "users" } ] }, { "name": "Test3", "login": "test3", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/test3" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/test3/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/test3/users", "name": "users" } ] }, { "name": "test_unit", "login": "test_unit", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/test_unit" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/test_unit/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/test_unit/users", "name": "users" } ] }, { "name": "Translations", "login": "Translations", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/Translations" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/Translations/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/salesCompanies/Translations/users", "name": "users" } ] } ], "offset": 0, "limit": 1000, "count": 19, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/companies" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/companies?offset=0&limit=1000" } ] }