# Models

## The ErrorResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"ErrorResponse":{"required":["code","message","status"],"type":"object","properties":{"id":{"type":"string","nullable":true},"code":{"type":"integer","format":"int32"},"status":{"type":"string"},"message":{"type":"string"},"errorCode":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"moreInfo":{"type":"string"}}}}}}}}}
```

## The IdResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"IdResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the generated document."}},"description":"Id of the created schema."}}}}
```

## The SchemaType object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemaType":{"type":"string","description":"Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.","enum":["CART","CART_ITEM","CATEGORY","COMPANY","COUPON","CUSTOMER","CUSTOMER_ADDRESS","ORDER","ORDER_ENTRY","PRODUCT","QUOTE","RETURN","PRICE_LIST","SITE","CUSTOM_ENTITY","VENDOR"]}}}}
```

## The SchemaTypes object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemaTypes":{"type":"array","description":"List of types to which assign the schema.","items":{"$ref":"#/components/schemas/SchemaType"}},"SchemaType":{"type":"string","description":"Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.","enum":["CART","CART_ITEM","CATEGORY","COMPANY","COUPON","CUSTOMER","CUSTOMER_ADDRESS","ORDER","ORDER_ENTRY","PRODUCT","QUOTE","RETURN","PRICE_LIST","SITE","CUSTOM_ENTITY","VENDOR"]}}}}
```

## The SchemaAttributeType object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemaAttributeType":{"type":"string","description":"Type of the attribute.\n\n**Note**: The `REFERENCE` type is only available for custom schema types.\n","enum":["TEXT","NUMBER","DECIMAL","BOOLEAN","DATE","TIME","DATE_TIME","ENUM","ARRAY","OBJECT","REFERENCE"]}}}}
```

## The Localized object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"Localized":{"type":"boolean","description":"Whether the attribute is localized or not. Only attributes of 'TEXT' type can be localized."}}}}
```

## The SchemaAttributeMetadata object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemaAttributeMetadata":{"type":"object","description":"Metadata of the schema attribute.","properties":{"readOnly":{"type":"boolean","description":"Whether the attribute is read-only or not."},"localized":{"$ref":"#/components/schemas/Localized"},"required":{"type":"boolean","description":"Whether the attribute is required or not. Attributes of 'BOOLEAN' type cannot be required."},"nullable":{"type":"boolean","description":"Whether the attribute could accept null or not."}}},"Localized":{"type":"boolean","description":"Whether the attribute is localized or not. Only attributes of 'TEXT' type can be localized."}}}}
```

## The SchemaAttributeValue object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemaAttributeValue":{"type":"object","description":"Value of the attribute. Valid for `ENUM` and `REFERENCE` types.\n\nFor `ENUM` type, the value represents one of the allowed enum values.\n\nFor `REFERENCE` type, the value represents the reference type (e.g., `PRODUCT`, `ORDER`, `ORDER_ENTRY`, `CART`, `CART_ITEM`, `PRICE`, `CUSTOMER`, `COMPANY`, `MEDIA`, `PRICE_LIST`, `CUSTOMER_SEGMENT`, `CATEGORY`, or any custom schema type).\n","properties":{"value":{"type":"string"}},"required":["value"]}}}}
```

## The SchemaFileAttributeResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemaFileAttributeResponse":{"type":"object","description":"Schema attribute.","properties":{"key":{"type":"string","description":"Unique key of the attribute."},"metadata":{"$ref":"#/components/schemas/SchemaAttributeMetadata"},"values":{"type":"array","description":"List of available values for the attribute. Only valid for `ENUM` and `REFERENCE` types.","items":{"$ref":"#/components/schemas/SchemaAttributeValue"}}}},"SchemaAttributeMetadata":{"type":"object","description":"Metadata of the schema attribute.","properties":{"readOnly":{"type":"boolean","description":"Whether the attribute is read-only or not."},"localized":{"$ref":"#/components/schemas/Localized"},"required":{"type":"boolean","description":"Whether the attribute is required or not. Attributes of 'BOOLEAN' type cannot be required."},"nullable":{"type":"boolean","description":"Whether the attribute could accept null or not."}}},"Localized":{"type":"boolean","description":"Whether the attribute is localized or not. Only attributes of 'TEXT' type can be localized."},"SchemaAttributeValue":{"type":"object","description":"Value of the attribute. Valid for `ENUM` and `REFERENCE` types.\n\nFor `ENUM` type, the value represents one of the allowed enum values.\n\nFor `REFERENCE` type, the value represents the reference type (e.g., `PRODUCT`, `ORDER`, `ORDER_ENTRY`, `CART`, `CART_ITEM`, `PRICE`, `CUSTOMER`, `COMPANY`, `MEDIA`, `PRICE_LIST`, `CUSTOMER_SEGMENT`, `CATEGORY`, or any custom schema type).\n","properties":{"value":{"type":"string"}},"required":["value"]}}}}
```

## The SchemaAttribute object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemaAttribute":{"type":"object","description":"Schema attribute.","properties":{"key":{"type":"string","description":"Unique key of the attribute."},"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"description":{"type":"object","description":"Localized schema description in a form of a map of translations."},"type":{"$ref":"#/components/schemas/SchemaAttributeType"},"metadata":{"$ref":"#/components/schemas/SchemaAttributeMetadata"},"values":{"type":"array","description":"List of available values for the attribute. Only valid for `ENUM` and `REFERENCE` type.","items":{"$ref":"#/components/schemas/SchemaAttributeValue"}},"attributes":{"type":"array","description":"Object's properties. It can only be provided for attribute of `OBJECT` type.","items":{"$ref":"#/components/schemas/SchemaAttribute"}},"arrayType":{"type":"object","description":"Contains information about the type used inside an array. It can only be provided for attribute of `ARRAY` type.","properties":{"type":{"$ref":"#/components/schemas/SchemaAttributeType"},"values":{"type":"array","description":"List of available values for the attribute. Only valid for `ENUM` and `REFERENCE` type.","items":{"$ref":"#/components/schemas/SchemaAttributeValue"}},"localized":{"$ref":"#/components/schemas/Localized"}},"required":["type"]}},"required":["key","name","type","metadata"]},"SchemaAttributeType":{"type":"string","description":"Type of the attribute.\n\n**Note**: The `REFERENCE` type is only available for custom schema types.\n","enum":["TEXT","NUMBER","DECIMAL","BOOLEAN","DATE","TIME","DATE_TIME","ENUM","ARRAY","OBJECT","REFERENCE"]},"SchemaAttributeMetadata":{"type":"object","description":"Metadata of the schema attribute.","properties":{"readOnly":{"type":"boolean","description":"Whether the attribute is read-only or not."},"localized":{"$ref":"#/components/schemas/Localized"},"required":{"type":"boolean","description":"Whether the attribute is required or not. Attributes of 'BOOLEAN' type cannot be required."},"nullable":{"type":"boolean","description":"Whether the attribute could accept null or not."}}},"Localized":{"type":"boolean","description":"Whether the attribute is localized or not. Only attributes of 'TEXT' type can be localized."},"SchemaAttributeValue":{"type":"object","description":"Value of the attribute. Valid for `ENUM` and `REFERENCE` types.\n\nFor `ENUM` type, the value represents one of the allowed enum values.\n\nFor `REFERENCE` type, the value represents the reference type (e.g., `PRODUCT`, `ORDER`, `ORDER_ENTRY`, `CART`, `CART_ITEM`, `PRICE`, `CUSTOMER`, `COMPANY`, `MEDIA`, `PRICE_LIST`, `CUSTOMER_SEGMENT`, `CATEGORY`, or any custom schema type).\n","properties":{"value":{"type":"string"}},"required":["value"]}}}}
```

## The AbstractSchemaRequest object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"AbstractSchemaRequest":{"type":"object","properties":{"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"types":{"type":"array","description":"List of types which schema should be assigned to.","items":{"$ref":"#/components/schemas/SchemaType"}}},"required":["name","types"]},"SchemaType":{"type":"string","description":"Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.","enum":["CART","CART_ITEM","CATEGORY","COMPANY","COUPON","CUSTOMER","CUSTOMER_ADDRESS","ORDER","ORDER_ENTRY","PRODUCT","QUOTE","RETURN","PRICE_LIST","SITE","CUSTOM_ENTITY","VENDOR"]}}}}
```

## The SchemaRequest object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemaRequest":{"allOf":[{"$ref":"#/components/schemas/AbstractSchemaRequest"}],"type":"object","properties":{"attributes":{"type":"array","description":"List of attributes related to the schema.","items":{"$ref":"#/components/schemas/SchemaAttribute"}}},"required":["attributes"]},"AbstractSchemaRequest":{"type":"object","properties":{"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"types":{"type":"array","description":"List of types which schema should be assigned to.","items":{"$ref":"#/components/schemas/SchemaType"}}},"required":["name","types"]},"SchemaType":{"type":"string","description":"Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.","enum":["CART","CART_ITEM","CATEGORY","COMPANY","COUPON","CUSTOMER","CUSTOMER_ADDRESS","ORDER","ORDER_ENTRY","PRODUCT","QUOTE","RETURN","PRICE_LIST","SITE","CUSTOM_ENTITY","VENDOR"]},"SchemaAttribute":{"type":"object","description":"Schema attribute.","properties":{"key":{"type":"string","description":"Unique key of the attribute."},"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"description":{"type":"object","description":"Localized schema description in a form of a map of translations."},"type":{"$ref":"#/components/schemas/SchemaAttributeType"},"metadata":{"$ref":"#/components/schemas/SchemaAttributeMetadata"},"values":{"type":"array","description":"List of available values for the attribute. Only valid for `ENUM` and `REFERENCE` type.","items":{"$ref":"#/components/schemas/SchemaAttributeValue"}},"attributes":{"type":"array","description":"Object's properties. It can only be provided for attribute of `OBJECT` type.","items":{"$ref":"#/components/schemas/SchemaAttribute"}},"arrayType":{"type":"object","description":"Contains information about the type used inside an array. It can only be provided for attribute of `ARRAY` type.","properties":{"type":{"$ref":"#/components/schemas/SchemaAttributeType"},"values":{"type":"array","description":"List of available values for the attribute. Only valid for `ENUM` and `REFERENCE` type.","items":{"$ref":"#/components/schemas/SchemaAttributeValue"}},"localized":{"$ref":"#/components/schemas/Localized"}},"required":["type"]}},"required":["key","name","type","metadata"]},"SchemaAttributeType":{"type":"string","description":"Type of the attribute.\n\n**Note**: The `REFERENCE` type is only available for custom schema types.\n","enum":["TEXT","NUMBER","DECIMAL","BOOLEAN","DATE","TIME","DATE_TIME","ENUM","ARRAY","OBJECT","REFERENCE"]},"SchemaAttributeMetadata":{"type":"object","description":"Metadata of the schema attribute.","properties":{"readOnly":{"type":"boolean","description":"Whether the attribute is read-only or not."},"localized":{"$ref":"#/components/schemas/Localized"},"required":{"type":"boolean","description":"Whether the attribute is required or not. Attributes of 'BOOLEAN' type cannot be required."},"nullable":{"type":"boolean","description":"Whether the attribute could accept null or not."}}},"Localized":{"type":"boolean","description":"Whether the attribute is localized or not. Only attributes of 'TEXT' type can be localized."},"SchemaAttributeValue":{"type":"object","description":"Value of the attribute. Valid for `ENUM` and `REFERENCE` types.\n\nFor `ENUM` type, the value represents one of the allowed enum values.\n\nFor `REFERENCE` type, the value represents the reference type (e.g., `PRODUCT`, `ORDER`, `ORDER_ENTRY`, `CART`, `CART_ITEM`, `PRICE`, `CUSTOMER`, `COMPANY`, `MEDIA`, `PRICE_LIST`, `CUSTOMER_SEGMENT`, `CATEGORY`, or any custom schema type).\n","properties":{"value":{"type":"string"}},"required":["value"]}}}}
```

