{
  "openapi": "3.0.1",
  "info": {
    "title": "Search Query Fields",
    "description": "Create and administer search query fields.",
    "version": "9.1.20.0",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "paths": {
    "/search-query-fields": {
      "get": {
        "tags": [
          "search-query-fields"
        ],
        "description": "Get a collection of search query fields.",
        "operationId": "getSearchQueryFields",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The unique numeric ID for identifying the search query field.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "catalogId",
            "in": "query",
            "description": "The reference ID of the catalog this search query field associated with.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The reference ID of the store this search query field associated with.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "catalogGroupId",
            "in": "query",
            "description": "The reference ID of the catalog group this search query field associated with.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "fieldWeight",
            "in": "query",
            "description": "The field weight value to control its importance in the query with respects to other fields.",
            "schema": {
              "type": "number",
              "format": "double"
            }
          },
          {
            "name": "fieldName",
            "in": "query",
            "description": "The search index field name. That is, the Solr index field name as defined in the search index schema.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of search query fields.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchQueryFieldCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "search-query-fields"
        ],
        "description": "Create a search query field.",
        "operationId": "createSearchQueryField",
        "requestBody": {
          "description": "The search query field.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SearchQueryFields"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the search-query-fields.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetSearchQueryFieldsById": {
                "operationRef": "#/paths/~1/search-query-fields~1{id}/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /search-query-fields/{id}`.\n"
              },
              "DeleteSearchQueryFieldsById": {
                "operationRef": "#/paths/~1search-query-fields~1{id}/delete",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE /search-query-fields/{id}`.\n"
              },
              "UpdateSearchQueryFieldsById": {
                "operationRef": "#/paths/~1search-query-fields~1{id}/patch",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `PATCH /search-query-fields/{id}`.\n"
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "SearchQueryField"
      }
    },
    "/search-query-fields/{id}": {
      "get": {
        "tags": [
          "search-query-fields"
        ],
        "description": "Get a search query field.",
        "operationId": "getSearchQueryFieldById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the search query field.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The search query field.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchQueryField"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "search-query-fields"
        ],
        "description": "Delete a search query field.",
        "operationId": "deleteSearchQueryFieldById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the search query field.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "search-query-fields"
        ],
        "description": "Update a search query field.",
        "operationId": "updateSearchQueryFieldById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the search query field.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "description": "The search query field.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SearchQueryFields"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "SearchQueryField"
      }
    }
  },
  "components": {
    "schemas": {
      "Link": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The URL of the link.",
            "format": "uri"
          }
        },
        "description": "Links to related resources."
      },
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "The error message code."
          },
          "errorMessage": {
            "type": "string",
            "description": "The error message."
          },
          "errorKey": {
            "type": "string",
            "description": "The error message key."
          },
          "errorParameters": {
            "type": "array",
            "description": "The arguments used to construct the error message.",
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "errorLevel": {
            "type": "string",
            "description": "The error level."
          },
          "errorHref": {
            "type": "string",
            "description": "The error hypertext reference."
          }
        },
        "description": "The error message item model."
      },
      "ErrorResponseContainer": {
        "type": "object",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "The request identifier."
          },
          "errors": {
            "type": "array",
            "description": "The errors.",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        },
        "description": "The error message model."
      },
      "SearchQueryField": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the search query field.",
            "format": "int64"
          },
          "catalogId": {
            "type": "integer",
            "description": "The reference ID of the catalog this search query field associated with.",
            "format": "int64"
          },
          "storeId": {
            "type": "integer",
            "description": "The reference ID of the store this search query field associated with.",
            "format": "int32"
          },
          "catalogGroupId": {
            "type": "integer",
            "description": "The reference ID of the catalog group this search query field associated with.",
            "format": "int64"
          },
          "fieldWeight": {
            "type": "number",
            "description": "The field weight value to control its importance in the query with respects to other fields.",
            "format": "double"
          },
          "fieldName": {
            "type": "string",
            "description": "The search index field name. That is, the Solr index field name as defined in the search index schema."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "the URL of the link"
                  }
                }
              }
            }
          }
        },
        "description": "The search query field."
      },
      "SearchQueryFields": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the search query field.",
            "format": "int64"
          },
          "catalogId": {
            "type": "integer",
            "description": "The reference ID of the catalog this search query field associated with.",
            "format": "int64"
          },
          "storeId": {
            "type": "integer",
            "description": "The reference ID of the store this search query field associated with.",
            "format": "int32"
          },
          "catalogGroupId": {
            "type": "integer",
            "description": "The reference ID of the catalog group this search query field associated with.",
            "format": "int64"
          },
          "fieldWeight": {
            "type": "number",
            "description": "The field weight value to control its importance in the query with respects to other fields.",
            "format": "double"
          },
          "fieldName": {
            "type": "string",
            "description": "The search index field name. That is, the Solr index field name as defined in the search index schema."
          }
        }
      },
      "SearchQueryFieldCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/SearchQueryField"
            }
          }
        },
        "description": "A collection of search query fields."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}