1. User Scripting
  2. User Scripting
  3. SOAP API

SOAP API

Illustration of the relationshop between SOAP API objects and database entity.

User scripting provides access to the SOAP API (Web Services) through the NSOA.wsapi functions, see NSOA Functions. Before you begin using these functions, consult the API documentation. See XML API and SOAP API.

Important:

You should review API Best Practice Guidelines carefully before you start using NSOA.wsapi functions.

Tip:

All OpenAir Complex types start “oa”, for example “oaCategory”. You can look up the OpenAir Complex Types and their properties from the following link: https://app.openair.com/wsdl.pl.

If you strip away the “oa” you are left with the table name, for example “Issue”. You can look up tables in the OpenAir data dictionary. To access the OpenAir data dictionary, use the link in the navigation bar of the OpenAir Help Center or use the following URL https://<account-domain>/database/single_user.html.

Note:

You need the Enable user script support for Web Service API methods switch enabled to use the NSOA.wsapi functions, see Scripting Switches.

Tip:

Scripts are executed within the context of a user. This means that the user filter sets for the signed in user will be applied unless disabled, see NSOA.wsapi.disableFilterSet( [ flag] ).

Using the SOAP API: