Skip to main content
POST
Create or replace a report row restriction for a user.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

The body containing required target ProxyUserEmail and accessible ReportName, plus optional RowFilter. A string filter requires non-empty field, operator, and value. An advanced filter requires an operator and at least one condition, with the same validation applied recursively.

Row filter to save as a reusable report restriction.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.ReportRestriction.ApiReportRestrictionSaveRequest, Derivitec.Web.Core
report_name
string | null

Organisation-scoped report-definition name whose user restriction is being changed.

Example:

"Daily risk overview"

proxy_user_email
string | null

Email address of the organisation user targeted by the report action.

Example:

"user@example.com"

row_filter
object

Base selection criterion for a named report-data field.

Response

Created

Response envelope for an attempt to save a report-row restriction.

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