Connector Business Process and Schema Reference - Acumatica

To understand the Business Processes and the JSON Schemas that are part of a Connector project,  please refer to the swaggerDoc which contains the reference information for the methods of the contract-based REST API endpoint in the swagger.json file, which is an OpenAPI 2.0 (formerly known as Swagger 2.0) file. 

To obtain the swagger.json file: 

1. Form the Swagger URL.

   Format:

   https://<Acumatica ERP instance URL>/entity/<Endpoint name>/<Endpoint version>/swagger.json?company=<Company>

   Example: Suppose that you wanted to retrieve the API reference of the default endpoint and Version 6.00.001 available in the MyCompany company from a local Acumatica ERP instance with the name AcumaticaDB. You would use the following URL to obtain the swagger.json file.

2. From a browser, hit the URL formed in the previous step to view or save the file to your local machine.

   

   Each OperationID in the swagger can be correlated with the Business Process in the Acumatica Connector project under the entity which is part of the path.

   For instance :

   

   In the above screenshot operationId Account_GetByKeys under path /Account can be correlated to Account_GetByKeys.bps in Acumatica Connector project under /account package.

   

   For more information on Acumatica Swagger URL: 

   https://help-2019r2.acumatica.com/(W(6))/Wiki/ShowWiki.aspx?pageid=ca2716f1-025a-4a6e-9090-797cf32b0459