Add non-trivial Query examples to the API documentation

Vivantio / apisamples

Vivantio Pro / ITSM API Samples

MIT License

2 stars 1 forks source link

Add non-trivial Query examples to the API documentation #1

Open cristobalito opened 7 years ago

cristobalito commented 7 years ago

A number of the API methods take a Query parameter as input. All the examples appear to have a match all query, similar to this one for api/Ticket/Select:

<SelectRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vivantio.Model.Public.Common">
  <Query>
    <Items i:nil="true" />
    <Mode>MatchAny</Mode>
  </Query>
</SelectRequest>

While this is certainly useful, I believe it would also be useful to have some examples for more targeted queries e.g. searching for a particular user by email or similar.

Vivantio commented 7 years ago

We do have a section in the wiki itself which has some more details on querying: https://github.com/Vivantio/apisamples/wiki/Querying

This isn't quite as extensive as we like, but might be a good starting point for you.

For now, if you need further assistance building specific queries, you can email our support team on support@vivantio.com.

cristobalito commented 7 years ago

Thanks - I'd seen that and it was useful. It still think it would be useful to have the information (or a link) located in proximity to the api itself.

Chris

On Mon, Jan 9, 2017 at 1:53 PM Vivantio notifications@github.com wrote:

Reopened #1 https://github.com/Vivantio/apisamples/issues/1.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/Vivantio/apisamples/issues/1#event-915949666, or mute the thread https://github.com/notifications/unsubscribe-auth/AAIlBprPZrVIP8Mot6mtVwF8DGe_LaoGks5rQjvtgaJpZM4LYIvh .