## The SchemaCreation object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemaCreation":{"allOf":[{"$ref":"#/components/schemas/SchemaRequest"},{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the schema."}}}]},"SchemaRequest":{"allOf":[{"$ref":"#/components/schemas/AbstractSchemaRequest"}],"type":"object","properties":{"attributes":{"type":"array","description":"List of attributes related to the schema.","items":{"$ref":"#/components/schemas/SchemaAttribute"}}},"required":["attributes"]},"AbstractSchemaRequest":{"type":"object","properties":{"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"types":{"type":"array","description":"List of types which schema should be assigned to.","items":{"$ref":"#/components/schemas/SchemaType"}}},"required":["name","types"]},"SchemaType":{"type":"string","description":"Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.","enum":["CART","CART_ITEM","CATEGORY","COMPANY","COUPON","CUSTOMER","CUSTOMER_ADDRESS","ORDER","ORDER_ENTRY","PRODUCT","QUOTE","RETURN","PRICE_LIST","SITE","CUSTOM_ENTITY","VENDOR"]},"SchemaAttribute":{"type":"object","description":"Schema attribute.","properties":{"key":{"type":"string","description":"Unique key of the attribute."},"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"description":{"type":"object","description":"Localized schema description in a form of a map of translations."},"type":{"$ref":"#/components/schemas/SchemaAttributeType"},"metadata":{"$ref":"#/components/schemas/SchemaAttributeMetadata"},"values":{"type":"array","description":"List of available values for the attribute. Only valid for `ENUM` and `REFERENCE` type.","items":{"$ref":"#/components/schemas/SchemaAttributeValue"}},"attributes":{"type":"array","description":"Object's properties. It can only be provided for attribute of `OBJECT` type.","items":{"$ref":"#/components/schemas/SchemaAttribute"}},"arrayType":{"type":"object","description":"Contains information about the type used inside an array. It can only be provided for attribute of `ARRAY` type.","properties":{"type":{"$ref":"#/components/schemas/SchemaAttributeType"},"values":{"type":"array","description":"List of available values for the attribute. Only valid for `ENUM` and `REFERENCE` type.","items":{"$ref":"#/components/schemas/SchemaAttributeValue"}},"localized":{"$ref":"#/components/schemas/Localized"}},"required":["type"]}},"required":["key","name","type","metadata"]},"SchemaAttributeType":{"type":"string","description":"Type of the attribute.\n\n**Note**: The `REFERENCE` type is only available for custom schema types.\n","enum":["TEXT","NUMBER","DECIMAL","BOOLEAN","DATE","TIME","DATE_TIME","ENUM","ARRAY","OBJECT","REFERENCE"]},"SchemaAttributeMetadata":{"type":"object","description":"Metadata of the schema attribute.","properties":{"readOnly":{"type":"boolean","description":"Whether the attribute is read-only or not."},"localized":{"$ref":"#/components/schemas/Localized"},"required":{"type":"boolean","description":"Whether the attribute is required or not. Attributes of 'BOOLEAN' type cannot be required."},"nullable":{"type":"boolean","description":"Whether the attribute could accept null or not."}}},"Localized":{"type":"boolean","description":"Whether the attribute is localized or not. Only attributes of 'TEXT' type can be localized."},"SchemaAttributeValue":{"type":"object","description":"Value of the attribute. Valid for `ENUM` and `REFERENCE` types.\n\nFor `ENUM` type, the value represents one of the allowed enum values.\n\nFor `REFERENCE` type, the value represents the reference type (e.g., `PRODUCT`, `ORDER`, `ORDER_ENTRY`, `CART`, `CART_ITEM`, `PRICE`, `CUSTOMER`, `COMPANY`, `MEDIA`, `PRICE_LIST`, `CUSTOMER_SEGMENT`, `CATEGORY`, or any custom schema type).\n","properties":{"value":{"type":"string"}},"required":["value"]}}}}
```

## The SchemaUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemaUpdate":{"allOf":[{"$ref":"#/components/schemas/SchemaRequest"},{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/SchemaMetadataUpdate"}}}]},"SchemaRequest":{"allOf":[{"$ref":"#/components/schemas/AbstractSchemaRequest"}],"type":"object","properties":{"attributes":{"type":"array","description":"List of attributes related to the schema.","items":{"$ref":"#/components/schemas/SchemaAttribute"}}},"required":["attributes"]},"AbstractSchemaRequest":{"type":"object","properties":{"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"types":{"type":"array","description":"List of types which schema should be assigned to.","items":{"$ref":"#/components/schemas/SchemaType"}}},"required":["name","types"]},"SchemaType":{"type":"string","description":"Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.","enum":["CART","CART_ITEM","CATEGORY","COMPANY","COUPON","CUSTOMER","CUSTOMER_ADDRESS","ORDER","ORDER_ENTRY","PRODUCT","QUOTE","RETURN","PRICE_LIST","SITE","CUSTOM_ENTITY","VENDOR"]},"SchemaAttribute":{"type":"object","description":"Schema attribute.","properties":{"key":{"type":"string","description":"Unique key of the attribute."},"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"description":{"type":"object","description":"Localized schema description in a form of a map of translations."},"type":{"$ref":"#/components/schemas/SchemaAttributeType"},"metadata":{"$ref":"#/components/schemas/SchemaAttributeMetadata"},"values":{"type":"array","description":"List of available values for the attribute. Only valid for `ENUM` and `REFERENCE` type.","items":{"$ref":"#/components/schemas/SchemaAttributeValue"}},"attributes":{"type":"array","description":"Object's properties. It can only be provided for attribute of `OBJECT` type.","items":{"$ref":"#/components/schemas/SchemaAttribute"}},"arrayType":{"type":"object","description":"Contains information about the type used inside an array. It can only be provided for attribute of `ARRAY` type.","properties":{"type":{"$ref":"#/components/schemas/SchemaAttributeType"},"values":{"type":"array","description":"List of available values for the attribute. Only valid for `ENUM` and `REFERENCE` type.","items":{"$ref":"#/components/schemas/SchemaAttributeValue"}},"localized":{"$ref":"#/components/schemas/Localized"}},"required":["type"]}},"required":["key","name","type","metadata"]},"SchemaAttributeType":{"type":"string","description":"Type of the attribute.\n\n**Note**: The `REFERENCE` type is only available for custom schema types.\n","enum":["TEXT","NUMBER","DECIMAL","BOOLEAN","DATE","TIME","DATE_TIME","ENUM","ARRAY","OBJECT","REFERENCE"]},"SchemaAttributeMetadata":{"type":"object","description":"Metadata of the schema attribute.","properties":{"readOnly":{"type":"boolean","description":"Whether the attribute is read-only or not."},"localized":{"$ref":"#/components/schemas/Localized"},"required":{"type":"boolean","description":"Whether the attribute is required or not. Attributes of 'BOOLEAN' type cannot be required."},"nullable":{"type":"boolean","description":"Whether the attribute could accept null or not."}}},"Localized":{"type":"boolean","description":"Whether the attribute is localized or not. Only attributes of 'TEXT' type can be localized."},"SchemaAttributeValue":{"type":"object","description":"Value of the attribute. Valid for `ENUM` and `REFERENCE` types.\n\nFor `ENUM` type, the value represents one of the allowed enum values.\n\nFor `REFERENCE` type, the value represents the reference type (e.g., `PRODUCT`, `ORDER`, `ORDER_ENTRY`, `CART`, `CART_ITEM`, `PRICE`, `CUSTOMER`, `COMPANY`, `MEDIA`, `PRICE_LIST`, `CUSTOMER_SEGMENT`, `CATEGORY`, or any custom schema type).\n","properties":{"value":{"type":"string"}},"required":["value"]},"SchemaMetadataUpdate":{"type":"object","properties":{"version":{"type":"number","description":"Version of the object. The value is required during update operation."}}}}}}
```

