Model Filter Values

Index

get

Pagination

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

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

• filter

• filter_count

• filterExists

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.

• filter_id

• model_type

• model_id

• filter.model_type

• filter.model_id

• does_not_belong_to_deleted_step

Available Sorts

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

• filter_id

Authorizations

ApiKeyAuth

Query parameters

filter[filter_id]stringOptional

Filter results by filter_id.

filter[model_type]stringOptional

Filter results by model_type.

filter[model_id]stringOptional

Filter results by model_id.

filter[filter.model_type]stringOptional

Filter results by filter.model_type.

filter[filter.model_id]stringOptional

Filter results by filter.model_id.

filter[does_not_belong_to_deleted_step]stringOptional

Filter results by does_not_belong_to_deleted_step.

filter[model]stringOptional

Filter results by model.

includestringOptional

Comma-separated list of relationships to include. Available: filter

sortstringOptional

Sort field. Prefix with - for descending. Available: filter_id

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/model-filter-values

HTTPcURLJavaScriptPython

GET /api/v1/model-filter-values HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "model_type": "example_model_type",
      "model_id": 1,
      "filter_id": 1,
      "value": "example_value",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "filter": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/model-filter-values",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/model-filter-values?page=1",
    "last": "https://api.example.com/api/v1/model-filter-values?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
model_type	string	☑
model_id	integer	☑
filter_id	integer	☑
value	string	☑

Authorizations

ApiKeyAuth

Body

application/json

model_typestringRequired

model_idintegerRequired

filter_idintegerRequired

valuestring · max: 1024Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/model-filter-values

HTTPcURLJavaScriptPython

POST /api/v1/model-filter-values HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "model_type": "example_model_type",
  "model_id": 1,
  "filter_id": 1,
  "value": "example_value"
}

{
  "data": {
    "id": 1,
    "model_type": "example_model_type",
    "model_id": 1,
    "filter_id": 1,
    "value": "example_value",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "filter": {}
  }
}

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
filter_id	integer
value	string

Authorizations

ApiKeyAuth

Path parameters

model_filter_valuestringRequired

The model filter value identifier.

Body

application/json

filter_idintegerOptional

valuestring · max: 1024Optional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/model-filter-values/{model_filter_value}

HTTPcURLJavaScriptPython

PUT /api/v1/model-filter-values/{model_filter_value} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "filter_id": 1,
  "value": "example_value"
}

{
  "data": {
    "id": 1,
    "model_type": "example_model_type",
    "model_id": 1,
    "filter_id": 1,
    "value": "example_value",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "filter": {}
  }
}

Destroy

delete

Delete a model filter value.

Authorizations

ApiKeyAuth

Path parameters

model_filter_valuestringRequired

The model filter value identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/model-filter-values/{model_filter_value}

HTTPcURLJavaScriptPython

DELETE /api/v1/model-filter-values/{model_filter_value} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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