APIs in Integration Manager can accept an alias to call a JobConfig listener. The jobconfig-aliases API allows aliasing a JobConfig listener with a name. An alias name may be mapped to one JobConfig. The API supports assignment of multiple aliases for a JobConfig.

The following is an example of assigning the alias “alias1” with JobConfig “1”:

The following is an example that calls a listener with the JobConfig alias “alias1” created above.

In the example above, the route /api/listener/alias1 is an alias of /api/jobconfig/1/listener. The JobConfig alias for listeners, endpoint POST api/listener/{alias}, enables using the same functionality as calling POST api/jobconfig/{id}/listener.

Run JobConfiguration with text message input and text message output (if running synchronously). If the out message is not supplied, the job will execute asynchronously. The out message may be retrieved by GET /api/job/{id} after the job is complete.

Other than creating aliases for JobConfiguration, the API provides administration requests to manage (modify, read, and delete) aliases.

Here is an example of updating the same alias to point to a different JobConfig “2”:

And an example of retrieving JobConfig alias “alias1”:

An example of deleting JobConfig alias “alias1”:

The following is an example to retrieve all JobConfig aliases:

For more information about jobconfig-aliases requests, responses, and error messaging, see Available Services and Documentation.