Application Programming Interface Guide > Web Services Operations > Recurring Element Structures > Filter Policy Definition
 
Filter Policy Definition
A policy element contains a filter policy definition. The definition has the following format:
name: The short name of the filter policy.
folder: The folder path of the procedure to create to implement the policy.
enabled: Whether the policy is enabled or disabled.
form: Whether the filter policy is specified in tabular form (FORM) or using explicit SqlScript code (CODE).
policyGroup (optional):
joinType: INNER, OUTER or UNION.
policyList (may be optional): List of policy procedure paths.
policyProcedurePath (optional): Path to a policy procedure.
defaultRule (optional): For FORM policies, the default rule to follow if no users or groups match the current user.
filter: ALL (all rows), NONE (no rows), PREDICATE (SQL predicate), or PROCEDURE (predicate computed by procedure).
data (optional): For PREDICATE, the SQL text to be used. For PROCEDURE, the path of the procedure to invoke.
memberRuleList: For FORM policies, list of rules to apply when user or group criteria match. For each:
memberRule (optional): Name of rule.
member: The user or group to which the rule applies.
domain: The user/group domain.
name: The user/group name.
type: USER or GROUP.
filter: ALL (all rows), NONE (no rows), PREDICATE (SQL predicate), or PROCEDURE (predicate computed by procedure).
data (optional): For PREDICATE, the SQL text to use. For PROCEDURE, the path of the procedure to invoke.
assignmentList: List of assignments:
assignment (optional)
notes (optional): Any notes or descriptive text.