This is a JavaScript wrapper around a REST API client.

constructor

Constructor of the REST API client.

Parámetros

Nombre Tipo Opcional Descripción
_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()

This return a default configuration object

Retorna

Tip

Tipo: object

delete(url, timeout, headers, parameters, body, serviceBaseURL)

Invoke DELETE action to url specified

Parámetros

Nombre Tipo Opcional Descripción
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

Retorna

Tip

Tipo: Promise

get(url, timeout, headers, parameters, asBlob, serviceBaseURL)

Invoke GET action to url specified

Parámetros

Nombre Tipo Opcional Descripción
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

Retorna

Tip

Tipo: Promise

patch(url, data, timeout, headers, parameters, serviceBaseURL)

Invoke PATCH action to url and data specified

Parámetros

Nombre Tipo Opcional Descripción
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

Retorna

Tip

Tipo: Promise

post(url, data, timeout, headers, parameters, serviceBaseURL)

Invoke POST action to url and data specified

Parámetros

Nombre Tipo Opcional Descripción
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

Retorna

Tip

Tipo: Promise

post_multipart(url, formData, events, timeout, headers, parameters, serviceBaseURL)

Invoke POST multipart action to url and data specified

Parámetros

Nombre Tipo Opcional Descripción
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

Retorna

Tip

Tipo: Promise

put(url, data, timeout, headers, parameters, serviceBaseURL)

Invoke PUT action to url and data specified

Parámetros

Nombre Tipo Opcional Descripción
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

Retorna

Tip

Tipo: Promise

put_multipart(url, formData, events, timeout, headers, parameters, serviceBaseURL)

Invoke put multipart action to url and data specified

Parámetros

Nombre Tipo Opcional Descripción
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

Retorna

Tip

Tipo: Promise