## The ReferenceCreation object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"ReferenceCreation":{"allOf":[{"$ref":"#/components/schemas/AbstractSchemaRequest"},{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the schema."}}}]},"AbstractSchemaRequest":{"type":"object","properties":{"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"types":{"type":"array","description":"List of types which schema should be assigned to.","items":{"$ref":"#/components/schemas/SchemaType"}}},"required":["name","types"]},"SchemaType":{"type":"string","description":"Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.","enum":["CART","CART_ITEM","CATEGORY","COMPANY","COUPON","CUSTOMER","CUSTOMER_ADDRESS","ORDER","ORDER_ENTRY","PRODUCT","QUOTE","RETURN","PRICE_LIST","SITE","CUSTOM_ENTITY","VENDOR"]}}}}
```

## The ReferenceUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"ReferenceUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractSchemaRequest"},{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/SchemaMetadataUpdate"}}}]},"AbstractSchemaRequest":{"type":"object","properties":{"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"types":{"type":"array","description":"List of types which schema should be assigned to.","items":{"$ref":"#/components/schemas/SchemaType"}}},"required":["name","types"]},"SchemaType":{"type":"string","description":"Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.","enum":["CART","CART_ITEM","CATEGORY","COMPANY","COUPON","CUSTOMER","CUSTOMER_ADDRESS","ORDER","ORDER_ENTRY","PRODUCT","QUOTE","RETURN","PRICE_LIST","SITE","CUSTOM_ENTITY","VENDOR"]},"SchemaMetadataUpdate":{"type":"object","properties":{"version":{"type":"number","description":"Version of the object. The value is required during update operation."}}}}}}
```

