Setting message flow user-defined properties at run time by using the administration REST API

You can change the behavior of a message flow at run time by using the IBM® App Connect Enterprise administration REST API to modify the values of user-defined properties on the message flow.

Before you begin

Read the following topics:

About this task

When a message flow node references a user-defined property, it searches these levels of the message flow:
  • If the message flow has the user-defined property named as a dynamic UDP override, this takes precedence over any other definitions.
  • If the message flow node is in a subflow, and the subflow has the named user-defined property, this is used.
  • If the message flow has the named user-defined property, this is used.
  • If the integration server has the named user-defined property, this is used.
You can use the administration REST API to apply and remove user-defined property overrides. By default these overrides are not persistent, which means that they must be reapplied after the integration server is restarted. You can configure the integration server to make the overrides persistent by modifying the UserVariables section in the server.conf.yaml file, as shown in the following example: 

UserVariables: 
  udp-persist-global-overrides: true
The following REST API methods are provided for applying and removing user-defined property overrides:
  • HTTP POST to /apiv2/servers/{server}/applications/{application}/messageflows/{messageflow}/apply-global-udp-override?name=NAME&value=VALUE&type=TYPE
  • HTTP POST to /apiv2/servers/{server}/applications/{application}/messageflows/{messageflow}/remove-global-udp-override?name=NAME
The REST API classes and methods are described in the App Connect Enterprise REST API V2 specification, which you can view in a browser by specifying the address of your integration node or server, followed by the administration REST API port, and then /apidocs. For example, to display the REST API specification for an integration server, enter a URL as shown in the following example (specifying either http or https):
https://green.company.com:7600/apidocs
where green.company.com is the address of the integration server, and 7600 is the admin REST API port specified in the server.conf.yaml file.
The REST API specification is also provided with your installation of App Connect Enterprise, in the following directories:
  • install_dir\server\nodejs\node_modules\@ibm-app-connect\ace-admin-server\node_modules\@ibm-app-connect\ace-admin-api\docs\server
  • install_dir\server\nodejs\node_modules\@ibm-app-connect\ace-admin-server\node_modules\@ibm-app-connect\ace-admin-api\docs\node
where install_dir is the directory in which App Connect Enterprise is installed.
See the following topics for more information about setting user-defined property overrides: