پرش به محتویات

قابلیت کوئری (ODATA)

معرفی ODATA

ODATA (Open Data Protocol) یک پروتکل وب استاندارد است که برای ایجاد و استفاده از APIهای RESTful استفاده می‌شود. این پروتکل توسط مایکروسافت توسعه یافته و اکنون توسط سازمان OASIS استاندارد شده است. ODATA به شما این امکان را می‌دهد که داده‌ها را به‌صورت منظم و استاندارد از سرویس‌های وب دریافت و مدیریت کنید.

ODATA با استفاده از HTTP و JSON یا XML برای فرمت داده‌ها، به مشتریان اجازه می‌دهد تا داده‌ها را از سرورهای داده واکشی کنند و عملیات مختلفی مانند فیلتر کردن، مرتب‌سازی، گروه‌بندی، و غیره را بر روی داده‌ها انجام دهند.

ODATA قابلیت‌های زیادی برای فیلتر کردن، مرتب‌سازی و مدیریت داده‌ها دارد. در زیر چند مورد از قابلیت‌های مهم ODATA برای کوئری زدن معرفی شده است:

فیلتر کردن داده‌ها ($filter)

با استفاده از پارامتر $filter، می‌توانید داده‌ها را بر اساس شرایط خاصی فیلتر کنید.

مثال:
Products?$filter=Price gt 20/ این کوئری تمام محصولاتی را که قیمت آن‌ها بیشتر از 20 است برمی‌گرداند.

مرتب‌سازی داده‌ها ($orderby)

با استفاده از $orderby می‌توانید داده‌ها را بر اساس یک یا چند ویژگی مرتب کنید.

مثال:
Products?$orderby=Price desc/
این کوئری محصولات را بر اساس قیمت به ترتیب نزولی مرتب می‌کند.

تعیین تعداد رکوردهای بازگشتی ($top و $skip)

با استفاده از $top و $skip می‌توانید تعداد مشخصی از رکوردها را واکشی کنید و رکوردهایی را که نمی‌خواهید نمایش داده شوند، رد کنید.

مثال:
Products?$top=5&$skip=10/
این کوئری 5 محصول را پس از رد کردن 10 محصول اول باز می‌گرداند.

انتخاب ویژگی‌های خاص ($select)

اگر به همه ویژگی‌های یک موجودیت نیاز ندارید، می‌توانید فقط ویژگی‌های مورد نظر خود را انتخاب کنید.

مثال:
Products?$select=Name,Price/
این کوئری فقط نام و قیمت محصولات را برمی‌گرداند.