POST/desk/api/v2/search/filters/{collection}.json

Create a new search filter.

Path Params

  • Name
    collection
    Type
    integer
    required
    Description

Body Params

SearchFilter represents a SearchFilter.

    • Name
      collection
      Type
      string
    • Name
      conditions
      Type
      string
    • Name
      createdAt
      Type
      string
      Description
      CreatedAt is a read-only date marking the creation time.
    • Name
      createdBy
      Type
      object
    • Name
      deletedAt
      Type
      string
      Description
      DeletedAt is a read-only date marking the time of deletion. Is only returned when the object is marked as deleted.
    • Name
      deletedBy
      Type
      object
    • Name
      description
      Type
      string
    • Name
      filter_args
      Type
      object
      Description
      RequestCommons allows specifying paging and sorting options. All API endpoints should embed the RequestOrder for consistency.
    • Name
      id
      Type
      integer
    • Name
      isShared
      Type
      boolean
    • Name
      name
      Type
      string
    • Name
      state
      Type
      string
      Description
      State is the status of the object. Typically this will be either active or deleted. When deleted the `deletedAt` and `deletedBy` relationship will be returned.
    • Name
      updatedAt
      Type
      string
      Description
      UpdatedAt is a read-only date marking the last updated time. This field is not updated when the object is deleted.
    • Name
      updatedBy
      Type
      object

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
      SearchFilter represents a SearchFilter.
    • Code
      304
      Description
      304 Not Modified No Data
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

    Examples

    200 OK

    SearchFilter
    {
  "collection": "string",
  "conditions": "string",
  "createdAt": "2024-07-26T20:26:26.473Z",
  "createdBy": {
    "delete": true,
    "id": 0,
    "meta": {},
    "type": 0
  },
  "deletedAt": "2024-07-26T20:26:26.473Z",
  "deletedBy": {
    "delete": true,
    "id": 0,
    "meta": {},
    "type": 0
  },
  "description": "string",
  "filter_args": {
    "aggregate": {
      "Distinct": true,
      "Field": "string",
      "Operation": "string"
    },
    "bulkDryExecute": true,
    "fields": [
      "string"
    ],
    "filter": [
      "string"
    ],
    "id": 0,
    "ids": [
      0
    ],
    "includes": [
      "string"
    ],
    "orderBy": "string",
    "orderMode": "asc",
    "page": 0,
    "pageOffset": 0,
    "pageSize": 0,
    "skipAggregation": true
  },
  "id": 0,
  "isShared": true,
  "name": "string",
  "state": "string",
  "updatedAt": "2024-07-26T20:26:26.473Z",
  "updatedBy": {
    "delete": true,
    "id": 0,
    "meta": {},
    "type": 0
  }
}
    Download Swagger