Skip to main content
POST
Create 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 Name and non-null polymorphic Filter definition; Description is optional. EntityType is PositionFilter.

Name, description, and rule definition used to create an active custom position filter.

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

Client-visible name used to identify the new configurable entity.

description
string | null

Client-visible description for the new configurable entity.

filter
object

Base selection criterion for a named report-data field.

Response

Created

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

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