## The SchemaMetadataUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemaMetadataUpdate":{"type":"object","properties":{"version":{"type":"number","description":"Version of the object. The value is required during update operation."}}}}}}
```

## The SchemaMetadata object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemaMetadata":{"allOf":[{"$ref":"#/components/schemas/SchemaMetadataUpdate"},{"type":"object","description":"Metadata of schema.","properties":{"url":{"type":"string","description":"Schema url of the attributes."},"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"}}}]},"SchemaMetadataUpdate":{"type":"object","properties":{"version":{"type":"number","description":"Version of the object. The value is required during update operation."}}}}}}
```

## The SchemaFileResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemaFileResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the schema."},"attributes":{"type":"array","description":"List of attributes related to the schema.","items":{"$ref":"#/components/schemas/SchemaFileAttributeResponse"}},"metadata":{"allOf":[{"$ref":"#/components/schemas/SchemaMetadataUpdate"}]}}},"SchemaFileAttributeResponse":{"type":"object","description":"Schema attribute.","properties":{"key":{"type":"string","description":"Unique key of the attribute."},"metadata":{"$ref":"#/components/schemas/SchemaAttributeMetadata"},"values":{"type":"array","description":"List of available values for the attribute. Only valid for `ENUM` and `REFERENCE` types.","items":{"$ref":"#/components/schemas/SchemaAttributeValue"}}}},"SchemaAttributeMetadata":{"type":"object","description":"Metadata of the schema attribute.","properties":{"readOnly":{"type":"boolean","description":"Whether the attribute is read-only or not."},"localized":{"$ref":"#/components/schemas/Localized"},"required":{"type":"boolean","description":"Whether the attribute is required or not. Attributes of 'BOOLEAN' type cannot be required."},"nullable":{"type":"boolean","description":"Whether the attribute could accept null or not."}}},"Localized":{"type":"boolean","description":"Whether the attribute is localized or not. Only attributes of 'TEXT' type can be localized."},"SchemaAttributeValue":{"type":"object","description":"Value of the attribute. Valid for `ENUM` and `REFERENCE` types.\n\nFor `ENUM` type, the value represents one of the allowed enum values.\n\nFor `REFERENCE` type, the value represents the reference type (e.g., `PRODUCT`, `ORDER`, `ORDER_ENTRY`, `CART`, `CART_ITEM`, `PRICE`, `CUSTOMER`, `COMPANY`, `MEDIA`, `PRICE_LIST`, `CUSTOMER_SEGMENT`, `CATEGORY`, or any custom schema type).\n","properties":{"value":{"type":"string"}},"required":["value"]},"SchemaMetadataUpdate":{"type":"object","properties":{"version":{"type":"number","description":"Version of the object. The value is required during update operation."}}}}}}
```

## The AbstractSchemaResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"AbstractSchemaResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the schema."},"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"types":{"type":"array","description":"List of types to which schema should be assigned.","items":{"$ref":"#/components/schemas/SchemaType"}},"metadata":{"allOf":[{"$ref":"#/components/schemas/SchemaMetadata"}]}}},"SchemaType":{"type":"string","description":"Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.","enum":["CART","CART_ITEM","CATEGORY","COMPANY","COUPON","CUSTOMER","CUSTOMER_ADDRESS","ORDER","ORDER_ENTRY","PRODUCT","QUOTE","RETURN","PRICE_LIST","SITE","CUSTOM_ENTITY","VENDOR"]},"SchemaMetadata":{"allOf":[{"$ref":"#/components/schemas/SchemaMetadataUpdate"},{"type":"object","description":"Metadata of schema.","properties":{"url":{"type":"string","description":"Schema url of the attributes."},"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"}}}]},"SchemaMetadataUpdate":{"type":"object","properties":{"version":{"type":"number","description":"Version of the object. The value is required during update operation."}}}}}}
```

## The SchemaResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemaResponse":{"allOf":[{"$ref":"#/components/schemas/AbstractSchemaResponse"},{"type":"object","properties":{"attributes":{"type":"array","description":"List of attributes related to the schema.","items":{"$ref":"#/components/schemas/SchemaAttribute"}}}}]},"AbstractSchemaResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the schema."},"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"types":{"type":"array","description":"List of types to which schema should be assigned.","items":{"$ref":"#/components/schemas/SchemaType"}},"metadata":{"allOf":[{"$ref":"#/components/schemas/SchemaMetadata"}]}}},"SchemaType":{"type":"string","description":"Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.","enum":["CART","CART_ITEM","CATEGORY","COMPANY","COUPON","CUSTOMER","CUSTOMER_ADDRESS","ORDER","ORDER_ENTRY","PRODUCT","QUOTE","RETURN","PRICE_LIST","SITE","CUSTOM_ENTITY","VENDOR"]},"SchemaMetadata":{"allOf":[{"$ref":"#/components/schemas/SchemaMetadataUpdate"},{"type":"object","description":"Metadata of schema.","properties":{"url":{"type":"string","description":"Schema url of the attributes."},"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"}}}]},"SchemaMetadataUpdate":{"type":"object","properties":{"version":{"type":"number","description":"Version of the object. The value is required during update operation."}}},"SchemaAttribute":{"type":"object","description":"Schema attribute.","properties":{"key":{"type":"string","description":"Unique key of the attribute."},"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"description":{"type":"object","description":"Localized schema description in a form of a map of translations."},"type":{"$ref":"#/components/schemas/SchemaAttributeType"},"metadata":{"$ref":"#/components/schemas/SchemaAttributeMetadata"},"values":{"type":"array","description":"List of available values for the attribute. Only valid for `ENUM` and `REFERENCE` type.","items":{"$ref":"#/components/schemas/SchemaAttributeValue"}},"attributes":{"type":"array","description":"Object's properties. It can only be provided for attribute of `OBJECT` type.","items":{"$ref":"#/components/schemas/SchemaAttribute"}},"arrayType":{"type":"object","description":"Contains information about the type used inside an array. It can only be provided for attribute of `ARRAY` type.","properties":{"type":{"$ref":"#/components/schemas/SchemaAttributeType"},"values":{"type":"array","description":"List of available values for the attribute. Only valid for `ENUM` and `REFERENCE` type.","items":{"$ref":"#/components/schemas/SchemaAttributeValue"}},"localized":{"$ref":"#/components/schemas/Localized"}},"required":["type"]}},"required":["key","name","type","metadata"]},"SchemaAttributeType":{"type":"string","description":"Type of the attribute.\n\n**Note**: The `REFERENCE` type is only available for custom schema types.\n","enum":["TEXT","NUMBER","DECIMAL","BOOLEAN","DATE","TIME","DATE_TIME","ENUM","ARRAY","OBJECT","REFERENCE"]},"SchemaAttributeMetadata":{"type":"object","description":"Metadata of the schema attribute.","properties":{"readOnly":{"type":"boolean","description":"Whether the attribute is read-only or not."},"localized":{"$ref":"#/components/schemas/Localized"},"required":{"type":"boolean","description":"Whether the attribute is required or not. Attributes of 'BOOLEAN' type cannot be required."},"nullable":{"type":"boolean","description":"Whether the attribute could accept null or not."}}},"Localized":{"type":"boolean","description":"Whether the attribute is localized or not. Only attributes of 'TEXT' type can be localized."},"SchemaAttributeValue":{"type":"object","description":"Value of the attribute. Valid for `ENUM` and `REFERENCE` types.\n\nFor `ENUM` type, the value represents one of the allowed enum values.\n\nFor `REFERENCE` type, the value represents the reference type (e.g., `PRODUCT`, `ORDER`, `ORDER_ENTRY`, `CART`, `CART_ITEM`, `PRICE`, `CUSTOMER`, `COMPANY`, `MEDIA`, `PRICE_LIST`, `CUSTOMER_SEGMENT`, `CATEGORY`, or any custom schema type).\n","properties":{"value":{"type":"string"}},"required":["value"]}}}}
```

## The SchemasResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"SchemasResponse":{"type":"array","items":{"$ref":"#/components/schemas/SchemaResponse"}},"SchemaResponse":{"allOf":[{"$ref":"#/components/schemas/AbstractSchemaResponse"},{"type":"object","properties":{"attributes":{"type":"array","description":"List of attributes related to the schema.","items":{"$ref":"#/components/schemas/SchemaAttribute"}}}}]},"AbstractSchemaResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the schema."},"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"types":{"type":"array","description":"List of types to which schema should be assigned.","items":{"$ref":"#/components/schemas/SchemaType"}},"metadata":{"allOf":[{"$ref":"#/components/schemas/SchemaMetadata"}]}}},"SchemaType":{"type":"string","description":"Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.","enum":["CART","CART_ITEM","CATEGORY","COMPANY","COUPON","CUSTOMER","CUSTOMER_ADDRESS","ORDER","ORDER_ENTRY","PRODUCT","QUOTE","RETURN","PRICE_LIST","SITE","CUSTOM_ENTITY","VENDOR"]},"SchemaMetadata":{"allOf":[{"$ref":"#/components/schemas/SchemaMetadataUpdate"},{"type":"object","description":"Metadata of schema.","properties":{"url":{"type":"string","description":"Schema url of the attributes."},"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"}}}]},"SchemaMetadataUpdate":{"type":"object","properties":{"version":{"type":"number","description":"Version of the object. The value is required during update operation."}}},"SchemaAttribute":{"type":"object","description":"Schema attribute.","properties":{"key":{"type":"string","description":"Unique key of the attribute."},"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"description":{"type":"object","description":"Localized schema description in a form of a map of translations."},"type":{"$ref":"#/components/schemas/SchemaAttributeType"},"metadata":{"$ref":"#/components/schemas/SchemaAttributeMetadata"},"values":{"type":"array","description":"List of available values for the attribute. Only valid for `ENUM` and `REFERENCE` type.","items":{"$ref":"#/components/schemas/SchemaAttributeValue"}},"attributes":{"type":"array","description":"Object's properties. It can only be provided for attribute of `OBJECT` type.","items":{"$ref":"#/components/schemas/SchemaAttribute"}},"arrayType":{"type":"object","description":"Contains information about the type used inside an array. It can only be provided for attribute of `ARRAY` type.","properties":{"type":{"$ref":"#/components/schemas/SchemaAttributeType"},"values":{"type":"array","description":"List of available values for the attribute. Only valid for `ENUM` and `REFERENCE` type.","items":{"$ref":"#/components/schemas/SchemaAttributeValue"}},"localized":{"$ref":"#/components/schemas/Localized"}},"required":["type"]}},"required":["key","name","type","metadata"]},"SchemaAttributeType":{"type":"string","description":"Type of the attribute.\n\n**Note**: The `REFERENCE` type is only available for custom schema types.\n","enum":["TEXT","NUMBER","DECIMAL","BOOLEAN","DATE","TIME","DATE_TIME","ENUM","ARRAY","OBJECT","REFERENCE"]},"SchemaAttributeMetadata":{"type":"object","description":"Metadata of the schema attribute.","properties":{"readOnly":{"type":"boolean","description":"Whether the attribute is read-only or not."},"localized":{"$ref":"#/components/schemas/Localized"},"required":{"type":"boolean","description":"Whether the attribute is required or not. Attributes of 'BOOLEAN' type cannot be required."},"nullable":{"type":"boolean","description":"Whether the attribute could accept null or not."}}},"Localized":{"type":"boolean","description":"Whether the attribute is localized or not. Only attributes of 'TEXT' type can be localized."},"SchemaAttributeValue":{"type":"object","description":"Value of the attribute. Valid for `ENUM` and `REFERENCE` types.\n\nFor `ENUM` type, the value represents one of the allowed enum values.\n\nFor `REFERENCE` type, the value represents the reference type (e.g., `PRODUCT`, `ORDER`, `ORDER_ENTRY`, `CART`, `CART_ITEM`, `PRICE`, `CUSTOMER`, `COMPANY`, `MEDIA`, `PRICE_LIST`, `CUSTOMER_SEGMENT`, `CATEGORY`, or any custom schema type).\n","properties":{"value":{"type":"string"}},"required":["value"]}}}}
```

