CreateEntity

public struct CreateEntity : Codable, Equatable

CreateEntity.

  • The name of the entity. This string must conform to the following restrictions:

    • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
    • If you specify an entity name beginning with the reserved prefix sys-, it must be the name of a system entity that you want to enable. (Any entity content specified with the request is ignored.).

    Declaration

    Swift

    public var entity: String

  • The description of the entity. This string cannot contain carriage return, newline, or tab characters.

    Declaration

    Swift

    public var description: String?

  • Any metadata related to the entity.

    Declaration

    Swift

    public var metadata: [String : JSON]?

  • Whether to use fuzzy matching for the entity.

    Declaration

    Swift

    public var fuzzyMatch: Bool?

  • The timestamp for creation of the object.

    Declaration

    Swift

    public var created: Date?

  • The timestamp for the most recent update to the object.

    Declaration

    Swift

    public var updated: Date?

  • An array of objects describing the entity values.

    Declaration

    Swift

    public var values: [CreateValue]?

  • Initialize a CreateEntity with member variables.

    Declaration

    Swift

    public init(
    entity: String,
    description: String? = nil,
    metadata: [String: JSON]? = nil,
    fuzzyMatch: Bool? = nil,
    values: [CreateValue]? = nil
)

    Parameters

    entity

    The name of the entity. This string must conform to the following restrictions:

    • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
    • If you specify an entity name beginning with the reserved prefix sys-, it must be the name of a system entity that you want to enable. (Any entity content specified with the request is ignored.).
    description

    The description of the entity. This string cannot contain carriage return, newline, or tab characters.
    metadata

    Any metadata related to the entity.
    fuzzyMatch

    Whether to use fuzzy matching for the entity.
    values

    An array of objects describing the entity values.

    Return Value

    An initialized CreateEntity.