{
  "openapi": "3.0.1",
  "info": {
    "title": "Facet Properties",
    "description": "Create and administer a collection of search facet properties.",
    "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"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Facet Properties",
      "description": "Provide RESTful services to manage facet properties."
    }
  ],
  "paths": {
    "/facet-properties": {
      "get": {
        "tags": [
          "Facet Properties"
        ],
        "description": "Get a collection of search facet properties.",
        "operationId": "getFacetProperties",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The unique numeric ID for identifying the facet properties.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "attributeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the attribute dictionary attribute. Null if facet is not based on attribute dictionary attribute.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "fieldId",
            "in": "query",
            "description": "The unique numeric ID for identifying the search index field.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The reference ID of the store this facet associated with.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "selection",
            "in": "query",
            "description": "The multiple selection facet property. Valid values are, 0 = Not allowed to have multiple selection, 1 = Allowed to have multiple selection.",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "sortOrder",
            "in": "query",
            "description": "The sort order display facet property. Valid values are, 0 = Sort by Count, 1 = Sort alphabetically, 2 = Sort by the attribute sequence as defined in the attribute dictionary which only applies to attribute dictionary attributes based facet.",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "searchDisplay",
            "in": "query",
            "description": "The search display facet property. Valid values are, 0 = Do not include in search queries, 1 = include in search queries.",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "zeroDisplay",
            "in": "query",
            "description": "The zero count display facet property. Valid values are, 0 = Do not return zero count values, 1 = Return zero count values.",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "maxDisplay",
            "in": "query",
            "description": "The maximum values to display facet property. A value of -1 represents an infinite number of values are allowed to be returned.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "sequence",
            "in": "query",
            "description": "The sequence facet property of displaying the facets.",
            "schema": {
              "type": "number",
              "format": "double"
            }
          },
          {
            "name": "field1",
            "in": "query",
            "description": "Customizable field.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "field2",
            "in": "query",
            "description": "Customizable field.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "field3",
            "in": "query",
            "description": "Customizable field.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "groupId",
            "in": "query",
            "description": "The group id facet property.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "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 facet properties.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FacetPropertyCollection"
                }
              }
            }
          },
          "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": [
          "Facet Properties"
        ],
        "description": "Create a search facet properties.",
        "operationId": "createFacetProperty",
        "requestBody": {
          "description": "The search facet properties.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FacetProperty.request"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the facet properties.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetFacetPropertiesByFacetPropertyId": {
                "operationRef": "#/paths/~1facet-properties~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 /facet-properties/{id}`.\n"
              },
              "DeleteFacetPropertiesByFacetPropertyId": {
                "operationRef": "#/paths/~1facet-properties~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 /facet-properties/{id}`.\n"
              },
              "UpdateFacetPropertiesByFacetPropertyId": {
                "operationRef": "#/paths/~1facet-properties~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 /facet-properties/{id}`.\n"
              },
              "GetFacetPropertyDescriptionsByFacetPropertyId": {
                "operationRef": "#/paths/~1facet-properties~1{id}~1descriptions/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /facet-properties/{id}/descriptions`.\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": "FacetProperty"
      }
    },
    "/facet-properties/{id}": {
      "get": {
        "tags": [
          "Facet Properties"
        ],
        "description": "Get a search facet properties.",
        "operationId": "getFacetPropertyById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the facet properties.",
            "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 facet properties.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FacetProperty"
                }
              }
            }
          },
          "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": [
          "Facet Properties"
        ],
        "description": "Delete a search facet properties.",
        "operationId": "deleteFacetPropertyById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the facet properties.",
            "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": [
          "Facet Properties"
        ],
        "description": "Update a search facet properties.",
        "operationId": "updateFacetPropertyById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the facet properties.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "description": "The search facet properties.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FacetProperty.request"
              }
            }
          },
          "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": "FacetProperty"
      }
    },
    "/facet-properties/{id}/descriptions": {
      "get": {
        "tags": [
          "Facet Properties"
        ],
        "operationId": "getDescriptionsOfFacetProperty",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the facet properties.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "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 facet descriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FacetDescriptionCollection"
                }
              }
            }
          },
          "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"
                }
              }
            }
          }
        }
      }
    }
  },
  "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."
      },
      "FacetProperty": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the facet properties.",
            "format": "int64"
          },
          "attributeId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the attribute dictionary attribute. Null if facet is not based on attribute dictionary attribute.",
            "format": "int64"
          },
          "fieldId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the search index field.",
            "format": "int64"
          },
          "storeId": {
            "type": "integer",
            "description": "The reference ID of the store this facet associated with.",
            "format": "int32"
          },
          "selection": {
            "type": "number",
            "description": "The multiple selection facet property. Valid values are, 0 = Not allowed to have multiple selection, 1 = Allowed to have multiple selection."
          },
          "sortOrder": {
            "type": "number",
            "description": "The sort order display facet property. Valid values are, 0 = Sort by Count, 1 = Sort alphabetically, 2 = Sort by the attribute sequence as defined in the attribute dictionary which only applies to attribute dictionary attributes based facet."
          },
          "searchDisplay": {
            "type": "number",
            "description": "The search display facet property. Valid values are, 0 = Do not include in search queries, 1 = include in search queries."
          },
          "zeroDisplay": {
            "type": "number",
            "description": "The zero count display facet property. Valid values are, 0 = Do not return zero count values, 1 = Return zero count values."
          },
          "maxDisplay": {
            "type": "integer",
            "description": "The maximum values to display facet property. A value of -1 represents an infinite number of values are allowed to be returned.",
            "format": "int32"
          },
          "sequence": {
            "type": "number",
            "description": "The sequence facet property of displaying the facets.",
            "format": "double"
          },
          "field1": {
            "type": "integer",
            "description": "Customizable field.",
            "format": "int32"
          },
          "field2": {
            "type": "string",
            "description": "Customizable field."
          },
          "field3": {
            "type": "string",
            "description": "Customizable field."
          },
          "groupId": {
            "type": "integer",
            "description": "The group id facet property.",
            "format": "int64"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "descriptions": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": "The facet description relationships of a facet."
              }
            },
            "description": "Links to related resources."
          }
        },
        "description": "The search facet properties."
      },
      "FacetProperty.request": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the facet properties.",
            "format": "int64"
          },
          "attributeId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the attribute dictionary attribute. Null if facet is not based on attribute dictionary attribute.",
            "format": "int64"
          },
          "fieldId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the search index field.",
            "format": "int64"
          },
          "storeId": {
            "type": "integer",
            "description": "The reference ID of the store this facet associated with.",
            "format": "int32"
          },
          "selection": {
            "type": "number",
            "description": "The multiple selection facet property. Valid values are, 0 = Not allowed to have multiple selection, 1 = Allowed to have multiple selection."
          },
          "sortOrder": {
            "type": "number",
            "description": "The sort order display facet property. Valid values are, 0 = Sort by Count, 1 = Sort alphabetically, 2 = Sort by the attribute sequence as defined in the attribute dictionary which only applies to attribute dictionary attributes based facet."
          },
          "searchDisplay": {
            "type": "number",
            "description": "The search display facet property. Valid values are, 0 = Do not include in search queries, 1 = include in search queries."
          },
          "zeroDisplay": {
            "type": "number",
            "description": "The zero count display facet property. Valid values are, 0 = Do not return zero count values, 1 = Return zero count values."
          },
          "maxDisplay": {
            "type": "integer",
            "description": "The maximum values to display facet property. A value of -1 represents an infinite number of values are allowed to be returned.",
            "format": "int32"
          },
          "sequence": {
            "type": "number",
            "description": "The sequence facet property of displaying the facets.",
            "format": "double"
          },
          "field1": {
            "type": "integer",
            "description": "Customizable field.",
            "format": "int32"
          },
          "field2": {
            "type": "string",
            "description": "Customizable field."
          },
          "field3": {
            "type": "string",
            "description": "Customizable field."
          },
          "groupId": {
            "type": "integer",
            "description": "The group id facet property.",
            "format": "int64"
          }
        },
        "description": "The search facet properties."
      },
      "FacetPropertyCollection": {
        "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/FacetProperty"
            }
          }
        },
        "description": "A collection of search facet properties."
      },
      "FacetDescription": {
        "type": "object",
        "properties": {
          "facetId": {
            "type": "integer",
            "description": "The unique identifier for this search facet.",
            "format": "int64"
          },
          "languageId": {
            "type": "integer",
            "description": "The language ID for identifying the description of the search facet.",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "description": "The language sensitive name for none attribute dictionary attribute based search facets."
          },
          "description": {
            "type": "string",
            "description": "The language sensitive administrative description for none attribute dictionary attribute based search facets."
          },
          "field1": {
            "type": "integer",
            "description": "Customizable field.",
            "format": "int32"
          },
          "field2": {
            "type": "string",
            "description": "Customizable field."
          },
          "field3": {
            "type": "string",
            "description": "Customizable field."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                },
                "required": [
                  "href"
                ]
              }
            }
          }
        },
        "description": "The search facet descriptions for none attribute dictionary attribute based facets."
      },
      "FacetDescriptionCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/FacetDescription"
            }
          }
        },
        "description": "A collection of facet descriptions."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}