CSESoftware.OData
3.0.0-beta03
This is a prerelease version of CSESoftware.OData.
dotnet add package CSESoftware.OData --version 3.0.0-beta03
NuGet\Install-Package CSESoftware.OData -Version 3.0.0-beta03
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CSESoftware.OData" Version="3.0.0-beta03" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CSESoftware.OData" Version="3.0.0-beta03" />
<PackageReference Include="CSESoftware.OData" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add CSESoftware.OData --version 3.0.0-beta03
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: CSESoftware.OData, 3.0.0-beta03"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package CSESoftware.OData@3.0.0-beta03
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=CSESoftware.OData&version=3.0.0-beta03&prerelease
#tool nuget:?package=CSESoftware.OData&version=3.0.0-beta03&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
CSESoftware.OData
Library to convert Open Data REST API queries into queries for CSESoftware.Repository.
Example use in an API Controller
private readonly IODataRepository _openDataRepository;
public TimesheetController(IODataRepository openDataRepository)
{
_openDataRepository = openDataRepository;
}
[HttpGet]
public async Task<IActionResult> Query([FromQuery]ODataFilter queryOptions)
{
// Calls CSESoftware.Repository with parameters from ODataFilter
var data = await _openDataRepository.GetEntities<Timesheet>(queryOptions);
// Todo do your mapping to view model here
// Start building your response
var responseBuilder = new ResponseBuilder<Timesheet>().WithData(data);
if (queryOptions.Count == true) // Add total and response count if requested
{
var totalCount = await _openDataRepository.GetTotalCount<Timesheet>(queryOptions); // Gets the total count without pagination
responseBuilder.WithCount(totalCount);
}
if (queryOptions.Links == true) // Add HATEOS links if requested
responseBuilder.WithLinksForPagination(HttpContext.Current.Request.Url.AbsoluteUri, HttpContext.Request.Method, queryOptions.Skip, queryOptions.Take);
return Ok(responseBuilder.Build());
}
Accepted query string parameters and definition
| Parameter | Type | Definition |
|---|---|---|
| $top | int | How many entities to return (page size) |
| $skip | int | How many entities to skip (page number = ($skip / $top) + 1) |
| $filter | string | What to filter the results by |
| $orderBy | string | What column to order by first |
| $thenBy | string | What column to order by second |
| $expand | string | Expand these foreign relations |
| $count | bool | Should the response contain the total count of entities |
| $links | bool | Should the response contain HATEOS links |
Filter Operations
| Filter operation | Example | Explanation |
|---|---|---|
| Equal | user?$filter=createdBy eq 'KWP' | Query on User to find createdBy that equals 'KWP' |
| Less than | user?$filter=percent lt 100 | Returns all users with percent less than 100 |
| Greater than | user?$filter=id gt 1500 <br> user?$filter=createdDate gt 2020-04-23T03:52:37.00Z | Returns users of ID 1501 and higher <br> Can be used on dates as well. |
| Greater than or equal to | user?$filter=id ge 1500 | Returns users of ID 1500 and higher |
| Less than or equal to | user?$filter=id le 1300 | Returns users of ID 1300 and lower |
| Different from (not equal) | user?$filter=city ne 'PEORIA' | Returns all users who's city is not "PEORIA" |
| And | user?$filter=percent gt 25 and city ne 'PEORIA' | Returns all users who's city is not "PEORIA" and who's percent is 26 and higher |
| Or | user?$filter=city eq 'PEORIA' or city eq 'DENVER' | Returns all users with city of either "PEORIA" or "DENVER" |
| Select a range of values | user?$filter=percent gt 40 and percent lt 70 | Returns all users with percent values from 40-70 |
| Contains | user?$filter=contains(name, 'Cameron') | Returns all users who's name contains "Cameron" |
| Any | user?$filter=timesheets/any() <br> user?$filter=timesheets/any(t:t/Id gt 73) | Returns all users who have any timesheets <br> Returns all users who have a timesheet with an Id greater than 73 |
| All | user?$filter=timesheets/all(t:t/Id gt 73) | Returns all users who's timesheets all have an Id greater than 73 |
Other Operations
| Operation | Example | Explanation |
|---|---|---|
| Top (page size) | user?$top=2 | Gets the first two results from the user request |
| Skip | user?$skip=4 | Get all users, except the first 4 <br> Can be combined with $top to get pages of results |
| Order by | user?$orderby=name desc | Returns all users ordered by name in descending order |
| Then by | user?$orderby=city&$thenby=name | Returns all users ordered by city then ordered by name |
| Expand | timesheet?$expand=project <br> timesheet?$expand=project,employee/department | Includes the project object with each timesheet <br> Includes the project, employee, and the employee's department with each timesheet |
| Count | user?$count=true | Includes the total count entities in the response |
| Links | user?$links=true | Includes HATEOS links in the response |
CSE Software Inc. is a privately held company founded in 1990. CSE develops software, AR/VR, simulation, mobile, and web technology solutions. The company also offers live, 24x7, global help desk services in 110 languages. All CSE teams are U.S. based with experience in multiple industries, including government, military, healthcare, construction, agriculture, mining, and more. CSE Software is a certified women-owned small business. Visit us online at csesoftware.com.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- CSESoftware.Core (>= 3.0.0-beta03)
- CSESoftware.Repository (>= 3.0.0-beta03)
- Microsoft.AspNetCore.Mvc.Core (>= 2.2.5)
- Newtonsoft.Json (>= 13.0.3)
- System.Linq.Dynamic.Core (>= 1.7.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.