Filters

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

• type

• field

• comparison

• model_type

• model_id

• location

• is_default

• keep_matching

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

• type

• field

• comparison

Authorizations

ApiKeyAuth

Query parameters

filter[type]stringOptional

Filter results by type.

filter[field]stringOptional

Filter results by field.

filter[comparison]stringOptional

Filter results by comparison.

filter[model_type]stringOptional

Filter results by model_type.

filter[model_id]stringOptional

Filter results by model_id.

filter[location]stringOptional

Filter results by location.

filter[is_default]stringOptional

Filter results by is_default.

filter[keep_matching]stringOptional

Filter results by keep_matching.

sortstringOptional

Sort field. Prefix with - for descending. Available: type, field, comparison

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/filters

HTTPcURLJavaScriptPython

GET /api/v1/filters HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "type": "example_type",
      "comparison": "example_comparison",
      "value": "example_value",
      "value_type": "example_value_type",
      "keep_matching": "example_keep_matching",
      "operator_logic": "example_operator_logic",
      "match_order": "example_match_order",
      "is_default": "example_is_default",
      "location": "example_location",
      "model_type": "example_model_type",
      "model_id": 1,
      "date_format": "example_date_format",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "field": "example_field"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/filters",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/filters?page=1",
    "last": "https://api.example.com/api/v1/filters?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
type	string	☑
field	string	☑
comparison	string	☑
value
value_type	string
keep_matching		☑
operator_logic
match_order
is_default
location	string
model_type	string	☑
model_id	integer	☑
date_format	string

Authorizations

ApiKeyAuth

Body

application/json

typestringRequired

comparisonstringRequired

valuestring · max: 1024 · nullableOptional

value_typestring · nullableOptional

keep_matchingstringRequired

operator_logicstring · nullableOptional

match_orderstringOptional

is_defaultstringOptional

locationstring · nullableOptional

model_typestringRequired

model_idintegerRequired

date_formatstring · nullableOptional

fieldstring · min: 1Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/filters

HTTPcURLJavaScriptPython

POST /api/v1/filters HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 404

{
  "type": "example_type",
  "comparison": "example_comparison",
  "value": "example_value",
  "value_type": "example_value_type",
  "keep_matching": "example_keep_matching",
  "operator_logic": "example_operator_logic",
  "match_order": "example_match_order",
  "is_default": "example_is_default",
  "location": "example_location",
  "model_type": "example_model_type",
  "model_id": 1,
  "date_format": "example_date_format",
  "field": "example_field"
}

{
  "data": {
    "id": 1,
    "type": "example_type",
    "comparison": "example_comparison",
    "value": "example_value",
    "value_type": "example_value_type",
    "keep_matching": "example_keep_matching",
    "operator_logic": "example_operator_logic",
    "match_order": "example_match_order",
    "is_default": "example_is_default",
    "location": "example_location",
    "model_type": "example_model_type",
    "model_id": 1,
    "date_format": "example_date_format",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "field": "example_field"
  }
}

Show

get

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

• type

• field

• comparison

• model_type

• model_id

• location

• is_default

• keep_matching

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

• type

• field

• comparison

Authorizations

ApiKeyAuth

Path parameters

filterstringRequired

The filter identifier.

Query parameters

filter[type]stringOptional

Filter results by type.

filter[field]stringOptional

Filter results by field.

filter[comparison]stringOptional

Filter results by comparison.

filter[model_type]stringOptional

Filter results by model_type.

filter[model_id]stringOptional

Filter results by model_id.

filter[location]stringOptional

Filter results by location.

filter[is_default]stringOptional

Filter results by is_default.

filter[keep_matching]stringOptional

Filter results by keep_matching.

sortstringOptional

Sort field. Prefix with - for descending. Available: type, field, comparison

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/filters/{filter}

HTTPcURLJavaScriptPython

GET /api/v1/filters/{filter} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "type": "example_type",
    "comparison": "example_comparison",
    "value": "example_value",
    "value_type": "example_value_type",
    "keep_matching": "example_keep_matching",
    "operator_logic": "example_operator_logic",
    "match_order": "example_match_order",
    "is_default": "example_is_default",
    "location": "example_location",
    "model_type": "example_model_type",
    "model_id": 1,
    "date_format": "example_date_format",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "field": "example_field"
  }
}

Update

put

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
type	string
field	string
comparison	string
value
value_type	string
keep_matching
operator_logic
match_order
is_default
location	string
date_format	string

Authorizations

ApiKeyAuth

Path parameters

filterstringRequired

The filter identifier.

Body

application/json

typestringOptional

comparisonstringOptional

valuestring · max: 1024Optional

value_typestring · nullableOptional

keep_matchingstringOptional

operator_logicstring · nullableOptional

match_orderstringOptional

is_defaultstringOptional

locationstring · nullableOptional

date_formatstring · nullableOptional

fieldstring · min: 1Optional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/filters/{filter}

HTTPcURLJavaScriptPython

PUT /api/v1/filters/{filter} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 357

{
  "type": "example_type",
  "comparison": "example_comparison",
  "value": "example_value",
  "value_type": "example_value_type",
  "keep_matching": "example_keep_matching",
  "operator_logic": "example_operator_logic",
  "match_order": "example_match_order",
  "is_default": "example_is_default",
  "location": "example_location",
  "date_format": "example_date_format",
  "field": "example_field"
}

{
  "data": {
    "id": 1,
    "type": "example_type",
    "comparison": "example_comparison",
    "value": "example_value",
    "value_type": "example_value_type",
    "keep_matching": "example_keep_matching",
    "operator_logic": "example_operator_logic",
    "match_order": "example_match_order",
    "is_default": "example_is_default",
    "location": "example_location",
    "model_type": "example_model_type",
    "model_id": 1,
    "date_format": "example_date_format",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "field": "example_field"
  }
}

Destroy

delete

Delete a filter.

Authorizations

ApiKeyAuth

Path parameters

filterstringRequired

The filter identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/filters/{filter}

HTTPcURLJavaScriptPython

DELETE /api/v1/filters/{filter} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "message": "Action completed successfully."
}