Skip to main content
POST
Delete 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.

Selection of an owned custom position filter to delete.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.PositionFilters.ApiPositionFilterDeleteRequest, Derivitec.Web.Core
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"

Response

Returns deletion success, or missing identifier and non-owner or unavailable-filter errors in the response envelope.

Success state and errors returned after attempting to delete a custom position filter.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.PositionFilters.ApiPositionFilterDeleteResponse, 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.