Type alias BatchLoadInfoResponse

BatchLoadInfoResponse: {
    Data?: unknown;
    ExampleRecord?: string[];
    Header?: string[];
    PricePerRecord?: number;
    RecordCount?: number;
    Valid: boolean;
}

This is the response object for the Load method of the Batch data when requesting only the info.

Type declaration

  • Optional Data?: unknown

    This adds additional data availalbe for the batch data. This is controlled by the batch plugin. The CSV plugin doesn't set this property.

  • Optional ExampleRecord?: string[]

    The data of the first record in the batch data set. This is helpful to get a preview and understanding of the data in the set.

  • Optional Header?: string[]

    The headers of the batch data set. This can be used for mapping or preview purposes.

  • Optional PricePerRecord?: number

    The price per record of the batch data set. This can be controlled by the batch plugin. If null, the price per record is controlled outside of the batch plugin. The CSV plugin doesn't set this property.

  • Optional RecordCount?: number

    The record count of the batch data set.

  • Valid: boolean

    Boolean flag to indicate if the load was successful.

Example

{
    "Valid": true,
    "Header": [
        "Check / Issue",
        "Actions",
        "Comments"
    ],
    "RecordCount": 16,
    "ExampleRecord": [
        "Disk Space",
        "Alert...",
        ""
    ],
    "PricePerRecord": null,
    "Data": null
}

Settings

Member Visibility

Theme

Generated using TypeDoc