Interface IOnmsHTTP

Interface for making ReST calls to an HTTP server.

interface

Hierarchy

IOnmsHTTP

Implemented by

Index

Properties

Methods

Properties

Optional options

options: OnmsHTTPOptions | null

The default options used when making requests with this instance.

Optional server

server: OnmsServer | null

The server associated with this instance.

Methods

get

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

- Defined in api/IOnmsHTTP.ts:36
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.

head

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

- Defined in api/IOnmsHTTP.ts:44
Perform an HTTP HEAD 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.

httpDelete

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

- Defined in api/IOnmsHTTP.ts:68
Perform an HTTP DELETE 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.

post

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

- Defined in api/IOnmsHTTP.ts:60
Perform an HTTP POST 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:52
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