Interface ResponseMetadata

interface ResponseMetadata {
    description: string;
    fields: MetadataField[];
    id: string;
    importMessage?: string;
    importTemplates?: {
        label: string;
        url: string;
    }[];
    root: string;
    title: string;
    totalProperty: string;
}

Properties

description fields id importMessage? importTemplates? root title totalProperty

Properties

description

description: string

Description of the underlying query

fields

fields: MetadataField[]

id

id: string

Name of the primary key column.

Optional importMessage

importMessage?: string

Optional importTemplates

importTemplates?: {
    label: string;
    url: string;
}[]

An array of templates (label/URL) that should be used as the options for excel upload. Each URL should either point to a static template file or an action to generate the template. If no custom templates have been provided, it will return the default URL.

Type declaration

  • label: string
  • url: string

root

root: string

Name of the property containing rows ("rows").

title

title: string

Title of the underlying query

totalProperty

totalProperty: string

Name of the top-level property containing the row count ("rowCount") in our case.

Settings

Member Visibility

Theme

On This Page

descriptionfieldsidimportMessageimportTemplatesroottitletotalProperty

Generated using TypeDoc