Namespace: resources
resources
Provides functions to maintain resource
service extensions on the REST server for the client. The client
must have been created for a user with the rest-admin role.
Methods
-
-
list() → {ResultProvider}
-
Lists the resource services installed on the server.
- Since:
-
- 1.0
Returns:
an object whose result() function takes a success callback that receives the list of resource services installed on the server- Type
- ResultProvider
-
-
read(name) → {ResultProvider}
-
Reads the source for a resource service installed on the server.
Parameters:
Name Type Description name
string the name of an installed resource service - Since:
-
- 1.0
Returns:
an object whose result() function takes a success callback that receives the source code- Type
- ResultProvider
-
-
remove(name)
-
Deletes a resource service from the server.
Parameters:
Name Type Description name
string the name of the resource service - Since:
-
- 1.0
-
-
write(name, format, source)
-
Installs a resource service on the server.
Parameters:
Name Type Description name
string the name of the resource service format
string a value from the javascript|xquery enumeration source
object | string the source for the resource service - Since:
-
- 1.0