List of all Business Objects REST API

Afternoon,

My CIO is starting to utilise the REST API to get data out of the system, and has some questions regarding particular tables.

It looks as though the list of tables in Data Dictionary Viewer and the ones available through the REST API aren’t perfectly aligned.

Is there an equivalent list of what I’m guessing are Business Objects and their purposes that some kind soul could nudge me in the direction of?

The REST Endpoints are most closely arranged by the commands you use in Kinetic.

For reporting however, I HIGHLY recommend the BAQSvc. This will give the most information for the least work - except for Income Statement/Balance Sheet/Cash Flow kinds of reports.

1 Like

Forgive me, absolutely zero knowledge about API’s and that aspect of things.

Is BAQSvc a BAQ report I can run? Just can’t see it showing up in my list of BAQ’s, system or otherwise :sweat_smile:

The only “list” is the APIHelp Page available at

https<server>/<instance>/api/help

but that’s just a helper page that explains what each endpoint does… (to a certain extent)

2 Likes

Are you familiar with the OpenAPI/Swagger page for Kinetic? It is located here:

https://yourServer/yourInstance/apps/resthelp/#/home

image

BAQs and Epicor Functions have their own execution endpoints. The business objects that are related to them are for the maintenance of the BAQ or Epicor Function, so you won’t find them there.

The REST Guide on EpicWeb is quite useful too:

REST Services Guide V1 (EpicWeb)
REST Services Guide V2 (EpicWeb)

2 Likes

I’ve just found it, but unfortunately it might as well be written in Japanese for all the sense it makes to me :laughing:

API’s and that whole thing has never been on my radar. Essentially I’m trying to find which table I need to look at for opening bank balances and manual bank transfers (what I’ve been asked to find out), but am anticipating more questions so would rather be able to provide a comprehensive list to refer to.

So, the tricks to finding fields and tables are:

If it’s a screen, use Field Help on the screen where you KNOW the data is. It will tell you the name of the field and the source table. HOWEVER, some fields are calculated only by programs and not found in the database.

Same with reports. You can look at the Report Data Definition to see where a field comes from, and again, it may be calculated by a program.

I think what Mark is telling you is to make BAQs, and if the CIO wants them via rest, he can call the BAQSvc via rest to get his data. It’s going to be the most efficient way.

1 Like

latina GIF

1 Like

I have a spouse, kids, and coworkers, so yes.

Thanks all, time to play the guessing game of “where’s the data”!

Nearly a year and a half later of working with this system and it doesn’t seem to get any easier.

It takes about 3 years before you start feeling comfortable with most things. But there is always something new to learn.

3 Likes