Skip to main content
POST
Update a position filter.

Authorizations

Authorization
string
header
required

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.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.PositionFilters.ApiPositionFilterUpdateRequest, Derivitec.Web.Core
new_name
string | null

Replacement client-visible name for the selected configurable entity.

new_description
string | null

Replacement client-visible description for the selected configurable entity.

is_active
boolean

Replacement lifecycle state: true keeps the entity available and false deactivates it.

name
string | null

Name of the entity to select within the request's entity category. The value must not be null or empty.

Example:

"Example entity"

filter
object

Base selection criterion for a named report-data field.

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.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.PositionFilters.ApiPositionFilterUpdateResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.