REST-API Object ID

Hello Craig,

Thanks for your reply.

Actually, I need to retrieve properties for all objects of type 102.   But since the number of objects is about 4000 and the practical limit is 500 records, I need to do segmentations. I thought that using Object ID as the 'bucket' would be a good way to do that.

Thanks for your support.

Martin Leclerc

So.  A couple of things.

The default limit is 500, but your code can request a larger number (Searching using the M-Files Web Service (REST API)).  It still may be limited by the server, though, depending upon a number of factors.  This may be a good quick option for you.

If you were using the COM API then I'd guide you down the "segmented search" route, which does exactly what you're talking about (the fact you use the word "segments" makes me think you've come across this already): MFilesSamplesAndLibraries/Samples/COM API/SegmentedSearch at master · M-Files/MFilesSamplesAndLibraries (github.com)

Unfortunately the segmented search relies upon the object ID which, again, I assume you've found, there isn't a documented REST API search parameter for.

There are a couple of options:

1. There is an undocumented (therefore theoretically unsupported) querystring parameter that you can send named "i".  This is the object ID.  It works in the same way as others, so you can restrict the search results by the ID and grab objects 1=>100, 101->200, etc..
2. You could consider exposing a "vault extension method" and calling that via the REST API.  This vault extension method can take whatever data you want (it's a string) and return whatever data you want (it's a string).  This way you could actually define a method that does exactly what you need and only return exactly what you need.

I include number 1 above as an option, but it's not one I would really recommend.  I know that the querystring parameter is used by some integrations, but in theory it's not supported and may change in the future.  It's unlikely, but hopefully you understand why I have to say that.

Number 2 is probably what I would guide you towards, especially if the logic on what to retrieve is more complex (e.g. you only need certain properties).  This gives you complete control over what you do in the method and the data that's returned back out again.  However: it requires you to have some code in the vault (VBScript or, probably vastly better here, VAF).

Hello Craig.

Thank again for your reply.

Yes, I did come across the segmented search route.

The parameter I is indeed working but it seems that I can't combine them in the url like

/REST/objects/102?I>>=4000&I<<4100.   That returns all ObjectId higher than 4000.  Is there a way to combine two parameters? 

I will check VAF, I guess the best way to start is here: https://developer.m-files.com/Frameworks/Vault-Application-Framework/ , right?

Thanks for your support!

Martin Leclerc

I think you have a typo in your URL.  If you want "greater than 4000 and less than 4001" then it should be:

/REST/objects/102?i>=4000&i<<=4100

To start with the VAF, yes, that is a good place.  Perhaps, specifically, here: The Vault Application Framework Visual Studio Template (m-files.com).  You can also reach out to your partner/reseller to see whether they can provide you with additional support if needed.

And, obviously, you can ask any questions here.

I think you have a typo in your URL.  If you want "greater than 4000 and less than 4001" then it should be:

/REST/objects/102?i>=4000&i<<=4100

To start with the VAF, yes, that is a good place.  Perhaps, specifically, here: The Vault Application Framework Visual Studio Template (m-files.com).  You can also reach out to your partner/reseller to see whether they can provide you with additional support if needed.

And, obviously, you can ask any questions here.

Hello Craig,

Well spotted.  It works now.  Thank you.

Of course, there will be some learning curve for VAF.  But it looks to be worth it.

Have a great weekend!

Martin Leclerc