System APIs
Creates a new custom application component filter
| HTTP method | POST |
| URI | https://api.rambase.net/system/users/{userId}/application-component-filters |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {userId} |
Owner of this filter
Integer, minimum 100 |
| Successful HTTP status code | 201 |
| API resource identifier | 5052, version 4 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
Name
Required/mandatory field
Display friendly name for the filter
>{String}</Name>Filter
Required/mandatory field
The user defined filter
>{String}</Filter>ComponentLookupKey
Required/mandatory field
The component this filter applies to
>{String}</ComponentLookupKey>Name
Required/mandatory field
Display friendly name for the filter
": "{String}",Filter
Required/mandatory field
The user defined filter
": "{String}",ComponentLookupKey
Required/mandatory field
The component this filter applies to
": "{String}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
ApplicationComponentFilterId
Unique identifier for user-defined filter
>{Integer}</ApplicationComponentFilterId>CreatedAt
Automatically generated timestamp field maintained by the execution engine (when a filter entity is created)
>{Datetime}</CreatedAt>Name
Display friendly name for the filter
>{String}</Name>Filter
The user defined filter
>{String}</Filter>ComponentLookupKey
The component this filter applies to
>{String}</ComponentLookupKey>SortIndex
Index to sort and reorder filter list.
>{Integer}</SortIndex>ApplicationComponentFilterId
Unique identifier for user-defined filter
": "{Integer}",CreatedAt
Automatically generated timestamp field maintained by the execution engine (when a filter entity is created)
": "{Datetime}",Name
Display friendly name for the filter
": "{String}",Filter
The user defined filter
": "{String}",ComponentLookupKey
The component this filter applies to
": "{String}",SortIndex
Index to sort and reorder filter list.
": "{Integer}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 106901 HTTP 400 | FilterId was not found. |
| Error 106917 HTTP 400 | You can only access your own filters |
| Error 106904 HTTP 400 | ComponentAppMatch is missing. Cannot create new filter. |
| Error 106905 HTTP 400 | New filters must have a name. |
| Error 106902 HTTP 400 | Filter cannot be empty |