Forum Discussion
Inactive User
7 years agoSuzieH Thanks.
The WHERE clause reference seems to be the only place IN and MATCHES are mentioned.
Generally, my frustrations with the documentation are a matter of
- Not being able to find things that I've read in the past but haven't bookmarked. It would be really great if
- Having new information in examples that isn't explained. For example, in the link you added, there's the following:
https://your_community.lithium.com/restapi/vc/search/messages?q=label.text:wireless
- However, that returns an empty set in the browser for me when I use the label Jupiter on Stage, where i know it exists. Which is another issue. A lot of the examples don't actually work in the real world. It's hard to know which ones will and which ones won't.
https://community-stage.jmp.com/restapi/vc/search/messages?q=label.text:Jupiter
<response status="success">
<messages/>
</response> - The doc talks a little about q and f (thank you) but doesn't really say what and where I can find out where I can go to find out if things are fields or not. Also, the example of how to use a field is in the "Optionally specify a field to filter by using the format: q=field_name:text_string, such as subject:stereo" of the q parameter, not at all in the f parameter. Those kind of issues are frequent.
- This is really the only place I've found that mentions the /search/ parameter at all in V1, which is odd since it's common, I think.
- It would be really useful if there were a comprehensive index with links to relevant info.
- It would be great if the TKB link you sent me were on the API info page, for example (https://lithosphere.lithium.com/t5/Developer-Documentation/bd-p/dev-doc-portal?section=communityconcepts)
- It just seems that most of the time I have to ask you or someone else rather than being able to find the answers I need in the documentation itself (and I'm sure I'm not alone). If they were my docs, I would see that as a failure of documentation design for usability. The Community helps support the docs, but I see many others looking for basic information all the time that should be able to be found in the docs. I'd like Lithium's documentation to be more like MDN/Javascript or the slightly less great JQuery documentation. I rarely have to look outside of those for structural answers. Sure, I go to StackOverflow if I can't figure it out, but I can usually find my answers with one of those resources and / or a Google search. I repeatedly find myself in the position with Lithium's docs of "Where do I find an answer???!" ...
- I hope this is helpful. I know things like an index and a structural hierarchy would help many of us find the answer we're looking for rather than having to constantly ask the Community instead. The Community should be for things that aren't easily found in the documentation. Unfortunately, that's a lot of things! :(
SuzieH
7 years agoKhoros Alumni (Retired)
Inactive User the specifics are very useful. Thank you, as always.