(Web API) Meta-data inclusion and exclusion

Registered by Lars Helge Øverland on 2014-04-22

Sometimes the default views of the meta-data can be a bit much, and it doesn't make sense to include everything if all you need is the id and name. For a long time, we have now had viewClass (basic | detailed | export) which allowed to hide some of the properties. When this is not enough, we now include a more sophisticated system for including and excluding properties (to see what properties are available, please see the schema section).

The format for include/exclude is very simple, and allows for infinite recursion, to filter at the "root" level, you can just use the name of the property, i.e. ?include=id,name which would only display the id and name for every object. For object that are either collections, or is a complex object which have properties on their own, you can use the format ?include=id,name,dataSets[id,name] which would return id, name of the root, and the id and name of every dataSet on that object.

Blueprint information

Status:
Complete
Approver:
Lars Helge Øverland
Priority:
Undefined
Drafter:
Lars Helge Øverland
Direction:
Approved
Assignee:
Morten Olav Hansen
Definition:
Approved
Series goal:
Accepted for trunk
Implementation:
Implemented
Milestone target:
milestone icon 2.15
Started by
Lars Helge Øverland on 2014-04-22
Completed by
Lars Helge Øverland on 2014-04-22

Related branches

Sprints

Whiteboard

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.