Things to know before using REST APIs with Sage X3 Business Cloud

Starting in version 7 here are some things that dev teams need to keep in mind if they are going to use REST APIs to work with Sage X3 Business Cloud:

  • The Web API (REST)

    • Can be used to read elements from all modules, as Sage X3 is already providing read-only representations on most resources. Basically, if there is a representation in the Read Only Pages section, REST can be used to read the data.

    • Should be used to update data from modules that have been upgraded. Resources that you can access with the mobile client can be read and modified through the Web API.

  • For the others REST web services currently is only available for READs (i.e. the Read Only Pages).

  • Create, Update and Delete are not currently supported.