Interface IOnmsHTTP

Hierarchy

IOnmsHTTP

Implemented by

Index

Properties

Methods

get
put

Properties

options

options: OnmsHTTPOptions

the options used when making requests

server

server: OnmsServer

the server associated with this instance

Methods

get

get(url: string, options?: OnmsHTTPOptions): Promise<OnmsResult<any>>

- Defined in api/IOnmsHTTP.ts:40
Perform an HTTP GET to the provided URL.

Parameters
- url: string
  
  the URL to connect to
- Optional options: OnmsHTTPOptions
  
  the OnmsHTTPOptions options to use when connecting
Returns Promise<OnmsResult<any>>

an OnmsResult result object

put

put(url: string, options?: OnmsHTTPOptions): Promise<OnmsResult<any>>

- Defined in api/IOnmsHTTP.ts:48
Perform an HTTP PUT to the provided URL.

Parameters
- url: string
  
  the URL to connect to
- Optional options: OnmsHTTPOptions
  
  the OnmsHTTPOptions options to use when connecting
Returns Promise<OnmsResult<any>>

an OnmsResult result object

Generated using TypeDoc