Model Filter Values

List Model Filter Values

get

Retrieves a paginated list of filter values associated with a model. Note: Model variables, filter values, and notes can all be attached to different entity types via model_type and model_id.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

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

GET /api/v1/model-filter-values HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
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
  }
}

Create Model Filter Value

post

Creates a new filter value for a model. Note: Model variables, filter values, and notes can all be attached to different entity types via model_type and model_id.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Body

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

POST /api/v1/model-filter-values HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
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 Model Filter Value

put

Updates an existing model filter value. Note: Model variables, filter values, and notes can all be attached to different entity types via model_type and model_id.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

model_filter_valuestringRequired

The model filter value identifier.

Body

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}

PUT /api/v1/model-filter-values/{model_filter_value} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
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": {}
  }
}

Delete Model Filter Value

delete

Permanently deletes a specific model filter value. Note: Model variables, filter values, and notes can all be attached to different entity types via model_type and model_id.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

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}

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

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