-
Notifications
You must be signed in to change notification settings - Fork 3
Metadata requests
Håkon André Knudsen edited this page Sep 25, 2019
·
1 revision
When creating views on top of the RamBase API, it can be useful to know some information about the resource you are using. To get this information we can use metadata requests. Read more about metadata requests at the official RamBase API documentation.
The SDK makes it easy to perform metadata requests. See the following code for an example on how to get metadata for the sales order list endpoint:
Metadata response = await api.GetMetadataAsync("sales/orders", ApiResourceVerb.GET);
The Metadata class contains parameters for Admittance, Fields, FilterFields, SortableFields and NamedFilters.
One use case for this is creating filter builders for list views. Or showing which columns are sortable in a table.