## The ReferenceResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"ReferenceResponse":{"allOf":[{"$ref":"#/components/schemas/AbstractSchemaResponse"}]},"AbstractSchemaResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the schema."},"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"types":{"type":"array","description":"List of types to which schema should be assigned.","items":{"$ref":"#/components/schemas/SchemaType"}},"metadata":{"allOf":[{"$ref":"#/components/schemas/SchemaMetadata"}]}}},"SchemaType":{"type":"string","description":"Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.","enum":["CART","CART_ITEM","CATEGORY","COMPANY","COUPON","CUSTOMER","CUSTOMER_ADDRESS","ORDER","ORDER_ENTRY","PRODUCT","QUOTE","RETURN","PRICE_LIST","SITE","CUSTOM_ENTITY","VENDOR"]},"SchemaMetadata":{"allOf":[{"$ref":"#/components/schemas/SchemaMetadataUpdate"},{"type":"object","description":"Metadata of schema.","properties":{"url":{"type":"string","description":"Schema url of the attributes."},"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"}}}]},"SchemaMetadataUpdate":{"type":"object","properties":{"version":{"type":"number","description":"Version of the object. The value is required during update operation."}}}}}}
```

## The ReferencesResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"ReferencesResponse":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceResponse"}},"ReferenceResponse":{"allOf":[{"$ref":"#/components/schemas/AbstractSchemaResponse"}]},"AbstractSchemaResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the schema."},"name":{"type":"object","description":"Localized schema name in a form of a map of translations."},"types":{"type":"array","description":"List of types to which schema should be assigned.","items":{"$ref":"#/components/schemas/SchemaType"}},"metadata":{"allOf":[{"$ref":"#/components/schemas/SchemaMetadata"}]}}},"SchemaType":{"type":"string","description":"Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.","enum":["CART","CART_ITEM","CATEGORY","COMPANY","COUPON","CUSTOMER","CUSTOMER_ADDRESS","ORDER","ORDER_ENTRY","PRODUCT","QUOTE","RETURN","PRICE_LIST","SITE","CUSTOM_ENTITY","VENDOR"]},"SchemaMetadata":{"allOf":[{"$ref":"#/components/schemas/SchemaMetadataUpdate"},{"type":"object","description":"Metadata of schema.","properties":{"url":{"type":"string","description":"Schema url of the attributes."},"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"}}}]},"SchemaMetadataUpdate":{"type":"object","properties":{"version":{"type":"number","description":"Version of the object. The value is required during update operation."}}}}}}
```

## The TypesResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"TypesResponse":{"type":"array","items":{"type":"string"}}}}}
```

## The CustomSchemaTypeCreation object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"CustomSchemaTypeCreation":{"type":"object","properties":{"id":{"type":"string","description":"Unique code for the custom type. Can only contain uppercase letters and underscores."},"name":{"type":"object","description":"Localized custom type name in a form of a map of translations."}},"required":["id","name"]}}}}
```

