North Amplia REST

NorthAmpliaREST

NorthAmpliaREST Objects

class NorthAmpliaREST()

This is a wrapper of a Rest api javascript

constructor

function constructor()

This is a constructor of a Rest api javascript

Arguments:

• _options { url: string,port: string,version: string,apiKey: string,JTW: string} - this is configuration about Opengate North API.
• backend function - this is a backend selected to manage a request to Opengate North API.

default

function default() -> 'object'

This return a default configuration object

Returns:

• object

delete

function delete(url: string,timeout: number,headers: object,parameters: object,body: object,serviceBaseURL: string) -> 'Promise'

Invoke DELETE action to url specified

Arguments:

• url string - url to execute DELETE
• timeout number - timeout in milliseconds
• headers object - headers of request
• parameters object - parameters of request
• body object - body of request
• serviceBaseURL string - base of the uri petition

Returns:

• Promise

get

function get(url: string,timeout: number,headers: object,parameters: object,asBlob: boolean,serviceBaseURL: string) -> 'Promise'

Invoke GET action to url specified

Arguments:

• url string - url to execute GET
• timeout number - timeout in milliseconds
• headers object - headers of request
• parameters object - parameters of request
• asBlob boolean - response body as Blob
• serviceBaseURL string - base of the uri petition

Returns:

• Promise

patch

function patch(url: string,data: object,timeout: number,headers: object,parameters: object,serviceBaseURL: string) -> 'Promise'

Invoke PATCH action to url and data specified

Arguments:

• url string - url to execute PATCH
• data object - attach data to request PATCH
• timeout number - timeout in milliseconds
• headers object - headers of request
• parameters object - parameters of request
• serviceBaseURL string - base of the uri petition

Returns:

• Promise

post

function post(url: string,data: object,timeout: number,headers: object,parameters: object,serviceBaseURL: string) -> 'Promise'

Invoke POST action to url and data specified

Arguments:

• url string - url to execute POST
• data object - attach data to request POST
• timeout number - timeout in milliseconds
• headers object - headers of request
• parameters object - parameters of request
• serviceBaseURL string - base of the uri petition

Returns:

• Promise

post_multipart

function post_multipart(url: string,formData: FormData,events: object,timeout: number,headers: object,parameters: object,serviceBaseURL: string) -> 'Promise'

Invoke POST multipart action to url and data specified

Arguments:

• url string - url to execute POST
• formData FormData - attach data to request POST
• events object - events allowed, xhr.process
• timeout number - timeout in milliseconds
• headers object - headers of request
• parameters object - parameters of request
• serviceBaseURL string - base of the uri petition

Returns:

• Promise

put

function put(url: string,data: object,timeout: number,headers: object,parameters: object,serviceBaseURL: string) -> 'Promise'

Invoke PUT action to url and data specified

Arguments:

• url string - url to execute PUT
• data object - attach data to request PUT
• timeout number - timeout in milliseconds
• headers object - headers of request
• parameters object - parameters of request
• serviceBaseURL string - base of the uri petition

Returns:

• Promise

put_multipart

function put_multipart(url: string,formData: FormData,events: object,timeout: number,headers: object,parameters: object,serviceBaseURL: string) -> 'Promise'

Invoke put multipart action to url and data specified

Arguments:

• url string - url to execute POST
• formData FormData - attach data to request POST
• events object - events allowed, xhr.process
• timeout number - timeout in milliseconds
• headers object - headers of request
• parameters object - parameters of request
• serviceBaseURL string - base of the uri petition

Returns:

• Promise