CODEWITHSUNDEEP
asp.net-web-apiodata
Kourosh
Kourosh

Reputation: 789

Queryable Attribute allow to get some properties not all of them

I have a web api 2 application, and in my controller , I have this code :

    [Queryable]
    public IQueryable<Title> GetTitles()
    {
        return db.Titles;
    }

and here is the Title entity :

public partial class Title
{
    public Title()
    {
        this.People = new HashSet<Person>();
    }

    public short Id { get; set; }
    public string NameT { get; set; }

    public virtual ICollection<Person> People { get; set; }
}

When people query the Titles, they must get only "NameT" property. but now they get all of the properties. and yes, I know about $select, but I want another way. means even they use $select, they should not able to get "Id" property for example. if I have to bring more information, please tell me. thanks.

Upvotes: 0

Views: 675

Answers (3)

Schandlich
Schandlich

Reputation: 693

Use the ODataModelBuilder class as opposed to the ODataConventionModelBuilder class.

var modelBuilder = new ODataModelBuilder();

var titles = modelBuilder.EntitySet<Title>("titles");

var title = titles.EntityType;

title.HasKey(x => x.Id);
title.Ignore(x => x.Id);
title.Property(x => x.TName);

titles.HasIdLink(x => { return x.GenerateSelfLink(true); }, true);
config.Routes.MapODataRoute("odata", "odata", modelBuilder.GetEdmModel());

Upvotes: 0

Feng Zhao
Feng Zhao

Reputation: 2995

There are two ways to solve your problem when you use ODataController. However, they won't affect ApiController non-query part.

In that condition, you can try what Zoe suggested.

1.Ignore those properties while building your model with model builder.

builder.EntityType<Title>().Ignore(title => title.Id);

2.Add ignore member attributes on those properties.

[IgnoreDataMember] public short Id { get; set; }

More than these, we provide support for limiting the set of allowed queries in Web API 2.2 for OData v4.0.

http://blogs.msdn.com/b/webdev/archive/2014/03/13/getting-started-with-asp-net-web-api-2-2-for-odata-v4-0.aspx

We can use attributes like Unsortable, NonFilterable, NotExpandable or NotNavigable on the properties of the types in our model, or we can configure this explicitly in the model builder.

Upvotes: 1

zoe
zoe

Reputation: 889

Maybe you can have filter in your action GetTitles(), like:

[Queryable]
public IQueryable<Title> GetTitles()
{
    return db.Titles.Select(t=>t.Name);
}

Upvotes: 0

Related Questions