V-Spark Online Help

Synopsis

/config
/config/users
/config/orgs
/config/folders
/config/apps
/config/system/readonly
/config/CO_SHORT
/config/CO_SHORT/orgs
/config/CO_SHORT/folders
/config/CO_SHORT/apps
/config/CO_SHORT/users
/config/CO_SHORT/users/USERNAME
/config/CO_SHORT/ORG_SHORT
/config/CO_SHORT/ORG_SHORT/folders
/config/CO_SHORT/ORG_SHORT/apps
/config/CO_SHORT/ORG_SHORT/FOLDERNAME
/config/CO_SHORT/ORG_SHORT/apps/APPNAME

As shown in the synopsis, calls to the V‑Spark /config API can include optional entries that enable you to specify the following attributes:

CO_SHORT

the short name of a company

ORG_SHORT

the short name of an organization within a company

FOLDERNAME

the name of a specific folder

USERNAME

the name of a specific user

APPNAME

the name of a specific application

Specifying these attributes enables you to refine and limit the amount of information that you are retrieving, updating, or adding. See Refining by Companies, Organizations, Folders, and Apps for more information.

Calls to the V‑Spark API without specific company, organization, folder, user, or application values return all information for the API that you are calling. In other words, a call to /config/DocTestCo only returns information about a company whose short name is "DocTestCo." A call to /config returns information about all of the companies that have been defined in the V‑Spark installation that you are querying.