Api reference guide

The Sage X3 platform provides access to different API described below.

Additional X3 functions have also been developed to replace X3 version 6 functions. These functions are useful in the Versions 7 and above development process. They are also described in this page, module by module. The title of the entry corresponds to the function and the script file that was present in version 6.

Technical libraries

Access to the node.js server resources from an X3 script

These libraries are available only for V12 platform (in version V12 native mode or in Classic mode).

• Call of an outgoing REST web service
• Access to the storage area
• Execution of javascript functions
• Execution of an http request from web server

Calling services provided by the X3 platform

Calling web services provided by X3 uses api1 protocol based on http requests:

• The general syntax of an http request is provided in the API requests page.
• The way to authenticate is provided in the Authentication and single sign on principles page.

The different services associated with the entities are:
* The list of entity instances (used by the query facet in the client) through a GET query request.
* The details of an entity instance (used by the details facet in the client) through a GET details request.
* Creation of an entity instance (used by the edit facet in the client) through a POST request.
* Updating an entity instance (used by the edit facet in the client) through a PUT request.
* Deletion of an entity instance (called from the query or details facet in the client) through a DELETE request.

Supervisor libraries

These libraries provide access to common services supplied by the supervisor layer. Some of them can be used only in Classic code code, some others can be used only in code associated to classes and representations, and some of them can be used independently.

Libraries dedicated to classic code

Libraries dedicated to V7 + code

• Get a sequence number value
• Get the sequence number definition for a given document
• Additional methods of the context class
• Create a batch task request
• Create a URL to access to a classic page or a class/representation page
• Send a mail with V6 technology (meladx) in the new development mode
• Manage asynchronous operations
• Manage V6 workflow on classes
• Get parameters sent in the representation URLS

Libraries usable in both modes

• Get a parameter value independently from context
• Get links between legislation codes, sites and companies
• Screen action for file selection
• Manage reauthentication of users
• Manage sessions informations

Web services

The technical platform provides a support for SOAP web services. These web services work exactly as the V6 web services worked (the format is the same).

When working with classes and representation, it is also possible to work with REST web services

The list of SOAP web services added for platform purposes are here:

• SOAP API for import/export of files

Miscellaneous

A library allows to launch an executable program (on windows only) from the browser (only in classic code). For security reasons, every user has to approve the use of the executable from browser at the first use.
The corresponding documentation can be found here

Accounting libraries

Currency management