@itwin/insights-client/lib/esm/reporting/interfaces/OData.d.ts

Insights client for the iTwin platform

export interface ODataItem {
    /**
     *
     * @type {string}
     * @memberof ODataItem
     */
    name: string;
    /**
     *
     * @type {string}
     * @memberof ODataItem
     */
    url: string;
}
/**
 * OData response.
 * @export
 * @interface ODataResponse
 */
export interface ODataResponse {
    /**
     * OData Schema
     * @type {string}
     * @memberof ODataResponse
     */
    "@odata.context": string;
    /**
     *
     * @type {Array<ODataItem>}
     * @memberof ODataResponseStatus
     */
    value: Array<ODataItem>;
}
/**
 * OData Entity response.
 * @export
 * @interface ODataEntityResponse
 */
export interface ODataEntityResponse {
    /**
     * OData Schema
     * @type {string}
     * @memberof ODataResponse
     */
    "@odata.context": string;
    /**
     *
     * @type {Array<[key: string]: string>}
     * @memberof ODataResponseStatus
     */
    value: Array<ODataEntityValue>;
    /**
     *
     * @type {string}
     * @memberof ODataResponse
     */
    "@odata.nextLink"?: string;
}
export interface ODataEntityValue {
    [key: string]: string | number | boolean | null;
}
/**
 * OData annotation.
 * @export
 * @interface ODataAnnotation
 */
export interface ODataAnnotation {
    /**
     * Name of a term.
     * @type {string}
     * @memberof ODataAnnotation
     */
    term: string;
    /**
     * String value of the annotation.
     * @type {string}
     * @memberof ODataAnnotation
     */
    stringValue?: string;
}
/**
 * OData MetaData table.
 * @export
 * @interface ODataTable
 */
export interface ODataTable {
    /**
     * Table name.
     * @type {string}
     * @memberof ODataTable
     */
    name: string;
    /**
     * Table columns.
     * @type {ODataColumn[]}
     * @memberof ODataTable
     */
    columns: ODataColumn[];
    /**
     * Table annotations.
     * @type {ODataAnnotation[]}
     * @memberof ODataTable
     */
    annotations: ODataAnnotation[];
}
/**
 * OData MetaData property.
 * @export
 * @interface ODataColumn
 */
export interface ODataColumn {
    /**
     * Property name
     * @type {string}
     * @memberof ODataColumn
     */
    name: string;
    /**
     * Property type
     * @type {string}
     * @memberof ODataColumn
     */
    type: string;
}
/**
 * OData MetaData property.
 * @export
 * @interface ODataMetaDataProperty
 */
export interface ODataMetaDataProperty {
    /**
     * Property name
     * @type {string}
     * @memberof ODataMetaDataProperty
     */
    Name: string;
    /**
     * Property type
     * @type {string}
     * @memberof ODataMetaDataProperty
     */
    Type: string;
}
/**
 * OData MetaData property.
 * @export
 * @interface ODataMetaDataSchema
 */
export interface ODataMetaDataSchema {
    /**
    * Property name
    * @type {string}
    * @memberof ODataMetaDataSchema
    */
    entityType: ODataMetaDataEntityType;
    /**
     * Property name
     * @type {string}
     * @memberof ODataMetaDataSchema
     */
    Namespace: string;
    /**
     * Property type
     * @type {string}
     * @memberof ODataMetaDataSchema
     */
    xmlns: string;
}
/**
 * OData MetaData property.
 * @export
 * @interface ODataMetaDataEntityType
 */
export interface ODataMetaDataEntityType {
    /**
    * Property name
    * @type {ODataMetaDataProperty}
    * @memberof ODataMetaDataEntityType
    */
    property: ODataMetaDataProperty[];
    /**
     * Property name
     * @type {string}
     * @memberof ODataMetaDataEntityType
     */
    Name: string;
}
/**
 * OData MetaData property.
 * @export
 * @interface ODataMetaDataEntitySet
 */
export interface ODataMetaDataEntitySet {
    /**
    * Property name
    * @type {ODataMetaDataProperty}
    * @memberof ODataMetaDataEntitySet
    */
    Name: string;
    /**
     * Property name
     * @type {string}
     * @memberof ODataMetaDataEntitySet
     */
    EntityType: string;
}
//# sourceMappingURL=OData.d.ts.map