API Documentation
API (Application Programming Interface) provides the ability for a program code or script to do actions in the Vizion platform. For instance, you can use API to get all records of a trackor type (similar to a user accessing a Trackor Browser page), or getting details of a specific record (User viewing a trackor record), or updating details of a specific record (User editing a trackor record). It is basically an interface for a Program/Script to work on the OneVizion platform, the way a User would use OneVizion. This provides the ability for another software to work with the OneVizion platform without human intervention - example would be - a piece of Code/Program updating a set of records based on details from another program/platform used by the Customer.
| Info |
|---|
Administrators use the API_DOCS security group to show/hide the API Documentation in the Help menu. |
Administrative Users may access the API documentation via the Help menu.
The following Security Group will need to be assigned to the Security Role:
The Authorize button allows either Username/Password or Token authorization to use the Swagger documentation and make test API calls.
Examples of available API (Delete, Get, Post)
DB Documentation
| Info |
|---|
Administrators use the DB_DOCS security group to show/hide the DB Documentation in the Help menu. |
BPD Help
Best Practice Documentation is used to assist users in populating data on the current form.
| Note |
|---|
Only users with privileges on "ADMIN_BPDOC_ITEM" Security Group may modify the documentation. Detailed information for adding BPD is located in the Administrator Manual. |
BPD Help Editor
| HTML Comment |
|---|
Updated 08/02/2021 Release 21.14 Conf-177892 Updated 10/26/2020 Release 20.20 GUI-168334 Updated 09/07/2020 Release 20.16 CodeQ-153687 Updated 04/20/2006 Release 20.6 VF-155826 Updated 01/27/2020 Release 20.0 GUI Changes Updated 08/12/2019 Release 19.12 Grid-141510 Updated 12/03/2018 Release 8.96 Grud-137646, GUI 136626 Updated 05/28/2018 Release 8.83 GUI-114538, GUI-114539 Updated 6/19/2018 Rel. 8.85 |