Skip to main content
GET
/
commerce
/
catalog
/
admin
/
searchSchema
/
definition
/
{language}
Error
A valid request URL is required to generate request examples
{
  "fields": [
    {
      "fieldDefinition": "<string>",
      "fieldName": "<string>",
      "friendlyName": "<string>",
      "ingestFieldName": "<string>",
      "searchFieldName": "<string>"
    }
  ],
  "language": "<string>",
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "isPublished": true,
  "spellCorrectEnabled": true,
  "spellingFields": [
    {
      "ingestFieldName": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
language
string
required

Query Parameters

​
published
boolean
​
responseFields
string

limits which fields are returned in the response body

Response

Success

​
fields
object[]
required
​
language
string
required
​
auditInfo
object
​
isPublished
boolean
​
spellCorrectEnabled
boolean | null

Returns boolean if contains any SpellingFields members.

​
spellingFields
object[] | null

List of attributes used in the spelling dictionary