V-Spark Online Help

Refining by Companies, Organizations, Folders, and Apps

As shown in Synopsis, API calls can optionally specify the short name of a company (CO_SHORT), the short name of an organization (ORG_SHORT), the name of a folder (FOLDERNAME), or the name of an application (APPNAME) to limit the data that is returned by an API call to only that which is specific to those names:

  • If the short name of a company (CO_SHORT) is not specified, the JSON that is returned contains information about all relevant data for any company in a V‑Spark installation.

  • If the short name of a company is specified, only information that is related to that company is returned.

  • If you specify the short name of a company, the short name of an organization (ORG_SHORT), the name of a folder (FOLDERNAME), or the name of an application (APPNAME), only information associated with that specified entry is returned. If any of these entries are invalid, the API call returns an error message. You cannot request or try to update information about an entry if any part of the entry specification is incorrect.