## The CustomSchemaTypeUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"CustomSchemaTypeUpdate":{"type":"object","properties":{"name":{"type":"object","description":"Localized custom type name in a form of a map of translations."},"metadata":{"type":"object","properties":{"version":{"type":"integer","description":"Version of the custom schema type. If provided, it will be validated against the current entity version."}}}},"required":["name"]}}}}
```

## The CustomSchemaTypeResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"CustomSchemaTypeResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique id of the custom schema type."},"name":{"type":"object","description":"Localized custom type name in a form of a map of translations."},"schemas":{"type":"object","description":"Information about associated schemas. This field is only included if `expandSchemas` is set to `true`"},"metadata":{"type":"object","properties":{"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"version":{"type":"integer"}}}}}}}}
```

## The CustomSchemaTypesResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"CustomSchemaTypesResponse":{"type":"array","items":{"$ref":"#/components/schemas/CustomSchemaTypeResponse"}},"CustomSchemaTypeResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique id of the custom schema type."},"name":{"type":"object","description":"Localized custom type name in a form of a map of translations."},"schemas":{"type":"object","description":"Information about associated schemas. This field is only included if `expandSchemas` is set to `true`"},"metadata":{"type":"object","properties":{"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"version":{"type":"integer"}}}}}}}}
```

## The CustomInstanceCreation object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"CustomInstanceCreation":{"type":"object","properties":{"id":{"type":"string","description":"Id of the custom instance."},"name":{"type":"object","description":"Localized custom type name in a form of a map of translations."},"mixins":{"type":"string","description":"A key-value map of additional attributes."},"metadata":{"type":"object","properties":{"mixins":{"type":"object","description":"A key-value map, where key is a mixin name and value is a link to the mixin schema."}}}}}}}}
```

## The CustomInstanceUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"CustomInstanceUpdate":{"type":"object","properties":{"name":{"type":"object","description":"Localized custom type name in a form of a map of translations."},"mixins":{"type":"string","description":"A key-value map of additional attributes."},"metadata":{"type":"object","properties":{"version":{"type":"integer","description":"Version of the custom instance.  If provided, it will be validated against the current entity version."},"mixins":{"type":"object","description":"A key-value map, where key is a mixin name and value is a link to the mixin schema."}}}}}}}}
```

## The CustomInstanceResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"CustomInstanceResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the custom instance."},"name":{"type":"object","description":"Localized custom type name in a form of a map of translations."},"type":{"type":"string","description":"Custom schema type to which custom instance is related."},"mixins":{"type":"string","description":"A key-value map of additional attributes."},"media":{"type":"array","description":"List of media IDs assigned to the custom instance.","items":{"type":"string"}},"metadata":{"allOf":[{"$ref":"#/components/schemas/CustomInstanceMetadata"}]}}},"CustomInstanceMetadata":{"type":"object","properties":{"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"version":{"type":"integer","description":"Version of the custom instance."},"mixins":{"type":"object","description":"A key-value map, where key is a mixin name and value is a link to the mixin schema."}}}}}}
```

## The CustomInstancesResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"CustomInstancesResponse":{"type":"array","items":{"$ref":"#/components/schemas/CustomInstanceResponse"}},"CustomInstanceResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the custom instance."},"name":{"type":"object","description":"Localized custom type name in a form of a map of translations."},"type":{"type":"string","description":"Custom schema type to which custom instance is related."},"mixins":{"type":"string","description":"A key-value map of additional attributes."},"media":{"type":"array","description":"List of media IDs assigned to the custom instance.","items":{"type":"string"}},"metadata":{"allOf":[{"$ref":"#/components/schemas/CustomInstanceMetadata"}]}}},"CustomInstanceMetadata":{"type":"object","properties":{"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"version":{"type":"integer","description":"Version of the custom instance."},"mixins":{"type":"object","description":"A key-value map, where key is a mixin name and value is a link to the mixin schema."}}}}}}
```

## The BulkResponse object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"BulkResponse":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"Index of the processed item, matching the item position in request body."},"code":{"type":"integer","description":"HTTP Status Code."},"status":{"type":"string","description":"HTTP Status description"},"message":{"type":"string","description":"Error message."},"details":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Error details."}}}}}}}}}}
```

## The CustomInstanceMetadata object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"CustomInstanceMetadata":{"type":"object","properties":{"createdAt":{"type":"string","description":"Date and time when the object was created, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"modifiedAt":{"type":"string","description":"Date and time when the object was last modified, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`"},"version":{"type":"integer","description":"Version of the custom instance."},"mixins":{"type":"object","description":"A key-value map, where key is a mixin name and value is a link to the mixin schema."}}}}}}
```

## The PatchOperation object

```json
{"openapi":"3.0.1","info":{"title":"Schema Service","version":"0.0.1"},"components":{"schemas":{"PatchOperation":{"type":"object","properties":{"op":{"type":"string","enum":["add","remove","replace"],"description":"Indicates an operation which should be done on a return. Available operations: `add` `remove` and `replace`"},"path":{"type":"string","description":"Indicates a path for which the value should be applied. For example:`/mixins/additionalAttributes/externalId` or `/name`"},"value":{"oneOf":[{"type":"object"},{"type":"string"},{"type":"number"}],"description":"Indicates a value that should be changed or added. The value can be of a primitive type, like string, number, boolean or it can be an object or an array."}},"required":["op","path"]}}}}
```