Filter API Parameters
Parameters are optional unless otherwise noted.
|
Parameter |
Description |
Notes |
|---|---|---|
|
name |
Name of the Filter. Must be unique. |
Required for POST. Maximum of 255 characters. |
|
description |
Description of the Filter. |
Null = yes |
|
changeStamp |
The change stamp of the filter record. Integer. Defaults to 0. |
A changeStamp is required for PUT (update API). changeStamp is returned in GET. |
|
lastupdated |
Last time this row was updated. |
Integer. |
|
ouid |
tbd |
Integer. |
|
scriptContent |
Contains the text of script filter. Only one script filter is allowed per filter. Currently only supports groovy scripts. |
Used only for script filters. Required for POST (create) for script filters. |
|
systemDefined |
True if the filter was preinstalled on Customer Collaboration Platform. | |
|
scriptFileName |
Should be the same as the uploaded script filter file name. |
Used only for script filters. Required for POST (create) for script filters. |
|
type |
The type of filter. Must be one of:
|
Required for POST (create). |