SpecificationsInsertFieldRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SpecificationsInsertFieldRequest",
  "title": "SpecificationsInsertFieldRequest",
  "required": [
    "Name",
    "CategoryId",
    "IsActive",
    "FieldId",
    "IsRequired",
    "FieldTypeId",
    "FieldValueId",
    "Description",
    "IsStockKeepingUnit",
    "IsFilter",
    "IsOnProductDetails",
    "Position",
    "IsWizard",
    "IsTopMenuLinkActive",
    "IsSideMenuLinkActive",
    "DefaultValue",
    "FieldGroupId",
    "FieldGroupName"
  ],
  "type": "object",
  "properties": {
    "Name": {
      "type": "string",
      "description": "Specification field name. Limited to 100 characters."
    },
    "CategoryId": {
      "type": "integer",
      "nullable": true,
      "description": "Category ID."
    },
    "FieldId": {
      "type": "integer",
      "nullable": true,
      "description": "Specification field ID."
    },
    "IsActive": {
      "type": "boolean",
      "description": "Defines if the specification field is active. The default value is `true`."
    },
    "IsRequired": {
      "type": "boolean",
      "description": "Makes the specification field mandatory (`true`) or optional (`false`)."
    },
    "FieldTypeId": {
      "type": "integer",
      "format": "int32",
      "description": "Specification field type ID."
    },
    "FieldValueId": {
      "type": "integer",
      "nullable": true,
      "description": "Specification field value ID."
    },
    "Description": {
      "type": "string",
      "nullable": true,
      "description": "Specification field description."
    },
    "IsStockKeepingUnit": {
      "type": "boolean",
      "description": "If `true`, it will be added as a SKU specification. If `false`, it will be added as a product specification field."
    },
    "IsFilter": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar."
    },
    "IsOnProductDetails": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal -If specification is visible on the product page."
    },
    "Position": {
      "type": "integer",
      "format": "int32",
      "description": "Specification field position."
    },
    "IsWizard": {
      "type": "boolean",
      "description": "Deprecated field.",
      "deprecated": true
    },
    "IsTopMenuLinkActive": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal - To make the specification visible in the store's upper menu."
    },
    "IsSideMenuLinkActive": {
      "type": "boolean",
      "description": "Store Framework - Deprecated.\r\nLegacy CMS Portal - To make the specification field clickable in the search navigation bar."
    },
    "DefaultValue": {
      "type": "string",
      "nullable": true,
      "description": "Specification field default value."
    },
    "FieldGroupId": {
      "type": "integer",
      "format": "int32",
      "description": "Specification field group ID."
    },
    "FieldGroupName": {
      "type": "string",
      "description": "Specification field group name."
    }
  },
  "example": {
    "Name": "Material",
    "CategoryId": 4,
    "FieldId": 88,
    "IsActive": true,
    "IsRequired": true,
    "FieldTypeId": 1,
    "FieldValueId": 1,
    "IsStockKeepingUnit": false,
    "Description": "Composition of the product.",
    "IsFilter": true,
    "IsOnProductDetails": false,
    "Position": 1,
    "IsWizard": false,
    "IsTopMenuLinkActive": true,
    "IsSideMenuLinkActive": true,
    "DefaultValue": null,
    "FieldGroupId": 20,
    "FieldGroupName": "Clothes specifications"
  }
}