Search Results for

    Show / Hide Table of Contents

    Class Schema

    A schema

    Inheritance
    object
    Schema
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public class Schema

    Properties

    ChildCount

    The count of all schema descendants with an immediate inheritance.

    Declaration
    [JsonProperty("childCount", Required = Required.Always)]
    public int ChildCount { get; set; }
    Property Value
    int

    Descriptions

    Language specific schema descriptions.

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

    FieldCount

    The count of all fields.

    Declaration
    [JsonProperty("fieldCount", Required = Required.Always)]
    public int FieldCount { get; set; }
    Property Value
    int

    Id

    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
    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>

    Level

    The descendant depth of the schema.

    Declaration
    [JsonProperty("level", Required = Required.Always)]
    public int Level { get; set; }
    Property Value
    int

    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

    System

    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
    bool

    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>

    Methods

    FromJson(string)

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

    Returns
    Schema

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX