Open Access Web API Information

1. The Open Access Web API is a web service that can be used to extract data from CKB and do limited operations
2. The primary use of the Web API on initial release is to expose the retrieval of X, Y & Z coordinates and planogram information for a given UPC or ID for the purposes tracking where products are located in a store
3. Access the integrated help through the following URL (replacing <webserver> with the name of the web server in your environment):
4. http://<webserver>/IKB/Data/Help?version=1

1. Knowledge of RESTful web services/API and the CKB data structure is require to utilize the Open Access Web API
2. Web API support is available from v2016.1
3. The documentation on the release media under \Category Knowledge Base\Documents\Technical Documentation\Open Access API Reference is related to development of web controls in Open Access, not accessing data through the REST format API
4. Detailed information is available in v.2017.2 Open Access Administration Guide
5. User can install the OpenAccessWebAPI.msi from '\Category Knowledge Base\Install\WebAPI' release media

Examples:

• To get a list of planograms with specified hierarchy DBKeys, all fields, utilizing paging and sorting

http://<webserver>/IKB/data/api/v1/HierarchyObjects?tableGroup=pro/space&tableDescriptor=planogram&dbParentAccountKey=0&hierarchyDbKeys=-1&select=All&pageSize=5&pageNumber=2&sort=Name%20DESC

• To get a list of planograms with specified hierarchy DBKeys, specified fields, utilizing paging and sorting

http://<webserver>/IKB/data/api/v1/HierarchyObjects?tableGroup=pro/space&tableDescriptor=planogram&dbParentAccountKey=0&hierarchyDbKeys=-1&select=Name,%20Width,%20Height,%20Depth&pageSize=5&pageNumber=2&sort=Name%20DESC

Note:
hierarchyDBKeys = -2 will return all the records
If pageSize is not provided, all records will be returned
 

• To get a planogram with selected fields

http://<webserver>/IKB/data/api/v1/HierarchyObjects/?tableGroup=pro/space&tableDescriptor=planogram&dbParentAccountKey=0&Select=Name, Height, Width, Depth