Configuring Bound Functions
The framework supports configuring functions that are bound to entities. A function bound to an entity is invoked on an instance of the entity. In OData protocol, an bound function is considered to be an operation that does not change the state of an entity instance on which it is invoked. After the bound function is configured, it is invoked by a GET request to the URL:
<Domain Root>/<Entity Set>(<key>)/<Bound Function Name>(<param1>=<value1>, <param2>=<value2>)
 |
When you implement custom functions ensure that the function does not create, update, or delete data. The function should only read and retrieve data. Functions that write or update data can cause unexpected data creation or modification in Windchill.
|
A bound function is configured in the same way as an unbound function except the following differences:
• A bound function is specified in the functions collection property in the <Entity JSON> file.
• While specifying the function in the <Entity JSON> file, the property includeInServiceDocument is not applicable to bound functions. This is because bound functions cannot be included in the service document available at the domain root.
• The first parameter in the function specification is called the binding parameter. The parameter must be of the same type as the entity that is bound to the function.
• The function names defined in the import.js file start with function_.