Class SchemaCreateRequest

Request to create a schema

Inheritance
object
SchemaCreateRequest
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class SchemaCreateRequest

Properties

Aggregations

An optional list of aggregations to show grouped list item documents. When aggregations are defined for a List,
the UI uses such information to show the available filters and grouped results.

Declaration
[JsonProperty("aggregations", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<AggregatorBase> Aggregations { get; set; }
Property Value
ICollection<AggregatorBase>

Descriptions

Language specific schema descriptions.

Declaration
[JsonProperty("descriptions", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public TranslatedStringDictionary Descriptions { get; set; }
Property Value
TranslatedStringDictionary

DisplayPatterns

Language specific DotLiquid templates. These templates will be resolved into display values in content documents and/or list items.

Declaration
[JsonProperty("displayPatterns", Required = Required.Always)]
[Required]
public ICollection<DisplayPattern> DisplayPatterns { get; set; }
Property Value
ICollection<DisplayPattern>

Fields

The schema fields.

Declaration
[JsonProperty("fields", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<FieldBase> Fields { get; set; }
Property Value
ICollection<FieldBase>

FieldsOverwrite

A list of schema fields overwrite information. It is used to overwrite the field configuration coming from the parent schema.
Only a subset of properties of a FieldSingleTagbox and FieldMultiTagbox can be be overwritten. All other properties and fields cannot.

Declaration
[JsonProperty("fieldsOverwrite", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<FieldOverwriteBase> FieldsOverwrite { get; set; }
Property Value
ICollection<FieldOverwriteBase>

Id

The schema ID. It can be a slug, but must be unique throughout the whole customer setup.

Declaration
[JsonProperty("id", Required = Required.Always)]
[Required]
public string Id { get; set; }
Property Value
string

LayerSchemaIds

An optional list of schemas' IDs with type layer. For a Content schema it stores the layers that can be assigned to a content.

Declaration
[JsonProperty("layerSchemaIds", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> LayerSchemaIds { get; set; }
Property Value
ICollection<string>

MetadataProtection

Metadata protection options.

Declaration
[JsonProperty("metadataProtection", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public MetadataProtection MetadataProtection { get; set; }
Property Value
MetadataProtection

Names

Language specific schema names.

Declaration
[JsonProperty("names", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public TranslatedStringDictionary Names { get; set; }
Property Value
TranslatedStringDictionary

ParentSchemaId

The parent schema ID.

Declaration
[JsonProperty("parentSchemaId", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string ParentSchemaId { get; set; }
Property Value
string

ReferencedInContentSchemaIds

If the schema if of type Layer, the list contains the schemas with type Content
that reference the layer.

Declaration
[JsonProperty("referencedInContentSchemaIds", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> ReferencedInContentSchemaIds { get; set; }
Property Value
ICollection<string>

SchemaPermissionSetIds

An optional list of schema permission set IDs which control schema permissions.

Declaration
[JsonProperty("schemaPermissionSetIds", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> SchemaPermissionSetIds { get; set; }
Property Value
ICollection<string>

Sort

Sorts content documents and/or list items. In order for the sorting to work properly, the Sortable property of the related field
must be set to true. Multiple sorting is supported: they are applied in the specified order.

Declaration
[JsonProperty("sort", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<SortInfo> Sort { get; set; }
Property Value
ICollection<SortInfo>

Types

List of schema types. Currently only one schema type can be assigned to this list, and it cannot be modified once the schema is created.

Declaration
[JsonProperty("types", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore, ItemConverterType = typeof(StringEnumConverter))]
public ICollection<SchemaType> Types { get; set; }
Property Value
ICollection<SchemaType>

ViewForAll

Defines a schema as viewable by everyone. Everyone with ManageSchema user permission is able to see the schema.

Declaration
[JsonProperty("viewForAll", Required = Required.Always)]
public bool ViewForAll { get; set; }
Property Value
bool

Methods

FromJson(string)

Declaration
public static SchemaCreateRequest FromJson(string data)
Parameters
string data

Returns
SchemaCreateRequest

ToJson()

Declaration
public string ToJson()
Returns
string