How do I use the /channels/{channelId}/messages endpoint with the metaDataSearch filter?

[rjcdoc]

I am trying to call this API Endpoint, /channels/{channelId}/messages, to mimic my search in the admin console. I am searching in the admin console for messages have a metaData column that match a specific criteria. It works in the admin console, but I need to try and script this out. I have used this API Endpoint before to do raw searches(rawContentSearch) successfully, but I take longer. Looking to speed up.

The docs say:

metaDataSearch
array[object]
(query)

Searches a custom metadata column. Value should be in the form: COLUMN_NAME value, where operator is one of the following: =, !=, <, <=, >, >=, CONTAINS, DOES NOT CONTAIN, STARTS WITH, DOES NOT START WITH, ENDS WITH, DOES NOT END WITH

These are the commands that I have tried:

curl -k --location --request GET "https://mirthserver:8443/api/channels/XXX-XXX-XXX/messages?metaDataSearch=MY_COLUMN_NAME,STARTS%20WITH,Value_I_LOOK_FOR&limit=1&offset=0&includeContent=true" -H "accept: application/json" -H "X-Requested-With: OpenAPI" --user user:password

curl -k --location --request GET "https://mirthserver:8443/api/channels/XXX-XXX-XXX/messages?metaDataSearch=MY_COLUMN_NAME&metaDataSearch=STARTS%20WITH&metaDataSearch=Value_I_LOOK_FOR&limit=1&offset=0&includeContent=true" -H "accept: application/json" -H "X-Requested-With: OpenAPI" --user user:password

curl -k --location -G "https://mirthserver:8443/api/channels/XXX-XXX-XXX/messages" --data-urlencode "metadataSearch=RESPONSE_STATUS STARTS WITH Found" -H "accept: application/json" -H "X-Requested-With: OpenAPI" --user user:password

[pacmano1]

curl -X GET "https://someip:8443/api/channels/751fc01e-248c-4a99-944a-3ee919fd02f6/messages?metaDataSearch=FAMILYNAME%20CONTAINS%20SMITHZ&limit=20" -H "accept: application/json" -H "X-Requested-With: OpenAPI"

works for me

[pacmano1]

But what is WAY faster is to query the native table in mirthdb that holds metadata.

[pacmano1]

curl -X GET "https://someip:8443/api/channels/751fc01e-248c-4a99-944a-3ee919fd02f6/messages?metaDataSearch=FAMILYNAME%20CONTAINS%20SMITH&metaDataSearch=SOURCE%20CONTAINS%20TEST&limit=20" -H "accept: application/json" -H "X-Requested-With: OpenAPI"

just an example there if multiple search parmams

[rjcdoc]

Thanks so much. It is working and you anticipated my next question, of multiple parameters. I was also able to get it to work with = sign using %3D encoded value.

I have not done the database because I don't know how. Is there some documentation on how to create queries like this against the database instead of using the API?

[pacmano1]

The d_mcm* tables have the metadata. Look at the one with the number the same as the local ID you see in the mirth admin tool. The columns are identical to the UI names. It's just like querying any other database via SQL.

Also a reminder that if you just use the native web based API endpoint you wouldn't have had to ask the question to begin with, it will show you the curl command after you select the endpoint and click "try it out" and execute. Reminder that sometimes the required fields aren't fully listed for some endpoints.

[rjcdoc]

Thanks for the second bit about the Client APIs. This will help out a lot!