Rest API Constructor

The following is the constructor of the Rest API class.

• RestAPI Constructor

RestAPI Constructor

Syntax

RestAPI(string rmpHostName, string webAPIUrl, string Culture, string registrarUser, string registrarPassword)

Parameter

• rmpHostName – The location of the AVEVA Recipe Management Server

• webAPIUrl – The AVEVA Recipe Management website URL that RestAPI will send web requests to.

• Culture – specifies culture setting for the web request/response.

  • Optional – defaults to “en-US”.

• registrarUser [optional] – AVEVA Identity Manager Registrar User name. To be specified if RestAPI client needs to be auto registered with AVEVA Identity Manager.

• registrarPassword [optional] - AVEVA Identity Manager Registrar password. To be specified if RestAPI client needs to be auto registered with AVEVA Identity Manager.

If the AVEVA Identity Manager registrar credentials are passed in the constructor and the application using RestAPI runs as an Administrator, then auto-registration of RestAPI client will happen with AVEVA Identity Manager.

If the AVEVA Identity Manager registrar credentials are not passed in the constructor, then user will need to install and configure AVEVA Recipe Management Client connection configuration feature. This feature will add the SSL certificates from AIM node to trusted store and register the AVEVA Recipe Management clients such as RestAPI with AVEVA Identity Manager.

When you install AVEVA Recipe Management Server feature, a client secret (a GUID) is created and stored in AVEVA Identity Manager and AVEVA Data Store.

The admin user running the configurator and the application using RestAPI will be added automatically to the list of whitelisted users/groups to access the client secrets.

You can add more users/groups who will be running the applications such as IDE, or applications involving Client API and Rest API. You must install and configure AVEVA Recipe Management Client Connection Configuration feature to whitelist users/groups. For more information, refer to the AVEVA Recipe Management Installation Guide.

Note: Administrators who are already whitelisted on a specific system can whitelist other users/groups by running the AVEVA Recipe Management Client Connection Configuration feature. If client has been registered automatically, then only a whitelisted administrator user has the privilege to whitelist other users/groups.