[]
        
(Showing Draft Content)

DashboardFilterView

DashboardFilterView

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

Creates document variant.

Request Body

Description: Document variant creation request model.

Type: application/json

DashboardFilterViewRequest

Responses

[200] Success

DashboardFilterViewResponse

Type: [application/json]

[400] Bad Request

ServerPluginError

Type: [application/json]

[404] Not Found

ServerPluginError

Type: [application/json]

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

Parameters

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

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

Responses

[200] Success

DocumentFilterViewModelBase

Type: [application/json]

[400] Bad Request

ServerPluginError

Type: [application/json]

[404] Not Found

ServerPluginError

Type: [application/json]

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

Parameters

Name In Type
idRequired path string

Returns a document variant.

Responses

[200] Success

DocumentFilterViewModel

Type: [application/json]

[400] Bad Request

ServerPluginError

Type: [application/json]

[404] Not Found

ServerPluginError

Type: [application/json]

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

Removes document variants.

Request Body

Type: application/json

DocumentFilterViewDeleteRequest

Responses

[204] No Content

[400] Bad Request

ServerPluginError

Type: [application/json]

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

Rename document variants.

Request Body

Description: List of DocumentFilterViewRenameRequestItem

Type: application/json

DocumentFilterViewRenameRequestItem

Responses

[204] No Content

[400] Bad Request

ServerPluginError

Type: [application/json]

Models

Ƭ DashboardFilterViewResponse

Dashboard Filter View POST Response

Name Type Description
idNullable string New Dashboard Filter View ID

Ƭ ServerPluginError

Server plugin error

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

Ƭ DashboardFilterViewRequest

Dashboard Filter View POST Request

Name Type Description
nameRequired string New Filter View Name
refDocumentIdRequired string Reference Dashboard Id
contentRequired string FilterView Content

Ƭ DocumentFilterViewModelBase

Dashboard Filter View List GET Response

Name Type Description
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
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
idsRequired Array<string> Dashboard Filter View IDs

Ƭ DocumentFilterViewRenameRequestItem

Dashboard Filter View Rename Request Item

Name Type Description
idRequired string Dashboard Filter View ID
nameRequired string Dashboard Filter View Name