Class SchemaDetail
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class SchemaDetail
Properties
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
Declaration
[JsonProperty("audit", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public UserAuditDetail Audit { get; set; }
Property Value
Declaration
public ICollection<SchemaDetail> Dependencies { get; }
Property Value
The complete list of all descendant schema IDs.
Declaration
[JsonProperty("descendantSchemaIds", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> DescendantSchemaIds { get; set; }
Property Value
Language specific schema descriptions.
Declaration
[JsonProperty("descriptions", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public TranslatedStringDictionary Descriptions { get; set; }
Property Value
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
Declaration
[JsonProperty("fields", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<FieldBase> Fields { get; set; }
Property Value
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
The schema ID. It is unique throughout the whole customer setup.
Declaration
[JsonProperty("id", Required = Required.Always)]
[Required]
public string Id { get; set; }
Property Value
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
Language specific schema names.
Declaration
[JsonProperty("names", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public TranslatedStringDictionary Names { get; set; }
Property Value
The owner token ID. Defines the schema owner.
Declaration
[JsonProperty("ownerTokenId", Required = Required.Always)]
[Required]
public string OwnerTokenId { get; set; }
Property Value
Declaration
[JsonProperty("parentSchemaId", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string ParentSchemaId { get; set; }
Property Value
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
System generated schema namespace. It contains the full schema hierarchy up to the root schema (i.e. [RootSchemaId].[ParentSchemaId].[SchemaId]).
Declaration
[JsonProperty("schemaNamespace", Required = Required.Always)]
[Required]
public string SchemaNamespace { get; set; }
Property Value
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
The number of fields generated by the schema in the search index for filtering, searching and sorting.
Declaration
[JsonProperty("searchFieldCount", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public SearchFieldCount SearchFieldCount { get; set; }
Property Value
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
Identifies a system provided schema. A system schema cannot be created, updated or deleted.
Declaration
[JsonProperty("system", Required = Required.Always)]
public bool System { get; set; }
Property Value
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.Always, ItemConverterType = typeof(StringEnumConverter))]
[Required]
public ICollection<SchemaType> Types { get; set; }
Property Value
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
Methods
Declaration
public static SchemaDetail FromJson(string data)
Parameters
Returns