Class: Apex

Apex

new Apex(conn)

API class for Apex REST endpoint call
Parameters:
Name Type Description
conn Connection Connection
Source:

Methods

del(path, bodyopt, callbackopt) → {Promise.<Object>}

Synonym of Apex#delete()
Parameters:
Name Type Attributes Description
path String URL path to Apex REST service
body Object <optional>
Request body
callback Callback.<Object> <optional>
Callback function
Source:
Returns:
Type
Promise.<Object>

delete(path, bodyopt, optionsopt, callbackopt) → {Promise.<Object>}

Call Apex REST service in DELETE request
Parameters:
Name Type Attributes Description
path String URL path to Apex REST service
body Object <optional>
Request body
options Object <optional>
Holds headers and other meta data for the request.
callback Callback.<Object> <optional>
Callback function
Source:
Returns:
Type
Promise.<Object>

get(path, options, callbackopt) → {Promise.<Object>}

Call Apex REST service in GET request
Parameters:
Name Type Attributes Description
path String URL path to Apex REST service
options Object Holds headers and other meta data for the request.
callback Callback.<Object> <optional>
Callback function
Source:
Returns:
Type
Promise.<Object>

patch(path, bodyopt, optionsopt, callbackopt) → {Promise.<Object>}

Call Apex REST service in PATCH request
Parameters:
Name Type Attributes Description
path String URL path to Apex REST service
body Object <optional>
Request body
options Object <optional>
Holds headers and other meta data for the request.
callback Callback.<Object> <optional>
Callback function
Source:
Returns:
Type
Promise.<Object>

post(path, bodyopt, options, callbackopt) → {Promise.<Object>}

Call Apex REST service in POST request
Parameters:
Name Type Attributes Description
path String URL path to Apex REST service
body Object <optional>
Request body
options Object Holds headers and other meta data for the request.
callback Callback.<Object> <optional>
Callback function
Source:
Returns:
Type
Promise.<Object>

put(path, bodyopt, optionsopt, callbackopt) → {Promise.<Object>}

Call Apex REST service in PUT request
Parameters:
Name Type Attributes Description
path String URL path to Apex REST service
body Object <optional>
Request body
options Object <optional>
Holds headers and other meta data for the request.
callback Callback.<Object> <optional>
Callback function
Source:
Returns:
Type
Promise.<Object>