DashboardFilterView

[POST] /api/v2/dashboard/filter-views

Creates document variant.

Request Schema

DashboardFilterViewRequest

Response

Status Code: 200

Success

DashboardFilterViewResponse

Status Code: 400

Bad Request

ServerPluginError

Status Code: 404

Not Found

ServerPluginError

[GET] /api/v2/dashboard/filter-views

Returns a list of document variants without parameters and custom properties.

Parameters

Name	Type	Located In	Description
refDocumentId	string	query	Identifier of a document referenced by a variant

Response

Status Code: 200

Success

DocumentFilterViewModelBase

Status Code: 400

Bad Request

ServerPluginError

Status Code: 404

Not Found

ServerPluginError

[GET] /api/v2/dashboard/filter-views/{id}

Returns a document variant.

Parameters

Name	Type	Located In	Description
idRequired	string	path

Response

Status Code: 200

Success

DocumentFilterViewModel

Status Code: 400

Bad Request

ServerPluginError

Status Code: 404

Not Found

ServerPluginError

[POST] /api/v2/dashboard/filter-views/batch-delete

Removes document variants.

Request Schema

DocumentFilterViewDeleteRequest

Response

Status Code: 204

No Content

Status Code: 400

Bad Request

ServerPluginError

[PUT] /api/v2/dashboard/filter-views/batch-rename

Rename document variants.

Request Schema

DocumentFilterViewRenameRequestItem

Response

Status Code: 204

No Content

Status Code: 400

Bad Request

ServerPluginError

Models

Ƭ DashboardFilterViewResponse

Dashboard Filter View POST Response

Name	Type	Description	Example
idNullable	string	New Dashboard Filter View ID

Ƭ ServerPluginError

Server plugin error

Name	Type	Description	Example
codeNullable	string	error code
messageNullable	string	error message
contextNullable	string	error context

Ƭ DashboardFilterViewRequest

Dashboard Filter View POST Request

Name	Type	Description	Example
name	string	New Filter View Name
refDocumentId	string	Reference Dashboard Id
content	string	FilterView Content

Ƭ DocumentFilterViewModelBase

Dashboard Filter View List GET Response

Name	Type	Description	Example
idNullable	string	Dashboard Filter View ID
nameNullable	string	Dashboard Filter View Name
effectiveOpsNullable	string	Dashboard Filter View Effective Ops
refDocumentIdNullable	string	Dashboard RefDocumentId

Ƭ DocumentFilterViewModel

Dashboard Filter View GET Response

Name	Type	Description	Example
securityNullable	string	Dashboard Filter View Security
contentNullable	string	Dashboard Filter View Content
idNullable	string	Dashboard Filter View ID
nameNullable	string	Dashboard Filter View Name
effectiveOpsNullable	string	Dashboard Filter View Effective Ops
refDocumentIdNullable	string	Dashboard RefDocumentId

Ƭ DocumentFilterViewDeleteRequest

Dashboard Filter View Delete Request

Name	Type	Description	Example
ids	Array<string>	Dashboard Filter View IDs

Ƭ DocumentFilterViewRenameRequestItem

Dashboard Filter View Rename Request Item

Name	Type	Description	Example
id	string	Dashboard Filter View ID
name	string	Dashboard Filter View Name