Limit results when querying Mirth REST PI

[why-not-try-calmer]

I expected to be able to limit results using something along the lines of:
https://.../api/channels&limit=<my_limit>

But this doesn't seem to work. Am I doing it wrong? Is there a known workaround?

[pacmano1]

Curious, why? I would normally get all channel IDs then iterate.

[why-not-try-calmer]

We have got 3 environments (dev, qa, prod) in my shop (public hospital), each with about 200 channels. I am developing a tool to basically diff scripts and variable names between environments, so as to ensure that a channel in the dev environment can be copied to qa and qa to prod without conflicts of variable names or scripts.

I ended up implementing the offset and limit query parameters myself, but I wish it had been offered out of the box by the Mirth Rest API. Since the /channels endpoint returns the entire xml or json-ified xml of all channels, that's a lot of data to send over the network.

An oversight in view of openAPI's best practices.

[pacmano1]

You look at #6345 ?

[why-not-try-calmer]

You look at #6345 ?

Thanks but no thanks.

So, ?limit not implemented?

[pacmano1]

The api documentation sometimes doesn't get the "mandatory" fields correct, but they are correct in the supported parameters.

You can also look at the source code yourself, thanks @jonbartels for the link:

connect/core-client-api/src/com/mirth/connect/client/core/api/servlets/ChannelServletInterface.java

Line 81 in be90435

public List<Channel> getChannels(

[jonbartels]

For the stated problem of large payloads (as opposed to a limit) - Would this method help?

connect/server/src/com/mirth/connect/server/api/servlets/ChannelServlet.java

Line 181 in be90435

public Map<String, String> getChannelIdsAndNames() throws ClientException {

It does not have a limit, however it is built to just return a list of channel IDs and names instead of entire channel objects.

https://github.com/search?q=repo%3Anextgenhealthcare%2Fconnect+getchannelids&type=code will show you what various getChannelIds methods exist internally. Then you can do one of:

• Find an API that exposes what you want
• Write a channel that exposes the Controller calls as an API
• Write a plugin that exposes your own custom API for your purposes

For the stated use case I would suggest looking at the odo Migrator, MirthSync, and the BrightCode Git Plugin. Some of those are open source and may have similar calls you can learn from even if you do not want to use the whole tool.