Grid Filters admin API Resource

Grid Filters admin API

GET /api/admin/filters/grid/json

Get all filters

Response Body
media type data type description
application/json array of HdcUserFilterTO (JSON) JSON Response with filter data

Example of response:

Example

Request
GET /api/admin/filters/grid/json
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "isDefault" : true,
  "ownerFullName" : "...",
  "filterData" : "...",
  "isOwner" : true,
  "classId" : 12345,
  "userId" : 12345,
  "filterId" : 12345,
  "name" : "..."
} ]

POST /api/admin/filters/grid/json

add new filter for user

Request Body
media type data type description
application/json HdcUserFilterTO (JSON) - grid filter data
Response Body
media type data type description
application/json HdcUserFilterTO (JSON) JSON Response with description of filter with unique ID

Example

Request
POST /api/admin/filters/grid/json
Content-Type: application/json
Accept: application/json

                
{
  "isDefault" : true,
  "ownerFullName" : "...",
  "filterData" : "...",
  "isOwner" : true,
  "classId" : 12345,
  "userId" : 12345,
  "filterId" : 12345,
  "name" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "isDefault" : true,
  "ownerFullName" : "...",
  "filterData" : "...",
  "isOwner" : true,
  "classId" : 12345,
  "userId" : 12345,
  "filterId" : 12345,
  "name" : "..."
}

POST /api/admin/filters/grid/assign/{filterId}

Assign user to filter

Request Parameters
name type description constraints
filterId path Id of filter long
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information if operation succeeded

Example

Request
POST /api/admin/filters/grid/assign/{filterId}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

DELETE /api/admin/filters/grid/json/{filterId}

delete user filter

Request Parameters
name type description constraints
filterId path - id of filter long
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information if operation succeeded

Example

Request
DELETE /api/admin/filters/grid/json/{filterId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

POST /api/admin/filters/grid/unassign/{filterId}

Unassign user to filter

Request Parameters
name type description constraints
filterId path Id of filter long
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information if operation succeeded

Example

Request
POST /api/admin/filters/grid/unassign/{filterId}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }