API

System APIs

PUT system/users/{userId}/application-component-filters/{applicationComponentFilterId}

Edits a custom application component filter

HTTP method PUT
URI https://api.rambase.net/system/users/{userId}/application-component-filters/{applicationComponentFilterId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {userId} Owner of this filter
Integer, minimum 100
- URI parameter {applicationComponentFilterId} Unique identifier for user-defined filter
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 5053, version 5

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.

Format:
1
<ApplicationComponentFilter
ApplicationComponentFilter

This field is optional.

>
2
     <Name
Name

Display friendly name for the filter

This field is optional.

>{String}</Name>
3
     <Filter
Filter

The user defined filter

This field is optional.

>{String}</Filter>
4
     <ComponentLookupKey
ComponentLookupKey

The component this filter applies to

This field is optional.

>{String}</ComponentLookupKey>
5
     <SortIndex
SortIndex

Index to sort and reorder filter list.

This field is optional.

>{Integer}</SortIndex>
6
</ApplicationComponentFilter>
1
{
2
     "applicationComponentFilter
ApplicationComponentFilter

This field is optional.

": {
3
          "name
Name

Display friendly name for the filter

This field is optional.

": "{String}",
4
          "filter
Filter

The user defined filter

This field is optional.

": "{String}",
5
          "componentLookupKey
ComponentLookupKey

The component this filter applies to

This field is optional.

": "{String}",
6
          "sortIndex
SortIndex

Index to sort and reorder filter list.

This field is optional.

": "{Integer}"
7
     }
8
}

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.

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. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

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