Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Sage One Documentation to include Queryable Fields and Polling Limitations. #1206

Open
rsbarbo opened this issue Aug 8, 2017 · 0 comments
Assignees
Labels

Comments

@rsbarbo
Copy link
Contributor

rsbarbo commented Aug 8, 2017

Team -

After an into depth conversation with our counter part at Sage, they have confirmed that there are some issues with the where clause and polling due to Sage One API limitations.

i.e. the product REST API does not have full query capabilities, but only allows to add headers constraining return results that allow select fields (e.g. name, last changed) on select resources and limited operations (sometimes = and contains, but not like, >= etc.); similarly, the only default polling resource is set up for customers.

We have also been informed that all the resources support some kind of query capability, however, there are only select fields and operations that can be used and you can find those at the Sage One documentation.

In order to validate the information we have received from our Sage partners, we have tested the query with the following endpoint and where clause:

GET /contacts

search = '(contactNameGoesHere)'

Once you select any of the resources (e.g. Contacts) from https://developer.columbus.sage.com/docs#/us/sageone/accounts, go to “Query Parameters”. The section “Params for collection” shows which fields are available ... the fields imply a certain operator (e.g. contains, equals etc).

We need to make sure we add these queryable fields to our documentation or at least (somehow) render Sage's page with the information (probably not ideal).

Please let me know if you have any questions or concerns, but this ticket should close soba issue #6676

thank you -Rapha Barbo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants