Skip to main content

REST Endpoint Definitions

  • August 6, 2025
  • 55 replies
  • 706 views

JSpikowski
Jr Varsity II
Forum|alt.badge.img

Acumatica allows displaying the endpoint schema with a REST call. This is an example of the Customer endpoint schema.

localhost/acumaticadb/entity/Default/24.200.001/Customer/$adHocSchema

I put the output on my server as it too large to display in a post.

https://johnspikowski.com/acumatica/customer_schema.txt

The Web Services Endpoint screen is another asset for endpoint definitions.

http://localhost/acumaticadb/Main?CompanyID=Demo&ScreenId=SM2070PL

 

55 replies

JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 7, 2025

I had to have some of my posts moderated when I post code. Chris informed me the forum package doesn’t like the word ‘localhost’ in a URL. I added an entry into my hosts file for laptop to be 127.0.0.1.

http://laptop/acumaticadb/Main?CompanyID=Demo&ScreenId=DB000031

Lets see if this post needs moderation.


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 7, 2025

The display of the Customer schema doesn’t show CustomerID which is in the Customer table?

Can someone explain why the Customer table column names aren’t being shown?

Can I use this schema info to create a new customer?

 


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 7, 2025

This should be a forum badge. Bug Scout

So far I found the duplicate Set-Cookie header bug and maybe a bug with $adHocSchema not including the primary table schema.

 

 

 


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 7, 2025

Does the development team look at these posts and respond to members when they find bugs? 

 


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 7, 2025

It seems that the Web Service Endpoints Default 24.200.001 doesn’t include the Customer table definition as I found out in the $AdhocSchema response. 😣

 


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 7, 2025

I was able to see the Customer rows definitions by clicking on the Fields tab. It seems the  $adHocSchema is the only issue at this point not showing the Customer table definitions.


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 7, 2025

It would be great if someone could try a REST $adHocSchema call on Customer and see if you are getting the Customer table schema. I'm running 25.1 on my laptop.

Look for CustomerID in the returned schema data. It's only returning sub-table schema definitions for me.


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 8, 2025

I watched a Steven Houglum's tech stack overview from a developer's standpoint which filled the holes in my understanding of the Acumatica platform.

The best news is the Modern UI is using Bootstrap as the presentation framework. Communication back to the server is done via AJAX.

ScriptBasic couldn't be more compatible. 


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 8, 2025

I don't see running a 'static' version of Acumatica UI presentation under ScriptBasic on Linus using Apache / Nginx as a problem.

Communication with Acumatica's accounting engine on Windows with a IIS web service endpoint / AJAX engine would run a hell of a lot faster than sending JavaSript to generate HTML like is being done now.

Currently running Acumatica is like running the development environment in production.


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 8, 2025

This my local Linux developerment server I will be using with my Windows laptop running Acumatica, IIS and MySQL / MS SQL Server.

https://OrangePiZero.com

Freatures:

* Uses Webmin for server management (browser based)

* Looks like a Windows Server using Samba

* AWS S3 is a mounted extension to the filesystem.

* Portable and can run on battery pack for 8 hours.

 

 


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 8, 2025

The problem with the $adHocSchema results I was having seems to be an issue with my JSON to ScriptBasic associative array or the dump of it. The JSON conversion library was built based on QBO responses. Acumatica formats their JSON differently which my web extension module seems to skip sections of the response.

 

The following is the raw JSON response in pretty mode.

https://johnspikowski.com/acumatica/Customer_Schema.json

 

Update: Thankfully the issue is with the sbadump() function and not json2sba() that builds the associative array. 

 


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 8, 2025

I was reviewing the C:\Program Files\Acumatica ERP\acumaticadb\FrontendSources\screen\src\screens\AR\AR303000 directory files and can’t seem to find where the AJAX calls are made. 

My goal is to end up with rendered HTML and supporting JavaScript / CSS code. I can view this now in the browser (Firefox) with a right click on the page and select Inspect(q). I then right click on the <html> tag and select edit in HTML. This gives me the rendered HTML the browser displays to the user.


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 8, 2025

This shows what AR30300.html (Customer form) looks like ‘raw’ and rendered formats.

Raw: https://johnspikowski.com/acumatica/AR303000.html_default.txt

Rendered: https://johnspikowski.com/acumatica/AR303000_rendered.txt

I’m working on creating an example on my local Linux server running a rendered Customer screen using my laptop running Windows for the Acumatica AJAX calls. I’m not sure it this is going to work but will be fun trying. This is what I’m calling the production version. 😎


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 8, 2025

