Adding a reference to an Entity filter
To use an Entity filter in a Web API, you must first add a reference to the filter, in the same way that you would add references to an assembly.
To add a reference to an Entity filter
- Select Web API -> Manage references. The Modify Assembly References dialog box opens.
- Select the Entity filter you want to use in your Web API.
note
Not all Entity filters can be referenced. See Limitations for more details.
Exporting Web APIs with referenced Entity filters
When a filter has been referenced it will be automatically included when the Web API is exported, and it will be prevented from deletion. If the filter is modified, a warning will appear declaring that the filter is used in a Web API and that modifying it may require modification of the Web API(s) referring to it.
For more information, see Using Entity filters in Web APIs.
Limitations
There are some limitations regarding which Entity filters can be referenced from a Web API. These limitations come from the fact that not all Entity types have corresponding types available in the iCore public API. If a filter contains an unsupported column, parameter, or part it will be unavailable in the list of selectable filters in the Manage References dialog in the Web API editor. If you click on such a filter, the details view on the right will contain information about why the filter is not referable.
The following entity types are not currently supported:
- Attached Machine
- Audit Log
- System Queues
- Custom filters with an "All" part