How to expose a view in the API
FollowTo expose a view as an API method:
- Create or select a view. If the method needs to read data, then create or select a view of type Table, otherwise, select a view of type Edit if the method should write data
- Click on Options
- Check the Expose this view as API box
If you are using SOAP API, the WSDL will be automatically updated to include this new method with the definition of the fields, as well as of any filters and operations
Data-reading method
Insert in the view the fields that you want to be returned. If a filter view is also associated with the table view, the fields inserted in the filter view can be used as filter parameters.
Data-writing method
You must include in the view all the data that you want to make editable by the web service. As of now, only the insertion and modification via the Upsert command is supported, and there is no delete option.
Comments
0 comments
Please sign in to leave a comment.