Sample /list/orgs JSON Output for a Company
The following is sample output for a single company from the /list/orgs
API:
"DocTestCo": [ "DocTestCo-DocTesting" ],...
In the same way that you can use the /config/CO_SHORT/orgs
API to retrieve information about the organizations within a company in a V‑Spark installation, you can use the /list/
API to retrieve the names of the organizations within a company, as shown in the following example, which was produced by calling the CO_SHORT
/orgs/list/DocTestCo/orgs
URL, and lists the organizations that have been defined within a sample company known as DocTestCo
:
[ "DocTestCo-DocTesting" ]
Tip
This example was produced by passing /list/DocTestCo
as the API-TO-CALL
parameter to the sample code shown in Using GET with Python and the /config API. Although that example was used to show calling the /config
API, it can just as easily be used to call the /list
API.
Important
The /list/
and CO_SHORT
/list/
API calls produce identical output. This is by design, because the only editable V‑Spark items that are directly located under a specific company are the organizations that have been defined within that company.CO_SHORT
/orgs