This screen is using the Modern UI. I was surprised to see what looks like ASP based event calls. Steven said in the video that events were handled with AJAX.

 


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 9, 2025

It looks to me that Acumatica hasn't weened themselves off ASP event handling yet with the Modern UI in 25.1.

The reason for the Modern UI is ASP will deprecated soon.

While Classic ASP itself is not being officially deprecated in Windows Server 2025, its core scripting language, VBScript, is being deprecated. Windows Server 2025 will still include VBScript as a Feature on Demand, but it is planned for complete removal in later versions. This means that while Classic ASP will continue to function, its reliance on VBScript will eventually make it.

 


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 9, 2025

Good News!

I was able to run my static (rendered) version of AR303000_JRS.html from the webroot of the IIS server.I’m unable to run any of the menu options but I can view multiple customers. Notice the URL in the address bar.

Acumatica Customer - Startic HTML

Selecting a customer from the list displayed it instantly. Moving between tabs was also instant. No server side UI generation. There were long screen delays running it the normal way.


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 10, 2025

I was able to run the rendered version of AR303000.html in its original directory without any issues. Tab display changes are instant with a slight delay getting the data.

My assumption is Acumatica loads the standard (templated) AR303000.html file and the HTML the user sees is generated on the fly with JavaScript. I think I’m skipping this step with my rendered version of AR303000.html.

It would be great the get conformation this is what is happening.

 

 


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 10, 2025

For me, I would rather do mods to HTML files that are in their JavaScript rendered format rather than the Acumatica tools to build screens from templates.

I feel I'm close to be able to run my version of AR303000.html on Linux with Apache if the ASPX mod plug-in works for event handling.

 

 

 


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 11, 2025

I discovered why my sbadump() and sba2json() functions aren't working correctly with Acumatica JSON response code. The ( ) symbolss aren't standard JSON syntax. The only reason my json2sba() works is I using the ScriptBasic JSON extension module to extract the elements. It ignores junk. So far only the REST $AdhocSchema responses seems to have these ( ) in the code. Normal responses seem void of this malicious syntax.

 

In JSON, the () symbols (parentheses) do not have a specific meaning or function. JSON syntax primarily uses other symbols for structuring data:

  • Curly braces {}: These denote a JSON object, which is an unordered collection of key-value pairs.
  • Square brackets []: These denote a JSON array, which is an ordered list of values.
  • Double quotes "": These enclose strings, including the keys within objects and string values.
  • Colon :: This separates a key from its value within a key-value pair in an object.
  • Comma ,: This separates key-value pairs within an object and elements within an array.

Parentheses are not part of the standard JSON syntax for defining data structures. While they are used in other programming languages (like JavaScript) for function calls or grouping expressions, they are not used in JSON itself.

 


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 13, 2025

Is there a way to use import scenarios but automate the definitions of the source data? Is this a screen function only?

Do spreadsheet imports define everything needed so you are ready to test the import data with no definition requirements?

 


MichaelShirk
Captain II
Forum|alt.badge.img+6
  • Captain II
  • August 13, 2025

Is there a way to use import scenarios but automate the definitions of the source data? Is this a screen function only?

Do spreadsheet imports define everything needed so you are ready to test the import data with no definition requirements?

 



I would highly recommend going through this course to learn about import scenarios, as they’re very powerful. 
I100 Integration Scenarios 2025 R1

 

You’ve posted about a number of different topics in this same conversation thread. 
If topics are separated into their own threads, it makes it easier for other users to provide answers, and is much more helpful if someone else has a similar question in the future.


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 13, 2025

Thanks Michael for the link.

I can't create new topics on my phone, only on my laptop. I can't do code blocks either. The forum on a phone sucks.


Chris Hackett
Community Manager
Forum|alt.badge.img
  • Acumatica Community Manager
  • August 13, 2025

@JSpikowski works for me on iPhone and iPad. I do notice there is a different button (pencil bottom right of first screen shot below) on the phone when in portrait mode. In landscape it’s the same as iPad and laptop.

 


JSpikowski
Jr Varsity II
Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • August 13, 2025

Chris,

Here is what my Samsung S20 FE 5G screen looks like. No 'pencil' to be found.

 


Chris Hackett
Community Manager
Forum|alt.badge.img
  • Acumatica Community Manager
  • August 13, 2025

I don’t know then. Per Gainsight browser works for this functionality.