Interface TypeImport

The data representation for a Type to be imported that is persisted as a Type in the Project.

interface TypeImport {
    description?: LocalizedString;
    fieldDefinitions?: FieldDefinition[];
    key: string;
    name: LocalizedString;
    resourceTypeIds: string[];
}

Hierarchy (view full)

Properties

description? fieldDefinitions? key name resourceTypeIds

Properties

Optional Readonly description

description?: LocalizedString

Maps to Type.description.

Optional Readonly fieldDefinitions

fieldDefinitions?: FieldDefinition[]

Maps to Type.fieldDefinitions.

Readonly key

key: string

User-defined unique identifier for the Type. If a Type with this key exists, it will be updated with the imported data.

Readonly name

name: LocalizedString

Maps to Type.name.

Readonly resourceTypeIds

resourceTypeIds: string[]

Maps to Type.resourceTypeIds. This value cannot be changed after the Type is imported.

Settings

Member Visibility

Theme

On This Page

descriptionfieldDefinitionskeynameresourceTypeIds