Interface ConnectorDataCollection

interface ConnectorDataCollection {
    key: string;
    name: string;
    parametersSchema?: DataSchema;
    extends?: DataLocationMixin[];
    relatedOperationKeys?: string[];
    type: "collection";
    fieldsSchema?: DataSchema;
    isHidden?: boolean;
    customFields?: boolean;
    customFieldsSchema?: ConnectorDataLocationMethod;
    spec?: ConnectorDataLocationMethod;
    recordFromFields?: ConnectorDataLocationMethod;
    fieldsFromApi?: ConnectorDataLocationMethod;
    recordFromApi?: ConnectorDataLocationMethod;
    recordFromApiCode?: ConnectorDataLocationMethod;
    recordFromApiMapping?: ConnectorDataLocationMethod;
    recordToApi?: ConnectorDataLocationMethod;
    fieldsToApi?: ConnectorDataLocationMethod;
    fieldsToApiCode?: ConnectorDataLocationMethod;
    fieldsToApiMapping?: ConnectorDataLocationMethod;
    methods?: {
        list?: ConnectorDataLocationMethod<DataCollectionListConfigType>;
        findById?: ConnectorDataLocationMethod;
        match?: ConnectorDataLocationMethod<DataCollectionMatchConfigType>;
        search?: ConnectorDataLocationMethod;
        create?: ConnectorDataLocationMethod<DataCollectionCreateConfigType>;
        update?: ConnectorDataLocationMethod<DataCollectionUpdateConfigType>;
        delete?: ConnectorDataLocationMethod;
        find?: ConnectorDataLocationMethod<{
            queryFields?: string[];
        }>;
    };
    events?: Partial<Record<"created" | "updated" | "deleted", ConnectorDataCollectionEvent>>;
    udm?: Partial<Record<string, {
        extract?: ConnectorDataLocationMethod;
        parse?: ConnectorDataLocationMethod;
    }>>;
}

Hierarchy (view full)

Properties

key name parametersSchema? extends? relatedOperationKeys? type fieldsSchema? isHidden? customFields? customFieldsSchema? spec? recordFromFields? fieldsFromApi? recordFromApi? recordFromApiCode? recordFromApiMapping? recordToApi? fieldsToApi? fieldsToApiCode? fieldsToApiMapping? methods? events? udm?

Properties

key

key: string

name

name: string

OptionalparametersSchema

parametersSchema?: DataSchema

Optionalextends

extends?: DataLocationMixin[]

OptionalrelatedOperationKeys

relatedOperationKeys?: string[]

type

type

OptionalfieldsSchema

fieldsSchema?: DataSchema

OptionalisHidden

isHidden?: boolean

OptionalcustomFields

customFields?: boolean

OptionalcustomFieldsSchema

customFieldsSchema?: ConnectorDataLocationMethod

Optionalspec

spec?: ConnectorDataLocationMethod

OptionalrecordFromFields

recordFromFields?: ConnectorDataLocationMethod

OptionalfieldsFromApi

fieldsFromApi?: ConnectorDataLocationMethod

OptionalrecordFromApi

recordFromApi?: ConnectorDataLocationMethod

OptionalrecordFromApiCode

recordFromApiCode?: ConnectorDataLocationMethod

OptionalrecordFromApiMapping

recordFromApiMapping?: ConnectorDataLocationMethod

OptionalrecordToApi

recordToApi?: ConnectorDataLocationMethod

OptionalfieldsToApi

fieldsToApi?: ConnectorDataLocationMethod

OptionalfieldsToApiCode

fieldsToApiCode?: ConnectorDataLocationMethod

OptionalfieldsToApiMapping

fieldsToApiMapping?: ConnectorDataLocationMethod

Optionalmethods

methods?: {
    list?: ConnectorDataLocationMethod<DataCollectionListConfigType>;
    findById?: ConnectorDataLocationMethod;
    match?: ConnectorDataLocationMethod<DataCollectionMatchConfigType>;
    search?: ConnectorDataLocationMethod;
    create?: ConnectorDataLocationMethod<DataCollectionCreateConfigType>;
    update?: ConnectorDataLocationMethod<DataCollectionUpdateConfigType>;
    delete?: ConnectorDataLocationMethod;
    find?: ConnectorDataLocationMethod<{
        queryFields?: string[];
    }>;
}

Type declaration

Optionalevents

events?: Partial<Record<"created" | "updated" | "deleted", ConnectorDataCollectionEvent>>

Optionaludm

udm?: Partial<Record<string, {
    extract?: ConnectorDataLocationMethod;
    parse?: ConnectorDataLocationMethod;
}>>

Settings

Member Visibility

On This Page

Properties