Update a position filter.
Use this operation as the owner to replace a filter’s name, description, active state, and optionally its
definition. A null Filter retains the existing definition. A replacement name cannot collide with
another accessible filter, and changes complete before returning.
Authorizations
OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header
Body
Required non-blank EntityId in the Risk Portal position-filter identifier namespace; replacement NewName, NewDescription, and IsActive; optional Filter. No explicit non-blank check is made for NewName; EntityType is fixed to PositionFilter.
Replacement display details, active state, and optional rule definition for an owned position filter.
Derivitec.Web.Core.PositionFilters.ApiPositionFilterUpdateRequest, Derivitec.Web.Core Replacement client-visible name for the selected configurable entity.
Replacement client-visible description for the selected configurable entity.
Replacement lifecycle state: true keeps the entity available and false deactivates it.
Name of the entity to select within the request's entity category. The value must not be null or empty.
"Example entity"
Base selection criterion for a named report-data field.
- Option 1
- Option 2
- Option 3
- Option 4
Response
Returns the update result, including missing identifier, non-owner or unavailable-filter, and duplicate-name errors.
Success state and errors returned after attempting to update a custom position filter.
Derivitec.Web.Core.PositionFilters.ApiPositionFilterUpdateResponse, Derivitec.Web.Core Whether the operation completed successfully. The default is true; error outcomes set it to false.
true
Messages explaining operation-level failures. The collection is empty by default.