Class MeasurementsApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

deleteMeasurementsWithLocationId deleteMeasurementsWithLocationIdRaw getMeasurements getMeasurementsRaw isJsonMime postMeasurements postMeasurementsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = DefaultConfig

Methods

deleteMeasurementsWithLocationId

  • deleteMeasurementsWithLocationId(requestParameters, initOverrides?): Promise<void>

  • Delete an existing measurement. Delete cwmsData measurements with locationId

    Parameters

    Returns Promise<void>

deleteMeasurementsWithLocationIdRaw

getMeasurements

  • getMeasurements(requestParameters?, initOverrides?): Promise<Measurement[]>

  • Returns matching measurement data. Get cwmsData measurements

    Parameters

    Returns Promise<Measurement[]>

getMeasurementsRaw

Protected isJsonMime

  • isJsonMime(mime): boolean

  • Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json

    Parameters

    • mime: string

      MIME (Multipurpose Internet Mail Extensions)

    Returns boolean

    True if the given MIME is JSON, false otherwise.

postMeasurements

  • postMeasurements(requestParameters, initOverrides?): Promise<void>

  • Create new measurement(s). Post cwmsData measurements

    Parameters

    Returns Promise<void>

postMeasurementsRaw

  • postMeasurementsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

  • Create new measurement(s). Post cwmsData measurements

    Parameters

    Returns Promise<ApiResponse<void>>

Protected request

  • request(context, initOverrides?): Promise<Response>

  • Parameters

    Returns Promise<Response>

withMiddleware

withPostMiddleware

  • withPostMiddleware<T>(this, ...postMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]

    Returns T

withPreMiddleware

  • withPreMiddleware<T>(this, ...preMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]

    Returns T

Settings

Member Visibility

Theme

On This Page

constructorconfigurationdeleteMeasurementsWithLocationIddeleteMeasurementsWithLocationIdRawgetMeasurementsgetMeasurementsRawisJsonMimepostMeasurementspostMeasurementsRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware