Interface CockpitNodeParameters

Source
interface CockpitNodeParameters {
    collection?: string;
    dataFieldsJson?: string;
    dataFieldsUi?: {
        field: { name?: string; value?: string }[];
    };
    form?: string;
    id?: string;
    jsonDataFields?: boolean;
    limit?: number;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "submit";
    options?: {
        fields?: string;
        filter?: string;
        language?: string;
        populate?: boolean;
        rawData?: boolean;
        skip?: number;
        sort?: string;
    };
    resource?: "collection"
    | "form"
    | "singleton";
    returnAll?: boolean;
    singleton?: string;
}

Properties§

Source§

readonly collection?: string

Name of the collection to operate on. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getCollections"}

Source§

readonly dataFieldsJson?: string

Entry data to send as JSON Type options: {"alwaysOpenEditWindow":true}

Source§

readonly dataFieldsUi?: { field: { name?: string; value?: string }[] }

Entry data to send Default: {} Type options: {"multipleValues":true}

Source§

readonly form?: string

Name of the form to operate on

Source§

readonly id?: string

Source§

readonly jsonDataFields?: boolean

Whether new entry fields should be set via the value-key pair UI or JSON

Source§

readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}

Source§

readonly operation?: "create" | "get" | "getAll" | "update" | "submit"

Default: "getAll"

Source§

readonly options?: {
    fields?: string;
    filter?: string;
    language?: string;
    populate?: boolean;
    rawData?: boolean;
    skip?: number;
    sort?: string;
}

Default: {}

Source§

readonly resource?: "collection" | "form" | "singleton"

Default: "collection"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly singleton?: string

Name of the singleton to operate on. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getSingletons"}