Model Variables

List Model Variables

get

Retrieves a paginated list of variables 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

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Query parameters

filter[variable_id]stringOptional

Filter results by variable_id.

filter[model_type]stringOptional

Filter results by model_type.

filter[model_id]stringOptional

Filter results by model_id.

includestringOptional

Comma-separated list of relationships to include. Available: model, variable

sortstringOptional

Sort field. Prefix with - for descending. Available: variable_id, model_type, model_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-variables

HTTPcURLJavaScriptPython

GET /api/v1/model-variables HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "variable_id": 1,
      "alias": "example_alias",
      "configurable": "example_configurable",
      "required": "example_required",
      "advanced": "example_advanced",
      "model_type": "example_model_type",
      "model_id": 1,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "variable": {},
      "modified": "example_modified"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/model-variables",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/model-variables?page=1",
    "last": "https://api.example.com/api/v1/model-variables?page=1",
    "prev": null,
    "next": null
  }
}

Create Model Variable

post

Creates a new variable association 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

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Body

application/json

variable_idstringRequired

aliasstring · nullableOptional

configurablestringOptional

requiredstringOptional

advancedstringOptional

model_typestringRequired

model_idstringRequired

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/model-variables

HTTPcURLJavaScriptPython

POST /api/v1/model-variables HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "variable_id": "text",
  "alias": "text",
  "configurable": "text",
  "required": "text",
  "advanced": "text",
  "model_type": "text",
  "model_id": "text"
}

{
  "data": {
    "id": 1,
    "variable_id": 1,
    "alias": "example_alias",
    "configurable": "example_configurable",
    "required": "example_required",
    "advanced": "example_advanced",
    "model_type": "example_model_type",
    "model_id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "variable": {},
    "modified": "example_modified"
  }
}

Get Model Variable

get

Retrieves the details of a specific model variable. Note: Model variables, filter values, and notes can all be attached to different entity types via model_type and model_id.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

model_variablestringRequired

The model variable identifier.

Query parameters

filter[variable_id]stringOptional

Filter results by variable_id.

filter[model_type]stringOptional

Filter results by model_type.

filter[model_id]stringOptional

Filter results by model_id.

includestringOptional

Comma-separated list of relationships to include. Available: model, variable

sortstringOptional

Sort field. Prefix with - for descending. Available: variable_id, model_type, model_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-variables/{model_variable}

HTTPcURLJavaScriptPython

GET /api/v1/model-variables/{model_variable} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "variable_id": 1,
    "alias": "example_alias",
    "configurable": "example_configurable",
    "required": "example_required",
    "advanced": "example_advanced",
    "model_type": "example_model_type",
    "model_id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "variable": {},
    "modified": "example_modified"
  }
}

Update Model Variable

put

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

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

model_variablestringRequired

The model variable identifier.

Body

application/json

aliasstring · nullableOptional

configurablestringOptional

requiredstringOptional

advancedstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/model-variables/{model_variable}

HTTPcURLJavaScriptPython

PUT /api/v1/model-variables/{model_variable} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "alias": "text",
  "configurable": "text",
  "required": "text",
  "advanced": "text"
}

{
  "data": {
    "id": 1,
    "variable_id": 1,
    "alias": "example_alias",
    "configurable": "example_configurable",
    "required": "example_required",
    "advanced": "example_advanced",
    "model_type": "example_model_type",
    "model_id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "variable": {},
    "modified": "example_modified"
  }
}

Delete Model Variable

delete

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

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

model_variablestringRequired

The model variable identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/model-variables/{model_variable}

HTTPcURLJavaScriptPython

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

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