# Get schema
- Operation ID: `getSchemaById`
- HTTP method: `GET`
- Path: `/brickworks/v1/schemas/{SchemaIdentifier}`
- [Human-readable API reference](https://hub.synerise.com/api-reference/brickworks#tag/Brickworks:-Schemas/operation/getSchemaById)
## Self-contained OpenAPI method
The fenced document below contains this method's documentation and all of its local references. It is self-contained; no category or master specification fetch is required.
````yaml
openapi: 3.0.0
info:
title: Synerise Public API
version: 1.9.1
paths:
/brickworks/v1/schemas/{SchemaIdentifier}:
get:
tags:
- "Brickworks: Schemas"
summary: Get schema
description: |
Retrieve the details of a schema.
---
**API consumers:** Synerise User, Workspace (Business Profile)
**API key permission required:** `BRICKWORKS_SCHEMAS_READ`
**User role permission required:** `assets_brickworks: read`
operationId: getSchemaById
security:
- JWT: []
parameters:
- name: SchemaIdentifier
in: path
required: true
description: Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)
schema:
oneOf:
- type: string
format: uuid
title: Schema UUID
- type: string
minLength: 3
maxLength: 25
pattern: ^(?!__)(?![0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)[\w\-]+$
title: Schema AppId
examples:
uuid:
value: 550e8400-e29b-41d4-a716-446655440000
summary: Schema UUID
appId:
value: my_schema_app_id
summary: Schema AppId (API name)
responses:
"200":
description: Details of the schema
content:
application/json:
schema:
type: object
x-class-name: Schema
x-interface-name-ts: Schema
description: Schema object
required:
- id
- appId
- displayName
- createdBy
- updatedBy
- createdAt
- updatedAt
- audience
properties:
id:
type: string
format: uuid
description: Unique ID of the schema, generated automatically.
appId:
type: string
description: |
App ID of the schema. This is used as the identifier of the schema and must be unique. This ID cannot be changed after the schema is created.
In the Synerise Portal, this parameter is called **API name**.
displayName:
type: string
description: Schema name shown to users in the Synerise Portal
description:
type: string
description: Schema description
fields:
type: object
x-class-name: FieldsObject
x-interface-name-ts: FieldsObject
description: The content of the schema.
properties:
type:
type: string
description: The root field of the schema is always an object, and it includes all the other fields.
enum:
- object
properties:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
type: object
x-class-name: FieldForm
x-interface-name-ts: FieldForm
description: Each key is the name of a field (called "API name" in the Synerise Portal).
oneOf:
- type: object
title: Number
x-class-name: NumberForm
x-interface-name-ts: NumberForm
description: This field type accepts static numeric values. `number` is used for floating-point values.
properties:
type:
type: string
title: Number type
x-class-name: NumberType
x-interface-name-ts: NumberType
enum:
- number
subtype:
type: string
x-class-name: NumberSubtype
x-interface-name-ts: NumberSubtype
enum:
- number
minimum:
type: number
format: float
description: Minimum value
maximum:
type: number
format: float
description: Maximum value
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: number
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Integer
x-class-name: IntegerForm
x-interface-name-ts: IntegerForm
properties:
type:
type: string
title: IntegerType
x-class-name: IntegerType
x-interface-name-ts: IntegerType
enum:
- integer
subtype:
type: string
x-class-name: IntegerSubtype
x-interface-name-ts: IntegerSubtype
enum:
- integer
minimum:
type: number
format: int32
description: Minimum value
maximum:
type: number
format: int32
description: Maximum value
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: number
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Enumeration
x-class-name: EnumForm
x-interface-name-ts: EnumForm
description: This type of field defines a list of strings which can be used as the value. Only one of the allowed values can be saved in the record.
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: EnumSubtype
x-interface-name-ts: EnumSubtype
enum:
- enum
enum:
type: array
description: A list of strings which can be selected as the value
items:
type: string
names:
type: object
description: |
A mapping of the field values and their names displayed in the record.
For example, if `enum` contains the value `exampleValue` and you want the UI to show `Example Value` on the list, set:
```
"names": {
"exampleValue": "Example Value"
}
```
additionalProperties:
type: string
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- enum
- names
- type: object
title: Date
x-class-name: DateForm
x-interface-name-ts: DateForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: DateSubtype
x-interface-name-ts: DateSubtype
enum:
- date
default:
type: string
format: date
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Date and time
x-class-name: DateTimeForm
x-interface-name-ts: DateTimeForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: DateTimeSubtype
x-interface-name-ts: DateTimeSubtype
enum:
- date-time
default:
type: string
format: date-time
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Array
x-class-name: ArrayForm
x-interface-name-ts: ArrayForm
description: This type of field accepts an array of values. The type of values is defined in `items`
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: TypedArraySubtype
x-interface-name-ts: TypedArraySubtype
enum:
- typed_array
items:
type: object
description: The definition of the type of value allowed in the array. All values must be of the same type.
oneOf:
- type: object
title: Number
x-class-name: NumberForm
x-interface-name-ts: NumberForm
description: This field type accepts static numeric values. `number` is used for floating-point values.
properties:
type:
type: string
title: Number type
x-class-name: NumberType
x-interface-name-ts: NumberType
enum:
- number
subtype:
type: string
x-class-name: NumberSubtype
x-interface-name-ts: NumberSubtype
enum:
- number
minimum:
type: number
format: float
description: Minimum value
maximum:
type: number
format: float
description: Maximum value
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: number
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Integer
x-class-name: IntegerForm
x-interface-name-ts: IntegerForm
properties:
type:
type: string
title: IntegerType
x-class-name: IntegerType
x-interface-name-ts: IntegerType
enum:
- integer
subtype:
type: string
x-class-name: IntegerSubtype
x-interface-name-ts: IntegerSubtype
enum:
- integer
minimum:
type: number
format: int32
description: Minimum value
maximum:
type: number
format: int32
description: Maximum value
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: number
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Enumeration
x-class-name: EnumForm
x-interface-name-ts: EnumForm
description: This type of field defines a list of strings which can be used as the value. Only one of the allowed values can be saved in the record.
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: EnumSubtype
x-interface-name-ts: EnumSubtype
enum:
- enum
enum:
type: array
description: A list of strings which can be selected as the value
items:
type: string
names:
type: object
description: |
A mapping of the field values and their names displayed in the record.
For example, if `enum` contains the value `exampleValue` and you want the UI to show `Example Value` on the list, set:
```
"names": {
"exampleValue": "Example Value"
}
```
additionalProperties:
type: string
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- enum
- names
discriminator:
propertyName: subtype
mapping:
number: "#/components/schemas/brickworks-service-NumberForm"
integer: "#/components/schemas/brickworks-service-IntegerForm"
boolean: "#/components/schemas/brickworks-service-BooleanForm"
string: "#/components/schemas/brickworks-service-StringForm"
enum: "#/components/schemas/brickworks-service-EnumForm"
maxItems:
type: number
format: int32
description: The maximum number of items allowed in the array
uniqueItems:
type: boolean
description: When `true`, the values in the array must be unique
default:
type: array
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
items: {}
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- items
- subtype
- type: object
title: UUID
x-class-name: UUIDForm
x-interface-name-ts: UUIDForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: UUIDSubtype
x-interface-name-ts: UUIDSubtype
enum:
- uuid
default:
type: string
format: uuid
title: UUID default
x-class-name: UUIDFormDefault
x-interface-name-ts: UUIDFormDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Jinjava
x-class-name: JinJavaForm
x-interface-name-ts: JinJavaForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: JinJavaSubtype
x-interface-name-ts: JinJavaSubtype
enum:
- jinjava
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
settings:
type: object
x-class-name: JinJavaSettings
x-interface-name-ts: JinJavaSettings
nullable: true
description: Settings for casting the Jinjava result to a data type. Casting may not be successful - set the `strict` setting to decide how to proceed in that case.
properties:
castType:
type: string
description: The data type to try casting the Jinjava result to
x-class-name: JinJavaCastType
x-interface-name-ts: JinJavaCastType
enum:
- boolean
- integer
- number
- json
strict:
type: boolean
description: |
Defines what happens when casting is not successful:
- `true` throws an error in generating an object from a record
- `false` sets the value to null
removeWhitespaces:
type: boolean
description: |
When `true`, all whitespace characters (e.g. `\r`, `\n`, spaces, tabs) are removed from the Jinjava render result before casting.
required:
- strict
- castType
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Catalog
x-class-name: CatalogItemField
x-interface-name-ts: CatalogItemField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: CatalogItemSubtype
x-interface-name-ts: CatalogItemSubtype
enum:
- catalog_item
properties:
type: object
title: CatalogItemFieldProperties
description: |
The data of the catalog. `id` is the default catalogId and `itemKey` is the default unique identifier of an item. You can override both when creating/updating a record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
itemKey:
oneOf:
- type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Jinjava
x-class-name: JinJavaForm
x-interface-name-ts: JinJavaForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: JinJavaSubtype
x-interface-name-ts: JinJavaSubtype
enum:
- jinjava
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
settings:
type: object
x-class-name: JinJavaSettings
x-interface-name-ts: JinJavaSettings
nullable: true
description: Settings for casting the Jinjava result to a data type. Casting may not be successful - set the `strict` setting to decide how to proceed in that case.
properties:
castType:
type: string
description: The data type to try casting the Jinjava result to
x-class-name: JinJavaCastType
x-interface-name-ts: JinJavaCastType
enum:
- boolean
- integer
- number
- json
strict:
type: boolean
description: |
Defines what happens when casting is not successful:
- `true` throws an error in generating an object from a record
- `false` sets the value to null
removeWhitespaces:
type: boolean
description: |
When `true`, all whitespace characters (e.g. `\r`, `\n`, spaces, tabs) are removed from the Jinjava render result before casting.
required:
- strict
- castType
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
discriminator:
propertyName: subtype
mapping:
jinjava: "#/components/schemas/brickworks-service-JinJavaForm"
string: "#/components/schemas/brickworks-service-StringForm"
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- itemKey
default:
type: object
title: Catalog default
x-class-name: CatalogFieldDefault
x-interface-name-ts: CatalogFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique ID of a catalog
itemKey:
type: string
description: Static string or Jinjava that inserts the unique ID of an item in the catalog
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
- type: object
title: External source
x-class-name: ExternalSourceField
x-interface-name-ts: ExternalSourceField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: ExternalSourceSubtype
x-interface-name-ts: ExternalSourceSubtype
enum:
- external_source
sourceType:
type: string
enum:
- http
sourceId:
type: string
description: Unique ID of the external source definition
format: uuid
headers:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
body:
$ref: "#/components/schemas/brickworks-service-FieldForm"
properties:
type: object
x-class-name: ExternalSourceFieldProperties
x-interface-name-ts: ExternalSourceFieldProperties
description: Behavior of the external source field when the source call fails. `returnErrorBodyOnFail` takes precedence over `nullOnFail` for received error responses.
properties:
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
returnErrorBodyOnFail:
type: boolean
nullable: true
description: |
Defines what happens when the external source responds with an error (non-2xx) status:
- `true` — instead of failing the generate request (or returning null when `nullOnFail` is enabled), the field resolves to a JSON object with the error details: `response.status`, `response.body`, `request.url`, `request.method`, `request.body`. Useful for debugging and for building a custom flow based on errors.
- `false` (default, also when absent or null) — standard behavior applies: `nullOnFail` decides between failing the request and a null field value.
Covers only received HTTP responses. Connection-level failures (e.g. timeouts) and a missing external source definition still fail the request.
required:
- nullOnFail
default:
type: object
title: External source default
x-class-name: ExternalHttpSourceDefault
x-interface-name-ts: ExternalHttpSourceDefault
nullable: true
properties:
headers:
type: object
description: Request headers
additionalProperties: true
params:
type: object
description: The url parameters
additionalProperties: true
body:
type: object
description: Request body
additionalProperties: true
properties:
type: object
title: External source properties
x-class-name: ExternalHttpSourcePropertiesValues
x-interface-name-ts: ExternalHttpSourcePropertiesValues
properties:
nullOnFail:
type: boolean
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- sourceType
- sourceId
- type: object
title: Record reference
x-class-name: ReferenceForm
x-interface-name-ts: ReferenceForm
description: Definition of a reference to another schema
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: OneToOneSubtype
x-interface-name-ts: OneToOneSubtype
description: |
This field type lets you include references to a record from another schema. To generate an object, the referenced record must be published. Its content (for example, an expression field in the referenced record) will be processed when generating an object.
enum:
- one_to_one
referenceId:
type: string
description: Unique identifier of the schema you want to access a record from. When creating a record with this field, you will provide the UUID of the referenced record from that schema.
default:
type: string
format: uuid
description: The default record to reference. In "one to many" fields, use the `default` array in the parent object instead of this property.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Multiple record reference
x-class-name: OneToManyForm
x-interface-name-ts: OneToManyForm
description: This type of field allows you to reference multiple records from another schema. `items` defines the target schema.
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: OneToManySubtype
x-interface-name-ts: OneToManySubtype
enum:
- one_to_many
items:
type: object
title: Record reference
x-class-name: ReferenceForm
x-interface-name-ts: ReferenceForm
description: Definition of a reference to another schema
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: OneToOneSubtype
x-interface-name-ts: OneToOneSubtype
description: |
This field type lets you include references to a record from another schema. To generate an object, the referenced record must be published. Its content (for example, an expression field in the referenced record) will be processed when generating an object.
enum:
- one_to_one
referenceId:
type: string
description: Unique identifier of the schema you want to access a record from. When creating a record with this field, you will provide the UUID of the referenced record from that schema.
default:
type: string
format: uuid
description: The default record to reference. In "one to many" fields, use the `default` array in the parent object instead of this property.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
maxItems:
type: number
minimum: 1
maximum: 100
default: 20
description: The maximum number of records that can be referenced.
default:
type: array
description: An array of default record references (record UUIDs)
items:
type: string
format: uuid
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- items
- subtype
- type: object
description: Reference to a Synerise analysis
title: Metric
x-class-name: MetricField
x-interface-name-ts: MetricField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: MetricSubtype
x-interface-name-ts: MetricSubtype
enum:
- metric
properties:
type: object
description: |
- `id` is the default ID of an metric.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Metric default
x-class-name: MetricFieldDefault
x-interface-name-ts: MetricFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Aggregate
x-class-name: AggregateField
x-interface-name-ts: AggregateField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: AggregateSubtype
x-interface-name-ts: AggregateSubtype
enum:
- aggregate
properties:
type: object
description: |
- `id` is the default ID of an analysis.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Aggregate default
x-class-name: AggregateFieldDefault
x-interface-name-ts: AggregateFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Expression
x-class-name: ExpressionField
x-interface-name-ts: ExpressionField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: ExpressionSubtype
x-interface-name-ts: ExpressionSubtype
enum:
- expression
properties:
type: object
description: |
- `id` is the default ID of an expression.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
x-class-name: ExpressionFieldDefault
x-interface-name-ts: ExpressionFieldDefault
title: Expression default
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Promotion
x-class-name: PromotionField
x-interface-name-ts: PromotionField
description: Reference to a promotion
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: PromotionSubtype
x-interface-name-ts: PromotionSubtype
enum:
- promotion
properties:
type: object
x-class-name: PromotionFieldProperties
x-interface-name-ts: PromotionFieldProperties
description: "`id` defines the promotion to access. In `default`, enter the default promotion UUID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Promotion default
x-class-name: PromotionFieldDefault
x-interface-name-ts: PromotionFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of a promotion campaign
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: File
x-class-name: FileField
x-interface-name-ts: FileField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: FileSubtype
x-interface-name-ts: FileSubtype
description: This type of field lets you store links to [files uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/).
enum:
- file
properties:
type: object
x-class-name: FileFieldProperties
x-interface-name-ts: FileFieldProperties
description: "`id` defines the unique ID of a [file uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/). In `default`, enter the default file ID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
default:
type: object
title: File default
x-class-name: FileFieldDefault
x-interface-name-ts: FileFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique identifier of an image/file in the File Explorer
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Image
x-class-name: ImageField
x-interface-name-ts: ImageField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
description: This type of field lets you store links to images.
enum:
- image
properties:
type: object
x-class-name: FileFieldProperties
x-interface-name-ts: FileFieldProperties
description: "`id` defines the unique ID of a [file uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/). In `default`, enter the default file ID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
default:
type: object
title: Image default
x-class-name: ImageFieldDefault
x-interface-name-ts: ImageFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique identifier of an image/file in the File Explorer
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Recommendation
x-class-name: RecommendationField
x-interface-name-ts: RecommendationField
description: Reference to a recommendation campaign
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: RecommendationSubtype
x-interface-name-ts: RecommendationSubtype
description: This type of field lets you retrieve the result of a recommendation campaign.
enum:
- recommendation
properties:
type: object
title: Recommendation properties
x-class-name: RecommendationFieldProperties
x-interface-name-ts: RecommendationFieldProperties
description: |
- `id.default` defines the default recommendation campaign to generate a recommendation from.
- In `params.itemId`, you can add a default item context (required by some recommendation types):
```
"itemId": {
"type": "string",
"subtype": "string"
"default": "defaultItemIdForItemContext"
}
```
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Recommendation default
x-class-name: RecommendationFieldDefault
x-interface-name-ts: RecommendationFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of a recommendation campaign
params:
type: object
title: Recommendation default params
x-class-name: RecommendationFieldDefaultParams
x-interface-name-ts: RecommendationFieldDefaultParams
description: Item context
properties:
itemId:
type: string
description: Unique ID of an item context (required for some recommendation types)
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: AI Search
x-class-name: AiSearchField
x-interface-name-ts: AiSearchField
description: Reference to an AI Search index used to perform a search query
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: AiSearchSubtype
x-interface-name-ts: AiSearchSubtype
description: This type of field lets you retrieve results of an AI Search query against a chosen index.
enum:
- ai_search
properties:
type: object
title: AI Search properties
x-class-name: AiSearchFieldProperties
x-interface-name-ts: AiSearchFieldProperties
description: |
- `id.default` defines the default AI Search index used to perform the search.
- `query.default` defines the default search phrase (accepts a string or a Jinjava expression).
- In `params`, you can declare additional query parameters supported by the AI Search API
(e.g. `filters`, `facets`, `displayAttributes`, `personalize`).
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
query:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- query
default:
type: object
title: AI Search default
x-class-name: AiSearchFieldDefault
x-interface-name-ts: AiSearchFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- Set to `null` (or omit) to declare no default at all.
- Send an empty object `{}` to declare an empty default — it is merged with the record value, or applied directly when the record does not provide one.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of the AI Search index
query:
type: string
description: Default search query phrase
params:
type: object
title: AI Search default params
x-class-name: AiSearchFieldDefaultParams
x-interface-name-ts: AiSearchFieldDefaultParams
description: Additional default query parameters
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: AI Listing
x-class-name: AiSearchListingField
x-interface-name-ts: AiSearchListingField
description: Reference to an AI Search index used to retrieve a listing (no query phrase)
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: AiSearchListingSubtype
x-interface-name-ts: AiSearchListingSubtype
description: This type of field lets you retrieve listing results from an AI Search index (without a query phrase).
enum:
- ai_search_listing
properties:
type: object
title: AI Listing properties
x-class-name: AiSearchListingFieldProperties
x-interface-name-ts: AiSearchListingFieldProperties
description: |
- `id.default` defines the default AI Search index used to fetch the listing.
- In `params`, you can declare additional query parameters supported by the AI Search listing API
(e.g. `filters`, `facets`, `displayAttributes`, `personalize`).
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: AI Listing default
x-class-name: AiSearchListingFieldDefault
x-interface-name-ts: AiSearchListingFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- Set to `null` (or omit) to declare no default at all.
- Send an empty object `{}` to declare an empty default — it is merged with the record value, or applied directly when the record does not provide one.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of the AI Search index
params:
type: object
title: AI Listing default params
x-class-name: AiSearchListingFieldDefaultParams
x-interface-name-ts: AiSearchListingFieldDefaultParams
description: Additional default query parameters
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Voucher
x-class-name: VoucherField
x-interface-name-ts: VoucherField
description: Reference to a voucher
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: VoucherSubtype
x-interface-name-ts: VoucherSubtype
description: This type of fields lets you retrieve a voucher from a pool. The voucher is retrieved when you generate an object from the record.
enum:
- voucher
properties:
type: object
title: Voucher properties
x-class-name: VoucherFieldProperties
x-interface-name-ts: VoucherFieldProperties
description: |
- in `id.default`, enter the UUID of the voucher pool. It can be changed per record.
- in `assign.default`:
- `false` means that once a code from a given pool is retrieved to a profile, it becomes assigned to the profile and is always returned in subsequent requests.
- `true` means that a different code is retrieved for a profile with every request. This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
assign:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- assign
default:
type: object
title: Voucher default
x-class-name: VoucherFieldDefault
x-interface-name-ts: VoucherFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of the voucher
assign:
type: boolean
description: |
- `false` means that once a code from a given pool is retrieved to a profile, it becomes assigned to the profile and is always returned in subsequent requests.
- `true` means that a different code is retrieved for a profile with every request. This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Untyped JSON
x-class-name: UntypedJson
x-interface-name-ts: UntypedJson
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: UntypedObjectSubtype
x-interface-name-ts: UntypedObjectSubtype
description: This type of field lets you save any JSON data in the record, without validating it against any schema
enum:
- untyped_object
default:
type: object
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
additionalProperties: true
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Untyped array
x-class-name: UntypedArray
x-interface-name-ts: UntypedArray
description: This type of field accepts an array of values. The values can be of any data type.
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: UntypedArraySubtype
x-interface-name-ts: UntypedArraySubtype
enum:
- untyped_array
default:
type: array
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
items: {}
maxItems:
type: number
format: int32
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
x-class-name: UntypedForm
x-interface-name-ts: UntypedForm
description: Field without typed structure
properties:
anyOf:
type: array
minItems: 2
maxItems: 2
items:
oneOf:
- type: object
title: Untyped JSON
x-class-name: UntypedJson
x-interface-name-ts: UntypedJson
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: UntypedObjectSubtype
x-interface-name-ts: UntypedObjectSubtype
description: This type of field lets you save any JSON data in the record, without validating it against any schema
enum:
- untyped_object
default:
type: object
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
additionalProperties: true
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Untyped array
x-class-name: UntypedArray
x-interface-name-ts: UntypedArray
description: This type of field accepts an array of values. The values can be of any data type.
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: UntypedArraySubtype
x-interface-name-ts: UntypedArraySubtype
enum:
- untyped_array
default:
type: array
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
items: {}
maxItems:
type: number
format: int32
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
subtype:
type: string
x-class-name: UntypedFormSubtype
x-interface-name-ts: UntypedFormSubtype
enum:
- json
default:
type: object
additionalProperties: true
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- anyOf
- subtype
- type: object
title: Profile attribute field
x-class-name: ProfileAttributeField
x-interface-name-ts: ProfileAttributeField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: ProfileAttributeSubtype
x-interface-name-ts: ProfileAttributeSubtype
description: This type of field references an attribute by name and retrieves its value.
enum:
- client_attribute
settings:
type: object
x-class-name: ProfileAttributeSettings
x-interface-name-ts: ProfileAttributeSettings
description: Additional settings of the field
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
castType:
type: string
description: The data type to try casting the attribute to
enum:
- none
- boolean
- number
- integer
- string
strict:
description: |
Defines what happens when casting is not successful:
- `true` throws an error in generating an object from a record
- `false` sets the value to null
required:
- castType
- strict
properties:
type: object
x-class-name: ProfileAttributeProperties
x-interface-name-ts: ProfileAttributeProperties
description: In `attributeName.default`, enter the default name of the profile attribute to retrieve a value from when generating content from a record
properties:
attributeName:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- attributeName
default:
type: object
title: ProfileAttributeFieldDefault
x-class-name: ProfileAttributeFieldDefault
x-interface-name-ts: ProfileAttributeFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
attributeName:
type: string
description: The name of the profile attribute to retrieve a value from when generating content from a record
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
description: Always false, don't send in requests
required:
- type
- subtype
- properties
- type: object
title: Record reference filter
x-class-name: OneToManyFilterForm
x-interface-name-ts: OneToManyFilterForm
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: OneToManyFilterSubtype
x-interface-name-ts: OneToManyFilterSubtype
enum:
- filter
description: This field type allows you to retrieve records from another schema and filter/sort them
schemaId:
type: string
format: uuid
description: Unique ID of the schema, generated automatically.
properties:
type: object
title: One to many filter properties
description: |
Definitions of the values allowed in the filter settings. If your integration flow involves using the Synerise Web Portal, you shouldn't use this object.
You can sort by these parameters:
- `id`
- `createdAt`
- `updatedAt`
x-class-name: OneToManyFilterProperties
x-interface-name-ts: OneToManyFilterProperties
properties:
query:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
sortBy:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
sortDirection:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- query
- sortBy
- sortDirection
default:
type: object
title: One to many filter form default
description: Default filter settings
x-class-name: OneToManyFilterFormDefault
x-interface-name-ts: OneToManyFilterFormDefault
properties:
query:
type: string
description: RSQL query to filter the records
sortBy:
type: string
description: The property to sort by
enum:
- id
- createdAt
- updatedAt
sortDirection:
type: string
description: Sorting direction
enum:
- asc
- desc
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
description: Field generated automatically, don't send in requests.
required:
- type
- subtype
- schemaId
- properties
- type: object
title: Synerise object array
x-class-name: SyneriseArrayForm
x-interface-name-ts: SyneriseArrayForm
description: This type of field accepts an array of Synerise objects. The type of the objects is defined in `items`. All objects must be of the same type.
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: SyneriseArraySubtype
x-interface-name-ts: SyneriseArraySubtype
description: This type of field accepts an array of Synerise objects. The type of the objects is defined in `items`.
enum:
- synerise_array
items:
type: object
title: Synerise object array item
x-class-name: SyneriseArrayFieldForm
x-interface-name-ts: SyneriseArrayFieldForm
description: The Synerise object stored in the items of a `synerise_array` field. All items of the array must be of the same type.
oneOf:
- type: object
title: File
x-class-name: FileField
x-interface-name-ts: FileField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: FileSubtype
x-interface-name-ts: FileSubtype
description: This type of field lets you store links to [files uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/).
enum:
- file
properties:
type: object
x-class-name: FileFieldProperties
x-interface-name-ts: FileFieldProperties
description: "`id` defines the unique ID of a [file uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/). In `default`, enter the default file ID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
default:
type: object
title: File default
x-class-name: FileFieldDefault
x-interface-name-ts: FileFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique identifier of an image/file in the File Explorer
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Image
x-class-name: ImageField
x-interface-name-ts: ImageField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
description: This type of field lets you store links to images.
enum:
- image
properties:
type: object
x-class-name: FileFieldProperties
x-interface-name-ts: FileFieldProperties
description: "`id` defines the unique ID of a [file uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/). In `default`, enter the default file ID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
default:
type: object
title: Image default
x-class-name: ImageFieldDefault
x-interface-name-ts: ImageFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique identifier of an image/file in the File Explorer
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Catalog
x-class-name: CatalogItemField
x-interface-name-ts: CatalogItemField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: CatalogItemSubtype
x-interface-name-ts: CatalogItemSubtype
enum:
- catalog_item
properties:
type: object
title: CatalogItemFieldProperties
description: |
The data of the catalog. `id` is the default catalogId and `itemKey` is the default unique identifier of an item. You can override both when creating/updating a record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
itemKey:
oneOf:
- type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Jinjava
x-class-name: JinJavaForm
x-interface-name-ts: JinJavaForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: JinJavaSubtype
x-interface-name-ts: JinJavaSubtype
enum:
- jinjava
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
settings:
type: object
x-class-name: JinJavaSettings
x-interface-name-ts: JinJavaSettings
nullable: true
description: Settings for casting the Jinjava result to a data type. Casting may not be successful - set the `strict` setting to decide how to proceed in that case.
properties:
castType:
type: string
description: The data type to try casting the Jinjava result to
x-class-name: JinJavaCastType
x-interface-name-ts: JinJavaCastType
enum:
- boolean
- integer
- number
- json
strict:
type: boolean
description: |
Defines what happens when casting is not successful:
- `true` throws an error in generating an object from a record
- `false` sets the value to null
removeWhitespaces:
type: boolean
description: |
When `true`, all whitespace characters (e.g. `\r`, `\n`, spaces, tabs) are removed from the Jinjava render result before casting.
required:
- strict
- castType
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
discriminator:
propertyName: subtype
mapping:
jinjava: "#/components/schemas/brickworks-service-JinJavaForm"
string: "#/components/schemas/brickworks-service-StringForm"
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- itemKey
default:
type: object
title: Catalog default
x-class-name: CatalogFieldDefault
x-interface-name-ts: CatalogFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique ID of a catalog
itemKey:
type: string
description: Static string or Jinjava that inserts the unique ID of an item in the catalog
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Promotion
x-class-name: PromotionField
x-interface-name-ts: PromotionField
description: Reference to a promotion
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: PromotionSubtype
x-interface-name-ts: PromotionSubtype
enum:
- promotion
properties:
type: object
x-class-name: PromotionFieldProperties
x-interface-name-ts: PromotionFieldProperties
description: "`id` defines the promotion to access. In `default`, enter the default promotion UUID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Promotion default
x-class-name: PromotionFieldDefault
x-interface-name-ts: PromotionFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of a promotion campaign
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Voucher
x-class-name: VoucherField
x-interface-name-ts: VoucherField
description: Reference to a voucher
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: VoucherSubtype
x-interface-name-ts: VoucherSubtype
description: This type of fields lets you retrieve a voucher from a pool. The voucher is retrieved when you generate an object from the record.
enum:
- voucher
properties:
type: object
title: Voucher properties
x-class-name: VoucherFieldProperties
x-interface-name-ts: VoucherFieldProperties
description: |
- in `id.default`, enter the UUID of the voucher pool. It can be changed per record.
- in `assign.default`:
- `false` means that once a code from a given pool is retrieved to a profile, it becomes assigned to the profile and is always returned in subsequent requests.
- `true` means that a different code is retrieved for a profile with every request. This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
assign:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- assign
default:
type: object
title: Voucher default
x-class-name: VoucherFieldDefault
x-interface-name-ts: VoucherFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of the voucher
assign:
type: boolean
description: |
- `false` means that once a code from a given pool is retrieved to a profile, it becomes assigned to the profile and is always returned in subsequent requests.
- `true` means that a different code is retrieved for a profile with every request. This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Recommendation
x-class-name: RecommendationField
x-interface-name-ts: RecommendationField
description: Reference to a recommendation campaign
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: RecommendationSubtype
x-interface-name-ts: RecommendationSubtype
description: This type of field lets you retrieve the result of a recommendation campaign.
enum:
- recommendation
properties:
type: object
title: Recommendation properties
x-class-name: RecommendationFieldProperties
x-interface-name-ts: RecommendationFieldProperties
description: |
- `id.default` defines the default recommendation campaign to generate a recommendation from.
- In `params.itemId`, you can add a default item context (required by some recommendation types):
```
"itemId": {
"type": "string",
"subtype": "string"
"default": "defaultItemIdForItemContext"
}
```
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Recommendation default
x-class-name: RecommendationFieldDefault
x-interface-name-ts: RecommendationFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of a recommendation campaign
params:
type: object
title: Recommendation default params
x-class-name: RecommendationFieldDefaultParams
x-interface-name-ts: RecommendationFieldDefaultParams
description: Item context
properties:
itemId:
type: string
description: Unique ID of an item context (required for some recommendation types)
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Metric
x-class-name: MetricField
x-interface-name-ts: MetricField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: MetricSubtype
x-interface-name-ts: MetricSubtype
enum:
- metric
properties:
type: object
description: |
- `id` is the default ID of an metric.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Metric default
x-class-name: MetricFieldDefault
x-interface-name-ts: MetricFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Aggregate
x-class-name: AggregateField
x-interface-name-ts: AggregateField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: AggregateSubtype
x-interface-name-ts: AggregateSubtype
enum:
- aggregate
properties:
type: object
description: |
- `id` is the default ID of an analysis.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Aggregate default
x-class-name: AggregateFieldDefault
x-interface-name-ts: AggregateFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Expression
x-class-name: ExpressionField
x-interface-name-ts: ExpressionField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: ExpressionSubtype
x-interface-name-ts: ExpressionSubtype
enum:
- expression
properties:
type: object
description: |
- `id` is the default ID of an expression.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
x-class-name: ExpressionFieldDefault
x-interface-name-ts: ExpressionFieldDefault
title: Expression default
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
discriminator:
propertyName: subtype
mapping:
file: "#/components/schemas/brickworks-service-FileField"
image: "#/components/schemas/brickworks-service-ImageField"
catalog_item: "#/components/schemas/brickworks-service-CatalogItemField"
promotion: "#/components/schemas/brickworks-service-PromotionField"
voucher: "#/components/schemas/brickworks-service-VoucherField"
recommendation: "#/components/schemas/brickworks-service-RecommendationField"
metric: "#/components/schemas/brickworks-service-MetricField"
aggregate: "#/components/schemas/brickworks-service-AggregateField"
expression: "#/components/schemas/brickworks-service-ExpressionField"
config:
type: object
title: Synerise object array config
x-class-name: SyneriseArrayConfig
x-interface-name-ts: SyneriseArrayConfig
description: |
Settings applied when the Synerise objects of the array are resolved during content generation.
- `nullOnFail` - when `true` and resolving an object fails, that item becomes `null` instead of failing the whole field. Defaults to `false`.
- `removeNulls` - when `true`, the `null` items are removed from the resolved array. Defaults to `true`.
properties:
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
removeNulls:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
minItems:
type: integer
format: int32
description: The minimum number of items allowed in the array
maxItems:
type: integer
format: int32
description: The maximum number of items allowed in the array
uniqueItems:
type: boolean
description: When `true`, the values in the array must be unique
default:
type: array
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
items: {}
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- items
- config
discriminator:
propertyName: subtype
mapping:
boolean: "#/components/schemas/brickworks-service-BooleanForm"
string: "#/components/schemas/brickworks-service-StringForm"
integer: "#/components/schemas/brickworks-service-IntegerForm"
number: "#/components/schemas/brickworks-service-NumberForm"
enum: "#/components/schemas/brickworks-service-EnumForm"
date: "#/components/schemas/brickworks-service-DateForm"
date-time: "#/components/schemas/brickworks-service-DateTimeForm"
typed_array: "#/components/schemas/brickworks-service-ArrayForm"
uuid: "#/components/schemas/brickworks-service-UUIDForm"
jinjava: "#/components/schemas/brickworks-service-JinJavaForm"
one_to_one: "#/components/schemas/brickworks-service-ReferenceForm"
catalog_item: "#/components/schemas/brickworks-service-CatalogItemField"
key_value: "#/components/schemas/brickworks-service-KeyValueObject"
external_source: "#/components/schemas/brickworks-service-ExternalHttpSource"
one_to_many: "#/components/schemas/brickworks-service-OneToManyForm"
metric: "#/components/schemas/brickworks-service-MetricField"
expression: "#/components/schemas/brickworks-service-ExpressionField"
aggregate: "#/components/schemas/brickworks-service-AggregateField"
promotion: "#/components/schemas/brickworks-service-PromotionField"
file: "#/components/schemas/brickworks-service-FileField"
image: "#/components/schemas/brickworks-service-ImageField"
recommendation: "#/components/schemas/brickworks-service-RecommendationField"
ai_search: "#/components/schemas/brickworks-service-AiSearchField"
ai_search_listing: "#/components/schemas/brickworks-service-AiSearchListingField"
voucher: "#/components/schemas/brickworks-service-VoucherField"
untyped_object: "#/components/schemas/brickworks-service-UntypedJson"
untyped_array: "#/components/schemas/brickworks-service-UntypedArray"
json: "#/components/schemas/brickworks-service-UntypedForm"
client_attribute: "#/components/schemas/brickworks-service-ProfileAttributeField"
filter: "#/components/schemas/brickworks-service-OneToManyFilterForm"
synerise_array: "#/components/schemas/brickworks-service-SyneriseArrayForm"
x-typescript-type: "{ [key: string]: FieldForm }"
required:
type: array
description: A list of fields (field key names) that must have a value in the record.
items:
type: string
allOf:
type: array
description: |
Additional validation for the fields. To learn more about conditionals, see the [JSON Schema documentation](https://json-schema.org/understanding-json-schema/reference/conditionals#ifthenelse).
The Synerise Web Portal only supports making a field available and required when another field meets a condition. Using other configurations works in the API, but may cause issues when trying to use the Synerise Web Portal.
The following example is a condition supported by the Portal: the `accountNumber` field becomes available (and must be filled) when `paymentType` is `transfer`.
```
"fields": {
"allOf": [
{
"if": {
"required": [
"paymentType"
],
"properties": {
"paymentType": {
"const": "transfer"
}
}
},
"then": {
"required": [
"accountNumber"
],
"properties": {}
}
}
],
...
}
```
For Portal compatibility, you can only change the field condition (`const` in the above example) to a different one. The `pattern` condition and `else` statements are currently not supported by the Portal.
items:
type: object
description: Additional validation for the fields. To learn how to use them, see the [JSON Schema documentation](https://json-schema.org/understanding-json-schema/reference/conditionals#ifthenelse).
x-class-name: ValidationConditions
x-interface-name-ts: ValidationConditions
properties:
if:
type: object
x-class-name: ValidationStatement
x-interface-name-ts: ValidationStatement
properties:
required:
type: array
items:
type: string
properties:
additionalProperties:
type: object
x-class-name: FieldCondition
x-interface-name-ts: FieldCondition
properties:
minItems:
type: number
format: int32
maxItems:
type: number
format: int32
uniqueItems:
type: boolean
minimum:
type: number
format: int32
maximum:
type: number
format: int32
pattern:
type: string
const:
title: FieldConditionConstant
x-class-name: FieldConditionConstant
x-interface-name-ts: FieldConditionConstant
nullable: true
enum:
type: array
items:
type: string
not:
$ref: "#/components/schemas/brickworks-service-FieldCondition"
required:
- required
- properties
then:
type: object
x-class-name: ValidationStatement
x-interface-name-ts: ValidationStatement
properties:
required:
type: array
items:
type: string
properties:
additionalProperties:
type: object
x-class-name: FieldCondition
x-interface-name-ts: FieldCondition
properties:
minItems:
type: number
format: int32
maxItems:
type: number
format: int32
uniqueItems:
type: boolean
minimum:
type: number
format: int32
maximum:
type: number
format: int32
pattern:
type: string
const:
title: FieldConditionConstant
x-class-name: FieldConditionConstant
x-interface-name-ts: FieldConditionConstant
nullable: true
enum:
type: array
items:
type: string
not:
$ref: "#/components/schemas/brickworks-service-FieldCondition"
required:
- required
- properties
else:
type: object
x-class-name: ValidationStatement
x-interface-name-ts: ValidationStatement
properties:
required:
type: array
items:
type: string
properties:
additionalProperties:
type: object
x-class-name: FieldCondition
x-interface-name-ts: FieldCondition
properties:
minItems:
type: number
format: int32
maxItems:
type: number
format: int32
uniqueItems:
type: boolean
minimum:
type: number
format: int32
maximum:
type: number
format: int32
pattern:
type: string
const:
title: FieldConditionConstant
x-class-name: FieldConditionConstant
x-interface-name-ts: FieldConditionConstant
nullable: true
enum:
type: array
items:
type: string
not:
$ref: "#/components/schemas/brickworks-service-FieldCondition"
required:
- required
- properties
required:
- if
- then
additionalProperties:
type: boolean
description: System parameter, generated automatically. Don't send this in requests.
required:
- type
- properties
- required
displayConfiguration:
type: object
x-class-name: SchemaDisplayConfiguration
x-interface-name-ts: SchemaDisplayConfiguration
description: The layout details of the schema
properties:
ordering:
type: object
description: Order of the fields. If not included, the backend creates the ordering in alphabetical order.
additionalProperties:
description: The name of the field is the key in this object and the value is its position in the schema (`0` is displayed first in the Synerise Portal).
type: integer
minimum: 0
format: int32
metadata:
type: object
description: Configuration of displaying the fields in the editor
additionalProperties:
type: object
x-class-name: FieldMetadata
x-interface-name-ts: FieldMetadata
description: The object name is the name of a field in the schema
properties:
title:
type: string
description: Display name of the field, shown in the editor
default: empty title
description:
type: string
nullable: true
description: Description of the field, shown in the editor
useAsRecordName:
type: boolean
nullable: true
default: false
description: When `true`, the value of this field can be used as the record name. This only happens when the record name is not explicitly defined in its `name` parameter.If multiple fields can be used as the record name, they are checked starting with the highest `ordering` and the first non-empty field is used.
required:
- ordering
- metadata
createdBy:
type: integer
format: int64
description: ID of the user who created the resource. If created by a workspace, the value is `0`.
updatedBy:
type: integer
format: int64
description: ID of the user who last updated the resource. If last updated by a workspace, the value is `0`.
publishedBy:
type: integer
format: int64
nullable: true
description: ID of the user who published the resource. If published by a workspace, the value is `0`.
deletedBy:
type: integer
format: int64
nullable: true
description: ID of the user who deleted the resource. If deleted by a workspace, the value is `0`.
createdAt:
type: string
format: date-time
description: Time when the resource was created
updatedAt:
type: string
format: date-time
description: Time when the resource was last updated
publishedAt:
type: string
format: date-time
nullable: true
description: Time when the resource was published
deletedAt:
type: string
format: date-time
nullable: true
description: Time when the resource was deleted
version:
type: integer
format: int32
description: Schema version ID. For simple schemas, this is always `1`. When a schema is updated, the ID increases by 1.
audience:
type: object
x-class-name: Audience
x-interface-name-ts: Audience
description: Definition of the profiles which can access content created from this schema.
properties:
targetType:
type: string
enum:
- SEGMENT
- QUERY
- ALL
description: |
- ALL: Available to all profiles
- SEGMENT: Available to a segmentation or segmentations of profiles, listed in `segments`
- QUERY: Available to a segmentation of profiles defined with `query`
segments:
type: array
description: Used when `targetType` is `SEGMENT`. This is a list of existing segmentations (identified by UUID) which define the audience.
items:
type: string
format: uuid
description: Segmentation UUID
query:
type: string
description: Used when `targetType` is `QUERY`. This is a raw `analysis` object sent to the Analytics service, converted into a string. For details on how to create the analysis object, see the [API reference for creating segmentations](https://developers.synerise.com/AnalyticsSuite/AnalyticsSuite.html#tag/Segmentations/operation/analytics2-segmentations-create).
example: '{\"analysis\":{\"title\":\"notempty\",\"segments\":[{\"title\":\"notempty\",\"filter\":{\"matching\":true,\"expressions\":[{\"type\":\"ATTRIBUTE\",\"attribute\":{\"expressions\":[{\"constraint\":{\"type\":\"BOOL\",\"logic\":\"IS_TRUE\"},\"attribute\":{\"type\":\"PARAM\",\"param\":\"exampleBool\"}}]}}]}}]}}'
schemaType:
type: string
x-class-name: SchemaType
x-interface-name-ts: SchemaType
enum:
- SIMPLE
- VERSIONED
- SINGLETON
description: |
- SIMPLE: a schema in which records can only have the PUBLISHED status.
- VERSIONED: a schema in which records can be saved as drafts; and you can also access the version history.
- SINGLETON: a schema which has no records. All fields must have default values. Values can still be inserted dynamically with Jinjava.
fieldContextConfig:
type: object
x-class-name: FieldContextConfig
x-interface-name-ts: FieldContextConfig
required:
- fields
properties:
fields:
type: array
items:
type: object
x-class-name: FieldContextConfigField
x-interface-name-ts: FieldContextConfigField
required:
- fieldName
- descriptors
properties:
fieldName:
type: string
descriptors:
type: array
items:
type: object
x-class-name: FieldContextDescriptor
x-interface-name-ts: FieldContextDescriptor
required:
- name
- type
properties:
name:
type: string
type:
x-class-name: FieldContextDescriptorType
type: string
enum:
- string
- integer
- number
- boolean
- unknown
lambdaId:
type: string
format: uuid
description: |
Unique identifier of the lambda function, generated by the system. Can't be changed.
This identifier is common to all versions of the function and is used to reference the function in every endpoint.
"400":
description: Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.
content:
application/json:
schema:
type: object
x-class-name: ObjectsError
x-interface-name-ts: ObjectsError
required:
- httpStatus
- errorCode
- timestamp
- message
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
httpStatus:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
traceId:
type: string
description: Unique identifier of the request, useful for tracing logs
errors:
type: array
items:
$ref: "#/components/schemas/brickworks-service-ObjectsError"
source:
type: object
x-class-name: ObjectErrorSource
x-interface-name-ts: ObjectErrorSource
required:
- pointer
properties:
pointer:
type: string
description: JSON Pointer for invalid body path
value:
type: string
description: Value that caused the validation error
details:
type: object
x-class-name: ObjectsErrorDetails
x-interface-name-ts: ObjectsErrorDetails
additionalProperties:
type: object
description: Additional structured error information
field:
type: string
description: Name of the field that caused the error
"401":
description: "Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details."
content:
application/json:
schema:
type: object
x-class-name: GatewayError
x-interface-name-ts: GatewayError
properties:
error:
type: string
description: Summary of the error
status:
type: integer
format: int32
description: Status code
timestamp:
type: string
description: Time when the message was sent
message:
type: string
description: Description of the problem
"403":
description: Forbidden; insufficient permissions. See error message for details.
content:
application/json:
schema:
type: object
x-class-name: GatewayError
x-interface-name-ts: GatewayError
properties:
error:
type: string
description: Summary of the error
status:
type: integer
format: int32
description: Status code
timestamp:
type: string
description: Time when the message was sent
message:
type: string
description: Description of the problem
"404":
description: Resource not found. See error message for details.
content:
application/json:
schema:
type: object
x-class-name: ObjectsError
x-interface-name-ts: ObjectsError
required:
- httpStatus
- errorCode
- timestamp
- message
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
httpStatus:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
traceId:
type: string
description: Unique identifier of the request, useful for tracing logs
errors:
type: array
items:
$ref: "#/components/schemas/brickworks-service-ObjectsError"
source:
type: object
x-class-name: ObjectErrorSource
x-interface-name-ts: ObjectErrorSource
required:
- pointer
properties:
pointer:
type: string
description: JSON Pointer for invalid body path
value:
type: string
description: Value that caused the validation error
details:
type: object
x-class-name: ObjectsErrorDetails
x-interface-name-ts: ObjectsErrorDetails
additionalProperties:
type: object
description: Additional structured error information
field:
type: string
description: Name of the field that caused the error
"409":
description: The request could not be completed due to a conflict with the current state of the resource. See error message for details.
content:
application/json:
schema:
type: object
x-class-name: ObjectsError
x-interface-name-ts: ObjectsError
required:
- httpStatus
- errorCode
- timestamp
- message
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
httpStatus:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
traceId:
type: string
description: Unique identifier of the request, useful for tracing logs
errors:
type: array
items:
$ref: "#/components/schemas/brickworks-service-ObjectsError"
source:
type: object
x-class-name: ObjectErrorSource
x-interface-name-ts: ObjectErrorSource
required:
- pointer
properties:
pointer:
type: string
description: JSON Pointer for invalid body path
value:
type: string
description: Value that caused the validation error
details:
type: object
x-class-name: ObjectsErrorDetails
x-interface-name-ts: ObjectsErrorDetails
additionalProperties:
type: object
description: Additional structured error information
field:
type: string
description: Name of the field that caused the error
"422":
description: The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.
content:
application/json:
schema:
type: object
x-class-name: ObjectsError
x-interface-name-ts: ObjectsError
required:
- httpStatus
- errorCode
- timestamp
- message
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
httpStatus:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
traceId:
type: string
description: Unique identifier of the request, useful for tracing logs
errors:
type: array
items:
$ref: "#/components/schemas/brickworks-service-ObjectsError"
source:
type: object
x-class-name: ObjectErrorSource
x-interface-name-ts: ObjectErrorSource
required:
- pointer
properties:
pointer:
type: string
description: JSON Pointer for invalid body path
value:
type: string
description: Value that caused the validation error
details:
type: object
x-class-name: ObjectsErrorDetails
x-interface-name-ts: ObjectsErrorDetails
additionalProperties:
type: object
description: Additional structured error information
field:
type: string
description: Name of the field that caused the error
"500":
description: See error message for details.
content:
application/json:
schema:
type: object
x-class-name: ObjectsError
x-interface-name-ts: ObjectsError
required:
- httpStatus
- errorCode
- timestamp
- message
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
httpStatus:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
traceId:
type: string
description: Unique identifier of the request, useful for tracing logs
errors:
type: array
items:
$ref: "#/components/schemas/brickworks-service-ObjectsError"
source:
type: object
x-class-name: ObjectErrorSource
x-interface-name-ts: ObjectErrorSource
required:
- pointer
properties:
pointer:
type: string
description: JSON Pointer for invalid body path
value:
type: string
description: Value that caused the validation error
details:
type: object
x-class-name: ObjectsErrorDetails
x-interface-name-ts: ObjectsErrorDetails
additionalProperties:
type: object
description: Additional structured error information
field:
type: string
description: Name of the field that caused the error
x-snr-doc-urls:
- /api-reference/brickworks#tag/Brickworks:-Schemas/operation/getSchemaById
servers:
- description: Microsoft Azure EU
url: https://api.synerise.com
- description: Microsoft Azure USA
url: https://api.azu.synerise.com
- description: Google Cloud Platform
url: https://api.geb.synerise.com
tags:
- name: "Brickworks: Schemas"
components:
schemas:
brickworks-service-FieldFormMap:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
type: object
x-class-name: FieldForm
x-interface-name-ts: FieldForm
description: Each key is the name of a field (called "API name" in the Synerise Portal).
oneOf:
- type: object
title: Number
x-class-name: NumberForm
x-interface-name-ts: NumberForm
description: This field type accepts static numeric values. `number` is used for floating-point values.
properties:
type:
type: string
title: Number type
x-class-name: NumberType
x-interface-name-ts: NumberType
enum:
- number
subtype:
type: string
x-class-name: NumberSubtype
x-interface-name-ts: NumberSubtype
enum:
- number
minimum:
type: number
format: float
description: Minimum value
maximum:
type: number
format: float
description: Maximum value
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: number
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Integer
x-class-name: IntegerForm
x-interface-name-ts: IntegerForm
properties:
type:
type: string
title: IntegerType
x-class-name: IntegerType
x-interface-name-ts: IntegerType
enum:
- integer
subtype:
type: string
x-class-name: IntegerSubtype
x-interface-name-ts: IntegerSubtype
enum:
- integer
minimum:
type: number
format: int32
description: Minimum value
maximum:
type: number
format: int32
description: Maximum value
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: number
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Enumeration
x-class-name: EnumForm
x-interface-name-ts: EnumForm
description: This type of field defines a list of strings which can be used as the value. Only one of the allowed values can be saved in the record.
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: EnumSubtype
x-interface-name-ts: EnumSubtype
enum:
- enum
enum:
type: array
description: A list of strings which can be selected as the value
items:
type: string
names:
type: object
description: |
A mapping of the field values and their names displayed in the record.
For example, if `enum` contains the value `exampleValue` and you want the UI to show `Example Value` on the list, set:
```
"names": {
"exampleValue": "Example Value"
}
```
additionalProperties:
type: string
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- enum
- names
- type: object
title: Date
x-class-name: DateForm
x-interface-name-ts: DateForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: DateSubtype
x-interface-name-ts: DateSubtype
enum:
- date
default:
type: string
format: date
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Date and time
x-class-name: DateTimeForm
x-interface-name-ts: DateTimeForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: DateTimeSubtype
x-interface-name-ts: DateTimeSubtype
enum:
- date-time
default:
type: string
format: date-time
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Array
x-class-name: ArrayForm
x-interface-name-ts: ArrayForm
description: This type of field accepts an array of values. The type of values is defined in `items`
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: TypedArraySubtype
x-interface-name-ts: TypedArraySubtype
enum:
- typed_array
items:
type: object
description: The definition of the type of value allowed in the array. All values must be of the same type.
oneOf:
- type: object
title: Number
x-class-name: NumberForm
x-interface-name-ts: NumberForm
description: This field type accepts static numeric values. `number` is used for floating-point values.
properties:
type:
type: string
title: Number type
x-class-name: NumberType
x-interface-name-ts: NumberType
enum:
- number
subtype:
type: string
x-class-name: NumberSubtype
x-interface-name-ts: NumberSubtype
enum:
- number
minimum:
type: number
format: float
description: Minimum value
maximum:
type: number
format: float
description: Maximum value
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: number
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Integer
x-class-name: IntegerForm
x-interface-name-ts: IntegerForm
properties:
type:
type: string
title: IntegerType
x-class-name: IntegerType
x-interface-name-ts: IntegerType
enum:
- integer
subtype:
type: string
x-class-name: IntegerSubtype
x-interface-name-ts: IntegerSubtype
enum:
- integer
minimum:
type: number
format: int32
description: Minimum value
maximum:
type: number
format: int32
description: Maximum value
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: number
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Enumeration
x-class-name: EnumForm
x-interface-name-ts: EnumForm
description: This type of field defines a list of strings which can be used as the value. Only one of the allowed values can be saved in the record.
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: EnumSubtype
x-interface-name-ts: EnumSubtype
enum:
- enum
enum:
type: array
description: A list of strings which can be selected as the value
items:
type: string
names:
type: object
description: |
A mapping of the field values and their names displayed in the record.
For example, if `enum` contains the value `exampleValue` and you want the UI to show `Example Value` on the list, set:
```
"names": {
"exampleValue": "Example Value"
}
```
additionalProperties:
type: string
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- enum
- names
discriminator:
propertyName: subtype
mapping:
number: "#/components/schemas/brickworks-service-NumberForm"
integer: "#/components/schemas/brickworks-service-IntegerForm"
boolean: "#/components/schemas/brickworks-service-BooleanForm"
string: "#/components/schemas/brickworks-service-StringForm"
enum: "#/components/schemas/brickworks-service-EnumForm"
maxItems:
type: number
format: int32
description: The maximum number of items allowed in the array
uniqueItems:
type: boolean
description: When `true`, the values in the array must be unique
default:
type: array
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
items: {}
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- items
- subtype
- type: object
title: UUID
x-class-name: UUIDForm
x-interface-name-ts: UUIDForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: UUIDSubtype
x-interface-name-ts: UUIDSubtype
enum:
- uuid
default:
type: string
format: uuid
title: UUID default
x-class-name: UUIDFormDefault
x-interface-name-ts: UUIDFormDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Jinjava
x-class-name: JinJavaForm
x-interface-name-ts: JinJavaForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: JinJavaSubtype
x-interface-name-ts: JinJavaSubtype
enum:
- jinjava
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
settings:
type: object
x-class-name: JinJavaSettings
x-interface-name-ts: JinJavaSettings
nullable: true
description: Settings for casting the Jinjava result to a data type. Casting may not be successful - set the `strict` setting to decide how to proceed in that case.
properties:
castType:
type: string
description: The data type to try casting the Jinjava result to
x-class-name: JinJavaCastType
x-interface-name-ts: JinJavaCastType
enum:
- boolean
- integer
- number
- json
strict:
type: boolean
description: |
Defines what happens when casting is not successful:
- `true` throws an error in generating an object from a record
- `false` sets the value to null
removeWhitespaces:
type: boolean
description: |
When `true`, all whitespace characters (e.g. `\r`, `\n`, spaces, tabs) are removed from the Jinjava render result before casting.
required:
- strict
- castType
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Catalog
x-class-name: CatalogItemField
x-interface-name-ts: CatalogItemField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: CatalogItemSubtype
x-interface-name-ts: CatalogItemSubtype
enum:
- catalog_item
properties:
type: object
title: CatalogItemFieldProperties
description: |
The data of the catalog. `id` is the default catalogId and `itemKey` is the default unique identifier of an item. You can override both when creating/updating a record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
itemKey:
oneOf:
- type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Jinjava
x-class-name: JinJavaForm
x-interface-name-ts: JinJavaForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: JinJavaSubtype
x-interface-name-ts: JinJavaSubtype
enum:
- jinjava
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
settings:
type: object
x-class-name: JinJavaSettings
x-interface-name-ts: JinJavaSettings
nullable: true
description: Settings for casting the Jinjava result to a data type. Casting may not be successful - set the `strict` setting to decide how to proceed in that case.
properties:
castType:
type: string
description: The data type to try casting the Jinjava result to
x-class-name: JinJavaCastType
x-interface-name-ts: JinJavaCastType
enum:
- boolean
- integer
- number
- json
strict:
type: boolean
description: |
Defines what happens when casting is not successful:
- `true` throws an error in generating an object from a record
- `false` sets the value to null
removeWhitespaces:
type: boolean
description: |
When `true`, all whitespace characters (e.g. `\r`, `\n`, spaces, tabs) are removed from the Jinjava render result before casting.
required:
- strict
- castType
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
discriminator:
propertyName: subtype
mapping:
jinjava: "#/components/schemas/brickworks-service-JinJavaForm"
string: "#/components/schemas/brickworks-service-StringForm"
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- itemKey
default:
type: object
title: Catalog default
x-class-name: CatalogFieldDefault
x-interface-name-ts: CatalogFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique ID of a catalog
itemKey:
type: string
description: Static string or Jinjava that inserts the unique ID of an item in the catalog
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
- type: object
title: External source
x-class-name: ExternalSourceField
x-interface-name-ts: ExternalSourceField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: ExternalSourceSubtype
x-interface-name-ts: ExternalSourceSubtype
enum:
- external_source
sourceType:
type: string
enum:
- http
sourceId:
type: string
description: Unique ID of the external source definition
format: uuid
headers:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
body:
$ref: "#/components/schemas/brickworks-service-FieldForm"
properties:
type: object
x-class-name: ExternalSourceFieldProperties
x-interface-name-ts: ExternalSourceFieldProperties
description: Behavior of the external source field when the source call fails. `returnErrorBodyOnFail` takes precedence over `nullOnFail` for received error responses.
properties:
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
returnErrorBodyOnFail:
type: boolean
nullable: true
description: |
Defines what happens when the external source responds with an error (non-2xx) status:
- `true` — instead of failing the generate request (or returning null when `nullOnFail` is enabled), the field resolves to a JSON object with the error details: `response.status`, `response.body`, `request.url`, `request.method`, `request.body`. Useful for debugging and for building a custom flow based on errors.
- `false` (default, also when absent or null) — standard behavior applies: `nullOnFail` decides between failing the request and a null field value.
Covers only received HTTP responses. Connection-level failures (e.g. timeouts) and a missing external source definition still fail the request.
required:
- nullOnFail
default:
type: object
title: External source default
x-class-name: ExternalHttpSourceDefault
x-interface-name-ts: ExternalHttpSourceDefault
nullable: true
properties:
headers:
type: object
description: Request headers
additionalProperties: true
params:
type: object
description: The url parameters
additionalProperties: true
body:
type: object
description: Request body
additionalProperties: true
properties:
type: object
title: External source properties
x-class-name: ExternalHttpSourcePropertiesValues
x-interface-name-ts: ExternalHttpSourcePropertiesValues
properties:
nullOnFail:
type: boolean
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- sourceType
- sourceId
- type: object
title: Record reference
x-class-name: ReferenceForm
x-interface-name-ts: ReferenceForm
description: Definition of a reference to another schema
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: OneToOneSubtype
x-interface-name-ts: OneToOneSubtype
description: |
This field type lets you include references to a record from another schema. To generate an object, the referenced record must be published. Its content (for example, an expression field in the referenced record) will be processed when generating an object.
enum:
- one_to_one
referenceId:
type: string
description: Unique identifier of the schema you want to access a record from. When creating a record with this field, you will provide the UUID of the referenced record from that schema.
default:
type: string
format: uuid
description: The default record to reference. In "one to many" fields, use the `default` array in the parent object instead of this property.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Multiple record reference
x-class-name: OneToManyForm
x-interface-name-ts: OneToManyForm
description: This type of field allows you to reference multiple records from another schema. `items` defines the target schema.
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: OneToManySubtype
x-interface-name-ts: OneToManySubtype
enum:
- one_to_many
items:
type: object
title: Record reference
x-class-name: ReferenceForm
x-interface-name-ts: ReferenceForm
description: Definition of a reference to another schema
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: OneToOneSubtype
x-interface-name-ts: OneToOneSubtype
description: |
This field type lets you include references to a record from another schema. To generate an object, the referenced record must be published. Its content (for example, an expression field in the referenced record) will be processed when generating an object.
enum:
- one_to_one
referenceId:
type: string
description: Unique identifier of the schema you want to access a record from. When creating a record with this field, you will provide the UUID of the referenced record from that schema.
default:
type: string
format: uuid
description: The default record to reference. In "one to many" fields, use the `default` array in the parent object instead of this property.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
maxItems:
type: number
minimum: 1
maximum: 100
default: 20
description: The maximum number of records that can be referenced.
default:
type: array
description: An array of default record references (record UUIDs)
items:
type: string
format: uuid
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- items
- subtype
- type: object
description: Reference to a Synerise analysis
title: Metric
x-class-name: MetricField
x-interface-name-ts: MetricField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: MetricSubtype
x-interface-name-ts: MetricSubtype
enum:
- metric
properties:
type: object
description: |
- `id` is the default ID of an metric.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Metric default
x-class-name: MetricFieldDefault
x-interface-name-ts: MetricFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Aggregate
x-class-name: AggregateField
x-interface-name-ts: AggregateField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: AggregateSubtype
x-interface-name-ts: AggregateSubtype
enum:
- aggregate
properties:
type: object
description: |
- `id` is the default ID of an analysis.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Aggregate default
x-class-name: AggregateFieldDefault
x-interface-name-ts: AggregateFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Expression
x-class-name: ExpressionField
x-interface-name-ts: ExpressionField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: ExpressionSubtype
x-interface-name-ts: ExpressionSubtype
enum:
- expression
properties:
type: object
description: |
- `id` is the default ID of an expression.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
x-class-name: ExpressionFieldDefault
x-interface-name-ts: ExpressionFieldDefault
title: Expression default
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Promotion
x-class-name: PromotionField
x-interface-name-ts: PromotionField
description: Reference to a promotion
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: PromotionSubtype
x-interface-name-ts: PromotionSubtype
enum:
- promotion
properties:
type: object
x-class-name: PromotionFieldProperties
x-interface-name-ts: PromotionFieldProperties
description: "`id` defines the promotion to access. In `default`, enter the default promotion UUID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Promotion default
x-class-name: PromotionFieldDefault
x-interface-name-ts: PromotionFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of a promotion campaign
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: File
x-class-name: FileField
x-interface-name-ts: FileField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: FileSubtype
x-interface-name-ts: FileSubtype
description: This type of field lets you store links to [files uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/).
enum:
- file
properties:
type: object
x-class-name: FileFieldProperties
x-interface-name-ts: FileFieldProperties
description: "`id` defines the unique ID of a [file uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/). In `default`, enter the default file ID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
default:
type: object
title: File default
x-class-name: FileFieldDefault
x-interface-name-ts: FileFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique identifier of an image/file in the File Explorer
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Image
x-class-name: ImageField
x-interface-name-ts: ImageField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
description: This type of field lets you store links to images.
enum:
- image
properties:
type: object
x-class-name: FileFieldProperties
x-interface-name-ts: FileFieldProperties
description: "`id` defines the unique ID of a [file uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/). In `default`, enter the default file ID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
default:
type: object
title: Image default
x-class-name: ImageFieldDefault
x-interface-name-ts: ImageFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique identifier of an image/file in the File Explorer
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Recommendation
x-class-name: RecommendationField
x-interface-name-ts: RecommendationField
description: Reference to a recommendation campaign
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: RecommendationSubtype
x-interface-name-ts: RecommendationSubtype
description: This type of field lets you retrieve the result of a recommendation campaign.
enum:
- recommendation
properties:
type: object
title: Recommendation properties
x-class-name: RecommendationFieldProperties
x-interface-name-ts: RecommendationFieldProperties
description: |
- `id.default` defines the default recommendation campaign to generate a recommendation from.
- In `params.itemId`, you can add a default item context (required by some recommendation types):
```
"itemId": {
"type": "string",
"subtype": "string"
"default": "defaultItemIdForItemContext"
}
```
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Recommendation default
x-class-name: RecommendationFieldDefault
x-interface-name-ts: RecommendationFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of a recommendation campaign
params:
type: object
title: Recommendation default params
x-class-name: RecommendationFieldDefaultParams
x-interface-name-ts: RecommendationFieldDefaultParams
description: Item context
properties:
itemId:
type: string
description: Unique ID of an item context (required for some recommendation types)
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: AI Search
x-class-name: AiSearchField
x-interface-name-ts: AiSearchField
description: Reference to an AI Search index used to perform a search query
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: AiSearchSubtype
x-interface-name-ts: AiSearchSubtype
description: This type of field lets you retrieve results of an AI Search query against a chosen index.
enum:
- ai_search
properties:
type: object
title: AI Search properties
x-class-name: AiSearchFieldProperties
x-interface-name-ts: AiSearchFieldProperties
description: |
- `id.default` defines the default AI Search index used to perform the search.
- `query.default` defines the default search phrase (accepts a string or a Jinjava expression).
- In `params`, you can declare additional query parameters supported by the AI Search API
(e.g. `filters`, `facets`, `displayAttributes`, `personalize`).
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
query:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- query
default:
type: object
title: AI Search default
x-class-name: AiSearchFieldDefault
x-interface-name-ts: AiSearchFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- Set to `null` (or omit) to declare no default at all.
- Send an empty object `{}` to declare an empty default — it is merged with the record value, or applied directly when the record does not provide one.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of the AI Search index
query:
type: string
description: Default search query phrase
params:
type: object
title: AI Search default params
x-class-name: AiSearchFieldDefaultParams
x-interface-name-ts: AiSearchFieldDefaultParams
description: Additional default query parameters
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: AI Listing
x-class-name: AiSearchListingField
x-interface-name-ts: AiSearchListingField
description: Reference to an AI Search index used to retrieve a listing (no query phrase)
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: AiSearchListingSubtype
x-interface-name-ts: AiSearchListingSubtype
description: This type of field lets you retrieve listing results from an AI Search index (without a query phrase).
enum:
- ai_search_listing
properties:
type: object
title: AI Listing properties
x-class-name: AiSearchListingFieldProperties
x-interface-name-ts: AiSearchListingFieldProperties
description: |
- `id.default` defines the default AI Search index used to fetch the listing.
- In `params`, you can declare additional query parameters supported by the AI Search listing API
(e.g. `filters`, `facets`, `displayAttributes`, `personalize`).
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: AI Listing default
x-class-name: AiSearchListingFieldDefault
x-interface-name-ts: AiSearchListingFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- Set to `null` (or omit) to declare no default at all.
- Send an empty object `{}` to declare an empty default — it is merged with the record value, or applied directly when the record does not provide one.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of the AI Search index
params:
type: object
title: AI Listing default params
x-class-name: AiSearchListingFieldDefaultParams
x-interface-name-ts: AiSearchListingFieldDefaultParams
description: Additional default query parameters
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Voucher
x-class-name: VoucherField
x-interface-name-ts: VoucherField
description: Reference to a voucher
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: VoucherSubtype
x-interface-name-ts: VoucherSubtype
description: This type of fields lets you retrieve a voucher from a pool. The voucher is retrieved when you generate an object from the record.
enum:
- voucher
properties:
type: object
title: Voucher properties
x-class-name: VoucherFieldProperties
x-interface-name-ts: VoucherFieldProperties
description: |
- in `id.default`, enter the UUID of the voucher pool. It can be changed per record.
- in `assign.default`:
- `false` means that once a code from a given pool is retrieved to a profile, it becomes assigned to the profile and is always returned in subsequent requests.
- `true` means that a different code is retrieved for a profile with every request. This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
assign:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- assign
default:
type: object
title: Voucher default
x-class-name: VoucherFieldDefault
x-interface-name-ts: VoucherFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of the voucher
assign:
type: boolean
description: |
- `false` means that once a code from a given pool is retrieved to a profile, it becomes assigned to the profile and is always returned in subsequent requests.
- `true` means that a different code is retrieved for a profile with every request. This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Untyped JSON
x-class-name: UntypedJson
x-interface-name-ts: UntypedJson
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: UntypedObjectSubtype
x-interface-name-ts: UntypedObjectSubtype
description: This type of field lets you save any JSON data in the record, without validating it against any schema
enum:
- untyped_object
default:
type: object
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
additionalProperties: true
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Untyped array
x-class-name: UntypedArray
x-interface-name-ts: UntypedArray
description: This type of field accepts an array of values. The values can be of any data type.
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: UntypedArraySubtype
x-interface-name-ts: UntypedArraySubtype
enum:
- untyped_array
default:
type: array
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
items: {}
maxItems:
type: number
format: int32
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
x-class-name: UntypedForm
x-interface-name-ts: UntypedForm
description: Field without typed structure
properties:
anyOf:
type: array
minItems: 2
maxItems: 2
items:
oneOf:
- type: object
title: Untyped JSON
x-class-name: UntypedJson
x-interface-name-ts: UntypedJson
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: UntypedObjectSubtype
x-interface-name-ts: UntypedObjectSubtype
description: This type of field lets you save any JSON data in the record, without validating it against any schema
enum:
- untyped_object
default:
type: object
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
additionalProperties: true
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Untyped array
x-class-name: UntypedArray
x-interface-name-ts: UntypedArray
description: This type of field accepts an array of values. The values can be of any data type.
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: UntypedArraySubtype
x-interface-name-ts: UntypedArraySubtype
enum:
- untyped_array
default:
type: array
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
items: {}
maxItems:
type: number
format: int32
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
subtype:
type: string
x-class-name: UntypedFormSubtype
x-interface-name-ts: UntypedFormSubtype
enum:
- json
default:
type: object
additionalProperties: true
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- anyOf
- subtype
- type: object
title: Profile attribute field
x-class-name: ProfileAttributeField
x-interface-name-ts: ProfileAttributeField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: ProfileAttributeSubtype
x-interface-name-ts: ProfileAttributeSubtype
description: This type of field references an attribute by name and retrieves its value.
enum:
- client_attribute
settings:
type: object
x-class-name: ProfileAttributeSettings
x-interface-name-ts: ProfileAttributeSettings
description: Additional settings of the field
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
castType:
type: string
description: The data type to try casting the attribute to
enum:
- none
- boolean
- number
- integer
- string
strict:
description: |
Defines what happens when casting is not successful:
- `true` throws an error in generating an object from a record
- `false` sets the value to null
required:
- castType
- strict
properties:
type: object
x-class-name: ProfileAttributeProperties
x-interface-name-ts: ProfileAttributeProperties
description: In `attributeName.default`, enter the default name of the profile attribute to retrieve a value from when generating content from a record
properties:
attributeName:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- attributeName
default:
type: object
title: ProfileAttributeFieldDefault
x-class-name: ProfileAttributeFieldDefault
x-interface-name-ts: ProfileAttributeFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
attributeName:
type: string
description: The name of the profile attribute to retrieve a value from when generating content from a record
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
description: Always false, don't send in requests
required:
- type
- subtype
- properties
- type: object
title: Record reference filter
x-class-name: OneToManyFilterForm
x-interface-name-ts: OneToManyFilterForm
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: OneToManyFilterSubtype
x-interface-name-ts: OneToManyFilterSubtype
enum:
- filter
description: This field type allows you to retrieve records from another schema and filter/sort them
schemaId:
type: string
format: uuid
description: Unique ID of the schema, generated automatically.
properties:
type: object
title: One to many filter properties
description: |
Definitions of the values allowed in the filter settings. If your integration flow involves using the Synerise Web Portal, you shouldn't use this object.
You can sort by these parameters:
- `id`
- `createdAt`
- `updatedAt`
x-class-name: OneToManyFilterProperties
x-interface-name-ts: OneToManyFilterProperties
properties:
query:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
sortBy:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
sortDirection:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- query
- sortBy
- sortDirection
default:
type: object
title: One to many filter form default
description: Default filter settings
x-class-name: OneToManyFilterFormDefault
x-interface-name-ts: OneToManyFilterFormDefault
properties:
query:
type: string
description: RSQL query to filter the records
sortBy:
type: string
description: The property to sort by
enum:
- id
- createdAt
- updatedAt
sortDirection:
type: string
description: Sorting direction
enum:
- asc
- desc
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
description: Field generated automatically, don't send in requests.
required:
- type
- subtype
- schemaId
- properties
- type: object
title: Synerise object array
x-class-name: SyneriseArrayForm
x-interface-name-ts: SyneriseArrayForm
description: This type of field accepts an array of Synerise objects. The type of the objects is defined in `items`. All objects must be of the same type.
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: SyneriseArraySubtype
x-interface-name-ts: SyneriseArraySubtype
description: This type of field accepts an array of Synerise objects. The type of the objects is defined in `items`.
enum:
- synerise_array
items:
type: object
title: Synerise object array item
x-class-name: SyneriseArrayFieldForm
x-interface-name-ts: SyneriseArrayFieldForm
description: The Synerise object stored in the items of a `synerise_array` field. All items of the array must be of the same type.
oneOf:
- type: object
title: File
x-class-name: FileField
x-interface-name-ts: FileField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: FileSubtype
x-interface-name-ts: FileSubtype
description: This type of field lets you store links to [files uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/).
enum:
- file
properties:
type: object
x-class-name: FileFieldProperties
x-interface-name-ts: FileFieldProperties
description: "`id` defines the unique ID of a [file uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/). In `default`, enter the default file ID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
default:
type: object
title: File default
x-class-name: FileFieldDefault
x-interface-name-ts: FileFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique identifier of an image/file in the File Explorer
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Image
x-class-name: ImageField
x-interface-name-ts: ImageField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
description: This type of field lets you store links to images.
enum:
- image
properties:
type: object
x-class-name: FileFieldProperties
x-interface-name-ts: FileFieldProperties
description: "`id` defines the unique ID of a [file uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/). In `default`, enter the default file ID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
default:
type: object
title: Image default
x-class-name: ImageFieldDefault
x-interface-name-ts: ImageFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique identifier of an image/file in the File Explorer
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Catalog
x-class-name: CatalogItemField
x-interface-name-ts: CatalogItemField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: CatalogItemSubtype
x-interface-name-ts: CatalogItemSubtype
enum:
- catalog_item
properties:
type: object
title: CatalogItemFieldProperties
description: |
The data of the catalog. `id` is the default catalogId and `itemKey` is the default unique identifier of an item. You can override both when creating/updating a record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
itemKey:
oneOf:
- type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Jinjava
x-class-name: JinJavaForm
x-interface-name-ts: JinJavaForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: JinJavaSubtype
x-interface-name-ts: JinJavaSubtype
enum:
- jinjava
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
settings:
type: object
x-class-name: JinJavaSettings
x-interface-name-ts: JinJavaSettings
nullable: true
description: Settings for casting the Jinjava result to a data type. Casting may not be successful - set the `strict` setting to decide how to proceed in that case.
properties:
castType:
type: string
description: The data type to try casting the Jinjava result to
x-class-name: JinJavaCastType
x-interface-name-ts: JinJavaCastType
enum:
- boolean
- integer
- number
- json
strict:
type: boolean
description: |
Defines what happens when casting is not successful:
- `true` throws an error in generating an object from a record
- `false` sets the value to null
removeWhitespaces:
type: boolean
description: |
When `true`, all whitespace characters (e.g. `\r`, `\n`, spaces, tabs) are removed from the Jinjava render result before casting.
required:
- strict
- castType
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
discriminator:
propertyName: subtype
mapping:
jinjava: "#/components/schemas/brickworks-service-JinJavaForm"
string: "#/components/schemas/brickworks-service-StringForm"
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- itemKey
default:
type: object
title: Catalog default
x-class-name: CatalogFieldDefault
x-interface-name-ts: CatalogFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique ID of a catalog
itemKey:
type: string
description: Static string or Jinjava that inserts the unique ID of an item in the catalog
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Promotion
x-class-name: PromotionField
x-interface-name-ts: PromotionField
description: Reference to a promotion
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: PromotionSubtype
x-interface-name-ts: PromotionSubtype
enum:
- promotion
properties:
type: object
x-class-name: PromotionFieldProperties
x-interface-name-ts: PromotionFieldProperties
description: "`id` defines the promotion to access. In `default`, enter the default promotion UUID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Promotion default
x-class-name: PromotionFieldDefault
x-interface-name-ts: PromotionFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of a promotion campaign
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Voucher
x-class-name: VoucherField
x-interface-name-ts: VoucherField
description: Reference to a voucher
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: VoucherSubtype
x-interface-name-ts: VoucherSubtype
description: This type of fields lets you retrieve a voucher from a pool. The voucher is retrieved when you generate an object from the record.
enum:
- voucher
properties:
type: object
title: Voucher properties
x-class-name: VoucherFieldProperties
x-interface-name-ts: VoucherFieldProperties
description: |
- in `id.default`, enter the UUID of the voucher pool. It can be changed per record.
- in `assign.default`:
- `false` means that once a code from a given pool is retrieved to a profile, it becomes assigned to the profile and is always returned in subsequent requests.
- `true` means that a different code is retrieved for a profile with every request. This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
assign:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- assign
default:
type: object
title: Voucher default
x-class-name: VoucherFieldDefault
x-interface-name-ts: VoucherFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of the voucher
assign:
type: boolean
description: |
- `false` means that once a code from a given pool is retrieved to a profile, it becomes assigned to the profile and is always returned in subsequent requests.
- `true` means that a different code is retrieved for a profile with every request. This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Recommendation
x-class-name: RecommendationField
x-interface-name-ts: RecommendationField
description: Reference to a recommendation campaign
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: RecommendationSubtype
x-interface-name-ts: RecommendationSubtype
description: This type of field lets you retrieve the result of a recommendation campaign.
enum:
- recommendation
properties:
type: object
title: Recommendation properties
x-class-name: RecommendationFieldProperties
x-interface-name-ts: RecommendationFieldProperties
description: |
- `id.default` defines the default recommendation campaign to generate a recommendation from.
- In `params.itemId`, you can add a default item context (required by some recommendation types):
```
"itemId": {
"type": "string",
"subtype": "string"
"default": "defaultItemIdForItemContext"
}
```
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Recommendation default
x-class-name: RecommendationFieldDefault
x-interface-name-ts: RecommendationFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of a recommendation campaign
params:
type: object
title: Recommendation default params
x-class-name: RecommendationFieldDefaultParams
x-interface-name-ts: RecommendationFieldDefaultParams
description: Item context
properties:
itemId:
type: string
description: Unique ID of an item context (required for some recommendation types)
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Metric
x-class-name: MetricField
x-interface-name-ts: MetricField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: MetricSubtype
x-interface-name-ts: MetricSubtype
enum:
- metric
properties:
type: object
description: |
- `id` is the default ID of an metric.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Metric default
x-class-name: MetricFieldDefault
x-interface-name-ts: MetricFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Aggregate
x-class-name: AggregateField
x-interface-name-ts: AggregateField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: AggregateSubtype
x-interface-name-ts: AggregateSubtype
enum:
- aggregate
properties:
type: object
description: |
- `id` is the default ID of an analysis.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Aggregate default
x-class-name: AggregateFieldDefault
x-interface-name-ts: AggregateFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Expression
x-class-name: ExpressionField
x-interface-name-ts: ExpressionField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: ExpressionSubtype
x-interface-name-ts: ExpressionSubtype
enum:
- expression
properties:
type: object
description: |
- `id` is the default ID of an expression.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
$ref: "#/components/schemas/brickworks-service-FieldFormMap"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
x-class-name: ExpressionFieldDefault
x-interface-name-ts: ExpressionFieldDefault
title: Expression default
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
discriminator:
propertyName: subtype
mapping:
file: "#/components/schemas/brickworks-service-FileField"
image: "#/components/schemas/brickworks-service-ImageField"
catalog_item: "#/components/schemas/brickworks-service-CatalogItemField"
promotion: "#/components/schemas/brickworks-service-PromotionField"
voucher: "#/components/schemas/brickworks-service-VoucherField"
recommendation: "#/components/schemas/brickworks-service-RecommendationField"
metric: "#/components/schemas/brickworks-service-MetricField"
aggregate: "#/components/schemas/brickworks-service-AggregateField"
expression: "#/components/schemas/brickworks-service-ExpressionField"
config:
type: object
title: Synerise object array config
x-class-name: SyneriseArrayConfig
x-interface-name-ts: SyneriseArrayConfig
description: |
Settings applied when the Synerise objects of the array are resolved during content generation.
- `nullOnFail` - when `true` and resolving an object fails, that item becomes `null` instead of failing the whole field. Defaults to `false`.
- `removeNulls` - when `true`, the `null` items are removed from the resolved array. Defaults to `true`.
properties:
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
removeNulls:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
minItems:
type: integer
format: int32
description: The minimum number of items allowed in the array
maxItems:
type: integer
format: int32
description: The maximum number of items allowed in the array
uniqueItems:
type: boolean
description: When `true`, the values in the array must be unique
default:
type: array
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
items: {}
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- items
- config
discriminator:
propertyName: subtype
mapping:
boolean: "#/components/schemas/brickworks-service-BooleanForm"
string: "#/components/schemas/brickworks-service-StringForm"
integer: "#/components/schemas/brickworks-service-IntegerForm"
number: "#/components/schemas/brickworks-service-NumberForm"
enum: "#/components/schemas/brickworks-service-EnumForm"
date: "#/components/schemas/brickworks-service-DateForm"
date-time: "#/components/schemas/brickworks-service-DateTimeForm"
typed_array: "#/components/schemas/brickworks-service-ArrayForm"
uuid: "#/components/schemas/brickworks-service-UUIDForm"
jinjava: "#/components/schemas/brickworks-service-JinJavaForm"
one_to_one: "#/components/schemas/brickworks-service-ReferenceForm"
catalog_item: "#/components/schemas/brickworks-service-CatalogItemField"
key_value: "#/components/schemas/brickworks-service-KeyValueObject"
external_source: "#/components/schemas/brickworks-service-ExternalHttpSource"
one_to_many: "#/components/schemas/brickworks-service-OneToManyForm"
metric: "#/components/schemas/brickworks-service-MetricField"
expression: "#/components/schemas/brickworks-service-ExpressionField"
aggregate: "#/components/schemas/brickworks-service-AggregateField"
promotion: "#/components/schemas/brickworks-service-PromotionField"
file: "#/components/schemas/brickworks-service-FileField"
image: "#/components/schemas/brickworks-service-ImageField"
recommendation: "#/components/schemas/brickworks-service-RecommendationField"
ai_search: "#/components/schemas/brickworks-service-AiSearchField"
ai_search_listing: "#/components/schemas/brickworks-service-AiSearchListingField"
voucher: "#/components/schemas/brickworks-service-VoucherField"
untyped_object: "#/components/schemas/brickworks-service-UntypedJson"
untyped_array: "#/components/schemas/brickworks-service-UntypedArray"
json: "#/components/schemas/brickworks-service-UntypedForm"
client_attribute: "#/components/schemas/brickworks-service-ProfileAttributeField"
filter: "#/components/schemas/brickworks-service-OneToManyFilterForm"
synerise_array: "#/components/schemas/brickworks-service-SyneriseArrayForm"
x-typescript-type: "{ [key: string]: FieldForm }"
brickworks-service-FieldForm:
type: object
x-class-name: FieldForm
x-interface-name-ts: FieldForm
description: Each key is the name of a field (called "API name" in the Synerise Portal).
oneOf:
- type: object
title: Number
x-class-name: NumberForm
x-interface-name-ts: NumberForm
description: This field type accepts static numeric values. `number` is used for floating-point values.
properties:
type:
type: string
title: Number type
x-class-name: NumberType
x-interface-name-ts: NumberType
enum:
- number
subtype:
type: string
x-class-name: NumberSubtype
x-interface-name-ts: NumberSubtype
enum:
- number
minimum:
type: number
format: float
description: Minimum value
maximum:
type: number
format: float
description: Maximum value
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: number
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Integer
x-class-name: IntegerForm
x-interface-name-ts: IntegerForm
properties:
type:
type: string
title: IntegerType
x-class-name: IntegerType
x-interface-name-ts: IntegerType
enum:
- integer
subtype:
type: string
x-class-name: IntegerSubtype
x-interface-name-ts: IntegerSubtype
enum:
- integer
minimum:
type: number
format: int32
description: Minimum value
maximum:
type: number
format: int32
description: Maximum value
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: number
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Enumeration
x-class-name: EnumForm
x-interface-name-ts: EnumForm
description: This type of field defines a list of strings which can be used as the value. Only one of the allowed values can be saved in the record.
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: EnumSubtype
x-interface-name-ts: EnumSubtype
enum:
- enum
enum:
type: array
description: A list of strings which can be selected as the value
items:
type: string
names:
type: object
description: |
A mapping of the field values and their names displayed in the record.
For example, if `enum` contains the value `exampleValue` and you want the UI to show `Example Value` on the list, set:
```
"names": {
"exampleValue": "Example Value"
}
```
additionalProperties:
type: string
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- enum
- names
- type: object
title: Date
x-class-name: DateForm
x-interface-name-ts: DateForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: DateSubtype
x-interface-name-ts: DateSubtype
enum:
- date
default:
type: string
format: date
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Date and time
x-class-name: DateTimeForm
x-interface-name-ts: DateTimeForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: DateTimeSubtype
x-interface-name-ts: DateTimeSubtype
enum:
- date-time
default:
type: string
format: date-time
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Array
x-class-name: ArrayForm
x-interface-name-ts: ArrayForm
description: This type of field accepts an array of values. The type of values is defined in `items`
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: TypedArraySubtype
x-interface-name-ts: TypedArraySubtype
enum:
- typed_array
items:
type: object
description: The definition of the type of value allowed in the array. All values must be of the same type.
oneOf:
- type: object
title: Number
x-class-name: NumberForm
x-interface-name-ts: NumberForm
description: This field type accepts static numeric values. `number` is used for floating-point values.
properties:
type:
type: string
title: Number type
x-class-name: NumberType
x-interface-name-ts: NumberType
enum:
- number
subtype:
type: string
x-class-name: NumberSubtype
x-interface-name-ts: NumberSubtype
enum:
- number
minimum:
type: number
format: float
description: Minimum value
maximum:
type: number
format: float
description: Maximum value
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: number
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Integer
x-class-name: IntegerForm
x-interface-name-ts: IntegerForm
properties:
type:
type: string
title: IntegerType
x-class-name: IntegerType
x-interface-name-ts: IntegerType
enum:
- integer
subtype:
type: string
x-class-name: IntegerSubtype
x-interface-name-ts: IntegerSubtype
enum:
- integer
minimum:
type: number
format: int32
description: Minimum value
maximum:
type: number
format: int32
description: Maximum value
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: number
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Enumeration
x-class-name: EnumForm
x-interface-name-ts: EnumForm
description: This type of field defines a list of strings which can be used as the value. Only one of the allowed values can be saved in the record.
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: EnumSubtype
x-interface-name-ts: EnumSubtype
enum:
- enum
enum:
type: array
description: A list of strings which can be selected as the value
items:
type: string
names:
type: object
description: |
A mapping of the field values and their names displayed in the record.
For example, if `enum` contains the value `exampleValue` and you want the UI to show `Example Value` on the list, set:
```
"names": {
"exampleValue": "Example Value"
}
```
additionalProperties:
type: string
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- enum
- names
discriminator:
propertyName: subtype
mapping:
number: "#/components/schemas/brickworks-service-NumberForm"
integer: "#/components/schemas/brickworks-service-IntegerForm"
boolean: "#/components/schemas/brickworks-service-BooleanForm"
string: "#/components/schemas/brickworks-service-StringForm"
enum: "#/components/schemas/brickworks-service-EnumForm"
maxItems:
type: number
format: int32
description: The maximum number of items allowed in the array
uniqueItems:
type: boolean
description: When `true`, the values in the array must be unique
default:
type: array
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
items: {}
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- items
- subtype
- type: object
title: UUID
x-class-name: UUIDForm
x-interface-name-ts: UUIDForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: UUIDSubtype
x-interface-name-ts: UUIDSubtype
enum:
- uuid
default:
type: string
format: uuid
title: UUID default
x-class-name: UUIDFormDefault
x-interface-name-ts: UUIDFormDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Jinjava
x-class-name: JinJavaForm
x-interface-name-ts: JinJavaForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: JinJavaSubtype
x-interface-name-ts: JinJavaSubtype
enum:
- jinjava
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
settings:
type: object
x-class-name: JinJavaSettings
x-interface-name-ts: JinJavaSettings
nullable: true
description: Settings for casting the Jinjava result to a data type. Casting may not be successful - set the `strict` setting to decide how to proceed in that case.
properties:
castType:
type: string
description: The data type to try casting the Jinjava result to
x-class-name: JinJavaCastType
x-interface-name-ts: JinJavaCastType
enum:
- boolean
- integer
- number
- json
strict:
type: boolean
description: |
Defines what happens when casting is not successful:
- `true` throws an error in generating an object from a record
- `false` sets the value to null
removeWhitespaces:
type: boolean
description: |
When `true`, all whitespace characters (e.g. `\r`, `\n`, spaces, tabs) are removed from the Jinjava render result before casting.
required:
- strict
- castType
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Catalog
x-class-name: CatalogItemField
x-interface-name-ts: CatalogItemField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: CatalogItemSubtype
x-interface-name-ts: CatalogItemSubtype
enum:
- catalog_item
properties:
type: object
title: CatalogItemFieldProperties
description: |
The data of the catalog. `id` is the default catalogId and `itemKey` is the default unique identifier of an item. You can override both when creating/updating a record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
itemKey:
oneOf:
- type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Jinjava
x-class-name: JinJavaForm
x-interface-name-ts: JinJavaForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: JinJavaSubtype
x-interface-name-ts: JinJavaSubtype
enum:
- jinjava
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
settings:
type: object
x-class-name: JinJavaSettings
x-interface-name-ts: JinJavaSettings
nullable: true
description: Settings for casting the Jinjava result to a data type. Casting may not be successful - set the `strict` setting to decide how to proceed in that case.
properties:
castType:
type: string
description: The data type to try casting the Jinjava result to
x-class-name: JinJavaCastType
x-interface-name-ts: JinJavaCastType
enum:
- boolean
- integer
- number
- json
strict:
type: boolean
description: |
Defines what happens when casting is not successful:
- `true` throws an error in generating an object from a record
- `false` sets the value to null
removeWhitespaces:
type: boolean
description: |
When `true`, all whitespace characters (e.g. `\r`, `\n`, spaces, tabs) are removed from the Jinjava render result before casting.
required:
- strict
- castType
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
discriminator:
propertyName: subtype
mapping:
jinjava: "#/components/schemas/brickworks-service-JinJavaForm"
string: "#/components/schemas/brickworks-service-StringForm"
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- itemKey
default:
type: object
title: Catalog default
x-class-name: CatalogFieldDefault
x-interface-name-ts: CatalogFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique ID of a catalog
itemKey:
type: string
description: Static string or Jinjava that inserts the unique ID of an item in the catalog
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
$ref: "#/components/schemas/brickworks-service-FieldForm"
x-typescript-type: "{ [key: string]: FieldForm }"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
- type: object
title: External source
x-class-name: ExternalSourceField
x-interface-name-ts: ExternalSourceField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: ExternalSourceSubtype
x-interface-name-ts: ExternalSourceSubtype
enum:
- external_source
sourceType:
type: string
enum:
- http
sourceId:
type: string
description: Unique ID of the external source definition
format: uuid
headers:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
$ref: "#/components/schemas/brickworks-service-FieldForm"
x-typescript-type: "{ [key: string]: FieldForm }"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
$ref: "#/components/schemas/brickworks-service-FieldForm"
x-typescript-type: "{ [key: string]: FieldForm }"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
body:
$ref: "#/components/schemas/brickworks-service-FieldForm"
properties:
type: object
x-class-name: ExternalSourceFieldProperties
x-interface-name-ts: ExternalSourceFieldProperties
description: Behavior of the external source field when the source call fails. `returnErrorBodyOnFail` takes precedence over `nullOnFail` for received error responses.
properties:
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
returnErrorBodyOnFail:
type: boolean
nullable: true
description: |
Defines what happens when the external source responds with an error (non-2xx) status:
- `true` — instead of failing the generate request (or returning null when `nullOnFail` is enabled), the field resolves to a JSON object with the error details: `response.status`, `response.body`, `request.url`, `request.method`, `request.body`. Useful for debugging and for building a custom flow based on errors.
- `false` (default, also when absent or null) — standard behavior applies: `nullOnFail` decides between failing the request and a null field value.
Covers only received HTTP responses. Connection-level failures (e.g. timeouts) and a missing external source definition still fail the request.
required:
- nullOnFail
default:
type: object
title: External source default
x-class-name: ExternalHttpSourceDefault
x-interface-name-ts: ExternalHttpSourceDefault
nullable: true
properties:
headers:
type: object
description: Request headers
additionalProperties: true
params:
type: object
description: The url parameters
additionalProperties: true
body:
type: object
description: Request body
additionalProperties: true
properties:
type: object
title: External source properties
x-class-name: ExternalHttpSourcePropertiesValues
x-interface-name-ts: ExternalHttpSourcePropertiesValues
properties:
nullOnFail:
type: boolean
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- sourceType
- sourceId
- type: object
title: Record reference
x-class-name: ReferenceForm
x-interface-name-ts: ReferenceForm
description: Definition of a reference to another schema
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: OneToOneSubtype
x-interface-name-ts: OneToOneSubtype
description: |
This field type lets you include references to a record from another schema. To generate an object, the referenced record must be published. Its content (for example, an expression field in the referenced record) will be processed when generating an object.
enum:
- one_to_one
referenceId:
type: string
description: Unique identifier of the schema you want to access a record from. When creating a record with this field, you will provide the UUID of the referenced record from that schema.
default:
type: string
format: uuid
description: The default record to reference. In "one to many" fields, use the `default` array in the parent object instead of this property.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Multiple record reference
x-class-name: OneToManyForm
x-interface-name-ts: OneToManyForm
description: This type of field allows you to reference multiple records from another schema. `items` defines the target schema.
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: OneToManySubtype
x-interface-name-ts: OneToManySubtype
enum:
- one_to_many
items:
type: object
title: Record reference
x-class-name: ReferenceForm
x-interface-name-ts: ReferenceForm
description: Definition of a reference to another schema
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: OneToOneSubtype
x-interface-name-ts: OneToOneSubtype
description: |
This field type lets you include references to a record from another schema. To generate an object, the referenced record must be published. Its content (for example, an expression field in the referenced record) will be processed when generating an object.
enum:
- one_to_one
referenceId:
type: string
description: Unique identifier of the schema you want to access a record from. When creating a record with this field, you will provide the UUID of the referenced record from that schema.
default:
type: string
format: uuid
description: The default record to reference. In "one to many" fields, use the `default` array in the parent object instead of this property.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
maxItems:
type: number
minimum: 1
maximum: 100
default: 20
description: The maximum number of records that can be referenced.
default:
type: array
description: An array of default record references (record UUIDs)
items:
type: string
format: uuid
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- items
- subtype
- type: object
description: Reference to a Synerise analysis
title: Metric
x-class-name: MetricField
x-interface-name-ts: MetricField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: MetricSubtype
x-interface-name-ts: MetricSubtype
enum:
- metric
properties:
type: object
description: |
- `id` is the default ID of an metric.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
$ref: "#/components/schemas/brickworks-service-FieldForm"
x-typescript-type: "{ [key: string]: FieldForm }"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Metric default
x-class-name: MetricFieldDefault
x-interface-name-ts: MetricFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Aggregate
x-class-name: AggregateField
x-interface-name-ts: AggregateField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: AggregateSubtype
x-interface-name-ts: AggregateSubtype
enum:
- aggregate
properties:
type: object
description: |
- `id` is the default ID of an analysis.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
$ref: "#/components/schemas/brickworks-service-FieldForm"
x-typescript-type: "{ [key: string]: FieldForm }"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Aggregate default
x-class-name: AggregateFieldDefault
x-interface-name-ts: AggregateFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Expression
x-class-name: ExpressionField
x-interface-name-ts: ExpressionField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: ExpressionSubtype
x-interface-name-ts: ExpressionSubtype
enum:
- expression
properties:
type: object
description: |
- `id` is the default ID of an expression.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
$ref: "#/components/schemas/brickworks-service-FieldForm"
x-typescript-type: "{ [key: string]: FieldForm }"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
x-class-name: ExpressionFieldDefault
x-interface-name-ts: ExpressionFieldDefault
title: Expression default
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Promotion
x-class-name: PromotionField
x-interface-name-ts: PromotionField
description: Reference to a promotion
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: PromotionSubtype
x-interface-name-ts: PromotionSubtype
enum:
- promotion
properties:
type: object
x-class-name: PromotionFieldProperties
x-interface-name-ts: PromotionFieldProperties
description: "`id` defines the promotion to access. In `default`, enter the default promotion UUID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Promotion default
x-class-name: PromotionFieldDefault
x-interface-name-ts: PromotionFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of a promotion campaign
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: File
x-class-name: FileField
x-interface-name-ts: FileField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: FileSubtype
x-interface-name-ts: FileSubtype
description: This type of field lets you store links to [files uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/).
enum:
- file
properties:
type: object
x-class-name: FileFieldProperties
x-interface-name-ts: FileFieldProperties
description: "`id` defines the unique ID of a [file uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/). In `default`, enter the default file ID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
default:
type: object
title: File default
x-class-name: FileFieldDefault
x-interface-name-ts: FileFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique identifier of an image/file in the File Explorer
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Image
x-class-name: ImageField
x-interface-name-ts: ImageField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
description: This type of field lets you store links to images.
enum:
- image
properties:
type: object
x-class-name: FileFieldProperties
x-interface-name-ts: FileFieldProperties
description: "`id` defines the unique ID of a [file uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/). In `default`, enter the default file ID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
default:
type: object
title: Image default
x-class-name: ImageFieldDefault
x-interface-name-ts: ImageFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique identifier of an image/file in the File Explorer
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Recommendation
x-class-name: RecommendationField
x-interface-name-ts: RecommendationField
description: Reference to a recommendation campaign
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: RecommendationSubtype
x-interface-name-ts: RecommendationSubtype
description: This type of field lets you retrieve the result of a recommendation campaign.
enum:
- recommendation
properties:
type: object
title: Recommendation properties
x-class-name: RecommendationFieldProperties
x-interface-name-ts: RecommendationFieldProperties
description: |
- `id.default` defines the default recommendation campaign to generate a recommendation from.
- In `params.itemId`, you can add a default item context (required by some recommendation types):
```
"itemId": {
"type": "string",
"subtype": "string"
"default": "defaultItemIdForItemContext"
}
```
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
$ref: "#/components/schemas/brickworks-service-FieldForm"
x-typescript-type: "{ [key: string]: FieldForm }"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Recommendation default
x-class-name: RecommendationFieldDefault
x-interface-name-ts: RecommendationFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of a recommendation campaign
params:
type: object
title: Recommendation default params
x-class-name: RecommendationFieldDefaultParams
x-interface-name-ts: RecommendationFieldDefaultParams
description: Item context
properties:
itemId:
type: string
description: Unique ID of an item context (required for some recommendation types)
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: AI Search
x-class-name: AiSearchField
x-interface-name-ts: AiSearchField
description: Reference to an AI Search index used to perform a search query
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: AiSearchSubtype
x-interface-name-ts: AiSearchSubtype
description: This type of field lets you retrieve results of an AI Search query against a chosen index.
enum:
- ai_search
properties:
type: object
title: AI Search properties
x-class-name: AiSearchFieldProperties
x-interface-name-ts: AiSearchFieldProperties
description: |
- `id.default` defines the default AI Search index used to perform the search.
- `query.default` defines the default search phrase (accepts a string or a Jinjava expression).
- In `params`, you can declare additional query parameters supported by the AI Search API
(e.g. `filters`, `facets`, `displayAttributes`, `personalize`).
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
query:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
$ref: "#/components/schemas/brickworks-service-FieldForm"
x-typescript-type: "{ [key: string]: FieldForm }"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- query
default:
type: object
title: AI Search default
x-class-name: AiSearchFieldDefault
x-interface-name-ts: AiSearchFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- Set to `null` (or omit) to declare no default at all.
- Send an empty object `{}` to declare an empty default — it is merged with the record value, or applied directly when the record does not provide one.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of the AI Search index
query:
type: string
description: Default search query phrase
params:
type: object
title: AI Search default params
x-class-name: AiSearchFieldDefaultParams
x-interface-name-ts: AiSearchFieldDefaultParams
description: Additional default query parameters
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: AI Listing
x-class-name: AiSearchListingField
x-interface-name-ts: AiSearchListingField
description: Reference to an AI Search index used to retrieve a listing (no query phrase)
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: AiSearchListingSubtype
x-interface-name-ts: AiSearchListingSubtype
description: This type of field lets you retrieve listing results from an AI Search index (without a query phrase).
enum:
- ai_search_listing
properties:
type: object
title: AI Listing properties
x-class-name: AiSearchListingFieldProperties
x-interface-name-ts: AiSearchListingFieldProperties
description: |
- `id.default` defines the default AI Search index used to fetch the listing.
- In `params`, you can declare additional query parameters supported by the AI Search listing API
(e.g. `filters`, `facets`, `displayAttributes`, `personalize`).
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
$ref: "#/components/schemas/brickworks-service-FieldForm"
x-typescript-type: "{ [key: string]: FieldForm }"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: AI Listing default
x-class-name: AiSearchListingFieldDefault
x-interface-name-ts: AiSearchListingFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- Set to `null` (or omit) to declare no default at all.
- Send an empty object `{}` to declare an empty default — it is merged with the record value, or applied directly when the record does not provide one.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of the AI Search index
params:
type: object
title: AI Listing default params
x-class-name: AiSearchListingFieldDefaultParams
x-interface-name-ts: AiSearchListingFieldDefaultParams
description: Additional default query parameters
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Voucher
x-class-name: VoucherField
x-interface-name-ts: VoucherField
description: Reference to a voucher
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: VoucherSubtype
x-interface-name-ts: VoucherSubtype
description: This type of fields lets you retrieve a voucher from a pool. The voucher is retrieved when you generate an object from the record.
enum:
- voucher
properties:
type: object
title: Voucher properties
x-class-name: VoucherFieldProperties
x-interface-name-ts: VoucherFieldProperties
description: |
- in `id.default`, enter the UUID of the voucher pool. It can be changed per record.
- in `assign.default`:
- `false` means that once a code from a given pool is retrieved to a profile, it becomes assigned to the profile and is always returned in subsequent requests.
- `true` means that a different code is retrieved for a profile with every request. This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
assign:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- assign
default:
type: object
title: Voucher default
x-class-name: VoucherFieldDefault
x-interface-name-ts: VoucherFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of the voucher
assign:
type: boolean
description: |
- `false` means that once a code from a given pool is retrieved to a profile, it becomes assigned to the profile and is always returned in subsequent requests.
- `true` means that a different code is retrieved for a profile with every request. This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Untyped JSON
x-class-name: UntypedJson
x-interface-name-ts: UntypedJson
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: UntypedObjectSubtype
x-interface-name-ts: UntypedObjectSubtype
description: This type of field lets you save any JSON data in the record, without validating it against any schema
enum:
- untyped_object
default:
type: object
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
additionalProperties: true
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Untyped array
x-class-name: UntypedArray
x-interface-name-ts: UntypedArray
description: This type of field accepts an array of values. The values can be of any data type.
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: UntypedArraySubtype
x-interface-name-ts: UntypedArraySubtype
enum:
- untyped_array
default:
type: array
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
items: {}
maxItems:
type: number
format: int32
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
x-class-name: UntypedForm
x-interface-name-ts: UntypedForm
description: Field without typed structure
properties:
anyOf:
type: array
minItems: 2
maxItems: 2
items:
oneOf:
- type: object
title: Untyped JSON
x-class-name: UntypedJson
x-interface-name-ts: UntypedJson
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: UntypedObjectSubtype
x-interface-name-ts: UntypedObjectSubtype
description: This type of field lets you save any JSON data in the record, without validating it against any schema
enum:
- untyped_object
default:
type: object
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
additionalProperties: true
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Untyped array
x-class-name: UntypedArray
x-interface-name-ts: UntypedArray
description: This type of field accepts an array of values. The values can be of any data type.
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: UntypedArraySubtype
x-interface-name-ts: UntypedArraySubtype
enum:
- untyped_array
default:
type: array
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
items: {}
maxItems:
type: number
format: int32
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
subtype:
type: string
x-class-name: UntypedFormSubtype
x-interface-name-ts: UntypedFormSubtype
enum:
- json
default:
type: object
additionalProperties: true
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- anyOf
- subtype
- type: object
title: Profile attribute field
x-class-name: ProfileAttributeField
x-interface-name-ts: ProfileAttributeField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: ProfileAttributeSubtype
x-interface-name-ts: ProfileAttributeSubtype
description: This type of field references an attribute by name and retrieves its value.
enum:
- client_attribute
settings:
type: object
x-class-name: ProfileAttributeSettings
x-interface-name-ts: ProfileAttributeSettings
description: Additional settings of the field
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
castType:
type: string
description: The data type to try casting the attribute to
enum:
- none
- boolean
- number
- integer
- string
strict:
description: |
Defines what happens when casting is not successful:
- `true` throws an error in generating an object from a record
- `false` sets the value to null
required:
- castType
- strict
properties:
type: object
x-class-name: ProfileAttributeProperties
x-interface-name-ts: ProfileAttributeProperties
description: In `attributeName.default`, enter the default name of the profile attribute to retrieve a value from when generating content from a record
properties:
attributeName:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- attributeName
default:
type: object
title: ProfileAttributeFieldDefault
x-class-name: ProfileAttributeFieldDefault
x-interface-name-ts: ProfileAttributeFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
attributeName:
type: string
description: The name of the profile attribute to retrieve a value from when generating content from a record
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
description: Always false, don't send in requests
required:
- type
- subtype
- properties
- type: object
title: Record reference filter
x-class-name: OneToManyFilterForm
x-interface-name-ts: OneToManyFilterForm
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: OneToManyFilterSubtype
x-interface-name-ts: OneToManyFilterSubtype
enum:
- filter
description: This field type allows you to retrieve records from another schema and filter/sort them
schemaId:
type: string
format: uuid
description: Unique ID of the schema, generated automatically.
properties:
type: object
title: One to many filter properties
description: |
Definitions of the values allowed in the filter settings. If your integration flow involves using the Synerise Web Portal, you shouldn't use this object.
You can sort by these parameters:
- `id`
- `createdAt`
- `updatedAt`
x-class-name: OneToManyFilterProperties
x-interface-name-ts: OneToManyFilterProperties
properties:
query:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
sortBy:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
sortDirection:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- query
- sortBy
- sortDirection
default:
type: object
title: One to many filter form default
description: Default filter settings
x-class-name: OneToManyFilterFormDefault
x-interface-name-ts: OneToManyFilterFormDefault
properties:
query:
type: string
description: RSQL query to filter the records
sortBy:
type: string
description: The property to sort by
enum:
- id
- createdAt
- updatedAt
sortDirection:
type: string
description: Sorting direction
enum:
- asc
- desc
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
description: Field generated automatically, don't send in requests.
required:
- type
- subtype
- schemaId
- properties
- type: object
title: Synerise object array
x-class-name: SyneriseArrayForm
x-interface-name-ts: SyneriseArrayForm
description: This type of field accepts an array of Synerise objects. The type of the objects is defined in `items`. All objects must be of the same type.
properties:
type:
type: string
title: ArrayType
x-class-name: ArrayType
x-interface-name-ts: ArrayType
enum:
- array
subtype:
type: string
x-class-name: SyneriseArraySubtype
x-interface-name-ts: SyneriseArraySubtype
description: This type of field accepts an array of Synerise objects. The type of the objects is defined in `items`.
enum:
- synerise_array
items:
type: object
title: Synerise object array item
x-class-name: SyneriseArrayFieldForm
x-interface-name-ts: SyneriseArrayFieldForm
description: The Synerise object stored in the items of a `synerise_array` field. All items of the array must be of the same type.
oneOf:
- type: object
title: File
x-class-name: FileField
x-interface-name-ts: FileField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: FileSubtype
x-interface-name-ts: FileSubtype
description: This type of field lets you store links to [files uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/).
enum:
- file
properties:
type: object
x-class-name: FileFieldProperties
x-interface-name-ts: FileFieldProperties
description: "`id` defines the unique ID of a [file uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/). In `default`, enter the default file ID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
default:
type: object
title: File default
x-class-name: FileFieldDefault
x-interface-name-ts: FileFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique identifier of an image/file in the File Explorer
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Image
x-class-name: ImageField
x-interface-name-ts: ImageField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
description: This type of field lets you store links to images.
enum:
- image
properties:
type: object
x-class-name: FileFieldProperties
x-interface-name-ts: FileFieldProperties
description: "`id` defines the unique ID of a [file uploaded to Synerise](https://hub.synerise.com/docs/assets/files-explorer/). In `default`, enter the default file ID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
default:
type: object
title: Image default
x-class-name: ImageFieldDefault
x-interface-name-ts: ImageFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique identifier of an image/file in the File Explorer
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Catalog
x-class-name: CatalogItemField
x-interface-name-ts: CatalogItemField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: CatalogItemSubtype
x-interface-name-ts: CatalogItemSubtype
enum:
- catalog_item
properties:
type: object
title: CatalogItemFieldProperties
description: |
The data of the catalog. `id` is the default catalogId and `itemKey` is the default unique identifier of an item. You can override both when creating/updating a record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
itemKey:
oneOf:
- type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- type: object
title: Jinjava
x-class-name: JinJavaForm
x-interface-name-ts: JinJavaForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
x-class-name: JinJavaSubtype
x-interface-name-ts: JinJavaSubtype
enum:
- jinjava
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
settings:
type: object
x-class-name: JinJavaSettings
x-interface-name-ts: JinJavaSettings
nullable: true
description: Settings for casting the Jinjava result to a data type. Casting may not be successful - set the `strict` setting to decide how to proceed in that case.
properties:
castType:
type: string
description: The data type to try casting the Jinjava result to
x-class-name: JinJavaCastType
x-interface-name-ts: JinJavaCastType
enum:
- boolean
- integer
- number
- json
strict:
type: boolean
description: |
Defines what happens when casting is not successful:
- `true` throws an error in generating an object from a record
- `false` sets the value to null
removeWhitespaces:
type: boolean
description: |
When `true`, all whitespace characters (e.g. `\r`, `\n`, spaces, tabs) are removed from the Jinjava render result before casting.
required:
- strict
- castType
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
discriminator:
propertyName: subtype
mapping:
jinjava: "#/components/schemas/brickworks-service-JinJavaForm"
string: "#/components/schemas/brickworks-service-StringForm"
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- itemKey
default:
type: object
title: Catalog default
x-class-name: CatalogFieldDefault
x-interface-name-ts: CatalogFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: Unique ID of a catalog
itemKey:
type: string
description: Static string or Jinjava that inserts the unique ID of an item in the catalog
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Promotion
x-class-name: PromotionField
x-interface-name-ts: PromotionField
description: Reference to a promotion
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: PromotionSubtype
x-interface-name-ts: PromotionSubtype
enum:
- promotion
properties:
type: object
x-class-name: PromotionFieldProperties
x-interface-name-ts: PromotionFieldProperties
description: "`id` defines the promotion to access. In `default`, enter the default promotion UUID."
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Promotion default
x-class-name: PromotionFieldDefault
x-interface-name-ts: PromotionFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of a promotion campaign
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Voucher
x-class-name: VoucherField
x-interface-name-ts: VoucherField
description: Reference to a voucher
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: VoucherSubtype
x-interface-name-ts: VoucherSubtype
description: This type of fields lets you retrieve a voucher from a pool. The voucher is retrieved when you generate an object from the record.
enum:
- voucher
properties:
type: object
title: Voucher properties
x-class-name: VoucherFieldProperties
x-interface-name-ts: VoucherFieldProperties
description: |
- in `id.default`, enter the UUID of the voucher pool. It can be changed per record.
- in `assign.default`:
- `false` means that once a code from a given pool is retrieved to a profile, it becomes assigned to the profile and is always returned in subsequent requests.
- `true` means that a different code is retrieved for a profile with every request. This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
assign:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
- assign
default:
type: object
title: Voucher default
x-class-name: VoucherFieldDefault
x-interface-name-ts: VoucherFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: ID of the voucher
assign:
type: boolean
description: |
- `false` means that once a code from a given pool is retrieved to a profile, it becomes assigned to the profile and is always returned in subsequent requests.
- `true` means that a different code is retrieved for a profile with every request. This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
title: Recommendation
x-class-name: RecommendationField
x-interface-name-ts: RecommendationField
description: Reference to a recommendation campaign
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: RecommendationSubtype
x-interface-name-ts: RecommendationSubtype
description: This type of field lets you retrieve the result of a recommendation campaign.
enum:
- recommendation
properties:
type: object
title: Recommendation properties
x-class-name: RecommendationFieldProperties
x-interface-name-ts: RecommendationFieldProperties
description: |
- `id.default` defines the default recommendation campaign to generate a recommendation from.
- In `params.itemId`, you can add a default item context (required by some recommendation types):
```
"itemId": {
"type": "string",
"subtype": "string"
"default": "defaultItemIdForItemContext"
}
```
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
params:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
$ref: "#/components/schemas/brickworks-service-FieldForm"
x-typescript-type: "{ [key: string]: FieldForm }"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Recommendation default
x-class-name: RecommendationFieldDefault
x-interface-name-ts: RecommendationFieldDefault
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of a recommendation campaign
params:
type: object
title: Recommendation default params
x-class-name: RecommendationFieldDefaultParams
x-interface-name-ts: RecommendationFieldDefaultParams
description: Item context
properties:
itemId:
type: string
description: Unique ID of an item context (required for some recommendation types)
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Metric
x-class-name: MetricField
x-interface-name-ts: MetricField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: MetricSubtype
x-interface-name-ts: MetricSubtype
enum:
- metric
properties:
type: object
description: |
- `id` is the default ID of an metric.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
$ref: "#/components/schemas/brickworks-service-FieldForm"
x-typescript-type: "{ [key: string]: FieldForm }"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Metric default
x-class-name: MetricFieldDefault
x-interface-name-ts: MetricFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Aggregate
x-class-name: AggregateField
x-interface-name-ts: AggregateField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: AggregateSubtype
x-interface-name-ts: AggregateSubtype
enum:
- aggregate
properties:
type: object
description: |
- `id` is the default ID of an analysis.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
$ref: "#/components/schemas/brickworks-service-FieldForm"
x-typescript-type: "{ [key: string]: FieldForm }"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
title: Aggregate default
x-class-name: AggregateFieldDefault
x-interface-name-ts: AggregateFieldDefault
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
- type: object
description: Reference to a Synerise analysis
title: Expression
x-class-name: ExpressionField
x-interface-name-ts: ExpressionField
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: ExpressionSubtype
x-interface-name-ts: ExpressionSubtype
enum:
- expression
properties:
type: object
description: |
- `id` is the default ID of an expression.
- `variables` is a set of variables to pass when the analysis has dynamic fields.
- `includeDetails` defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
properties:
id:
type: object
title: String
x-class-name: StringForm
x-interface-name-ts: StringForm
properties:
type:
type: string
title: String type
x-class-name: StringType
x-interface-name-ts: StringType
enum:
- string
subtype:
type: string
title: String subtype
x-class-name: StringSubtype
x-interface-name-ts: StringSubtype
enum:
- string
minLength:
type: number
format: int32
description: Minimum number of characters in the string
maxLength:
type: number
format: int32
description: Maximum number of characters in the string
pattern:
type: string
description: Regular expression that the string must match
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
type: string
nullable: true
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
variables:
type: object
title: Key and value
x-class-name: KeyValueObject
x-interface-name-ts: KeyValueObject
description: A key/value map.
properties:
type:
type: string
title: Object type
x-class-name: ObjectType
x-interface-name-ts: ObjectType
enum:
- object
subtype:
type: string
x-class-name: KeyValueSubtype
x-interface-name-ts: KeyValueSubtype
description: |
This type of field is a reference to an external source. The request to an external source is made when you generate content from a record.
**NOTE**: The `headers`, `params`, and `body` properties are not currently supported by the Synerise Portal.
enum:
- key_value
properties:
type: object
x-class-name: FieldFormMap
x-interface-name-ts: FieldFormMap
description: Fields in the schema
additionalProperties:
$ref: "#/components/schemas/brickworks-service-FieldForm"
x-typescript-type: "{ [key: string]: FieldForm }"
default:
type: object
title: Key and value default
x-class-name: KeyValueObjectDefault
x-interface-name-ts: KeyValueObjectDefault
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
additionalProperties:
type: boolean
required:
- type
- subtype
includeDetails:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
required:
- id
default:
type: object
x-class-name: ExpressionFieldDefault
x-interface-name-ts: ExpressionFieldDefault
title: Expression default
nullable: true
description: |
The default value of the field.
- This object overrides the defaults from the `properties` object.
- **To set no default, send this object empty**. `"default": null` overrides `properties` with a null value.
- This object is required when `isConstantField = true`
properties:
id:
type: string
description: UUID of an analysis
variables:
type: object
additionalProperties:
description: Values of dynamic keys in the analysis
includeDetails:
type: boolean
description: Defines if the generated object includes just the result of the analysis (true) or additional details such as the ID of the analysis and profile ID for which the analysis was made (false). This can't be changed per record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- properties
discriminator:
propertyName: subtype
mapping:
file: "#/components/schemas/brickworks-service-FileField"
image: "#/components/schemas/brickworks-service-ImageField"
catalog_item: "#/components/schemas/brickworks-service-CatalogItemField"
promotion: "#/components/schemas/brickworks-service-PromotionField"
voucher: "#/components/schemas/brickworks-service-VoucherField"
recommendation: "#/components/schemas/brickworks-service-RecommendationField"
metric: "#/components/schemas/brickworks-service-MetricField"
aggregate: "#/components/schemas/brickworks-service-AggregateField"
expression: "#/components/schemas/brickworks-service-ExpressionField"
config:
type: object
title: Synerise object array config
x-class-name: SyneriseArrayConfig
x-interface-name-ts: SyneriseArrayConfig
description: |
Settings applied when the Synerise objects of the array are resolved during content generation.
- `nullOnFail` - when `true` and resolving an object fails, that item becomes `null` instead of failing the whole field. Defaults to `false`.
- `removeNulls` - when `true`, the `null` items are removed from the resolved array. Defaults to `true`.
properties:
nullOnFail:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
removeNulls:
type: object
title: Boolean
x-class-name: BooleanForm
x-interface-name-ts: BooleanForm
properties:
type:
type: string
title: Boolean
x-class-name: BooleanType
x-interface-name-ts: BooleanType
enum:
- boolean
subtype:
type: string
x-class-name: BooleanSubtype
x-interface-name-ts: BooleanSubtype
enum:
- boolean
unique:
type: boolean
description: When true, the value in this field must be unique between all records created from this schema. This parameter can't be set on a field when more than 5 records exist for the schema.
searchable:
type: boolean
description: When true, the value in this field can be used to search and sort records.
default:
nullable: true
type: boolean
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
minItems:
type: integer
format: int32
description: The minimum number of items allowed in the array
maxItems:
type: integer
format: int32
description: The maximum number of items allowed in the array
uniqueItems:
type: boolean
description: When `true`, the values in the array must be unique
default:
type: array
description: The default value of the field, used when no value is declared. It's not saved in the records, but is used when generating or previewing content from a record.
items: {}
isConstantField:
type: boolean
default: false
description: |
When true:
- you must set a default value.
- that default value applies to all records and can't be overwritten in record create/update requests.
required:
- type
- subtype
- items
- config
discriminator:
propertyName: subtype
mapping:
boolean: "#/components/schemas/brickworks-service-BooleanForm"
string: "#/components/schemas/brickworks-service-StringForm"
integer: "#/components/schemas/brickworks-service-IntegerForm"
number: "#/components/schemas/brickworks-service-NumberForm"
enum: "#/components/schemas/brickworks-service-EnumForm"
date: "#/components/schemas/brickworks-service-DateForm"
date-time: "#/components/schemas/brickworks-service-DateTimeForm"
typed_array: "#/components/schemas/brickworks-service-ArrayForm"
uuid: "#/components/schemas/brickworks-service-UUIDForm"
jinjava: "#/components/schemas/brickworks-service-JinJavaForm"
one_to_one: "#/components/schemas/brickworks-service-ReferenceForm"
catalog_item: "#/components/schemas/brickworks-service-CatalogItemField"
key_value: "#/components/schemas/brickworks-service-KeyValueObject"
external_source: "#/components/schemas/brickworks-service-ExternalHttpSource"
one_to_many: "#/components/schemas/brickworks-service-OneToManyForm"
metric: "#/components/schemas/brickworks-service-MetricField"
expression: "#/components/schemas/brickworks-service-ExpressionField"
aggregate: "#/components/schemas/brickworks-service-AggregateField"
promotion: "#/components/schemas/brickworks-service-PromotionField"
file: "#/components/schemas/brickworks-service-FileField"
image: "#/components/schemas/brickworks-service-ImageField"
recommendation: "#/components/schemas/brickworks-service-RecommendationField"
ai_search: "#/components/schemas/brickworks-service-AiSearchField"
ai_search_listing: "#/components/schemas/brickworks-service-AiSearchListingField"
voucher: "#/components/schemas/brickworks-service-VoucherField"
untyped_object: "#/components/schemas/brickworks-service-UntypedJson"
untyped_array: "#/components/schemas/brickworks-service-UntypedArray"
json: "#/components/schemas/brickworks-service-UntypedForm"
client_attribute: "#/components/schemas/brickworks-service-ProfileAttributeField"
filter: "#/components/schemas/brickworks-service-OneToManyFilterForm"
synerise_array: "#/components/schemas/brickworks-service-SyneriseArrayForm"
brickworks-service-FieldCondition:
type: object
x-class-name: FieldCondition
x-interface-name-ts: FieldCondition
properties:
minItems:
type: number
format: int32
maxItems:
type: number
format: int32
uniqueItems:
type: boolean
minimum:
type: number
format: int32
maximum:
type: number
format: int32
pattern:
type: string
const:
title: FieldConditionConstant
x-class-name: FieldConditionConstant
x-interface-name-ts: FieldConditionConstant
nullable: true
enum:
type: array
items:
type: string
not:
$ref: "#/components/schemas/brickworks-service-FieldCondition"
brickworks-service-ObjectsError:
type: object
x-class-name: ObjectsError
x-interface-name-ts: ObjectsError
required:
- httpStatus
- errorCode
- timestamp
- message
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
httpStatus:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
traceId:
type: string
description: Unique identifier of the request, useful for tracing logs
errors:
type: array
items:
$ref: "#/components/schemas/brickworks-service-ObjectsError"
source:
type: object
x-class-name: ObjectErrorSource
x-interface-name-ts: ObjectErrorSource
required:
- pointer
properties:
pointer:
type: string
description: JSON Pointer for invalid body path
value:
type: string
description: Value that caused the validation error
details:
type: object
x-class-name: ObjectsErrorDetails
x-interface-name-ts: ObjectsErrorDetails
additionalProperties:
type: object
description: Additional structured error information
field:
type: string
description: Name of the field that caused the error
securitySchemes:
JWT:
type: http
scheme: bearer
description: |-
JWT Bearer token. The header looks like this: `Bearer {JWT}`
Remember to include the space between 'Bearer' and the token.
Generate a token via the **Authorization** endpoints.
````