Class: MLRest

Methods

new MLRest($http)

Parameter

Name	Type	Optional	Description
$http	Object		angular $http service

Methods

createDocument(doc[, options]) → Promise

Creates a document, returning the new URI

http://docs.marklogic.com/REST/POST/v1/documents

Parameters

Name	Type	Optional	Description
doc	(Object or String)		document contents
options	Object	Yes	URL params

Returns: Promise a promise resolved with the new document URI

deleteDocument(uri, options) → Promise

Deletes a document at the specified URI

http://docs.marklogic.com/REST/DELETE/v1/documents

Parameters

Name	Type	Optional	Description
uri	String		document uri
options	Object		URL params

Returns: Promise a promise resolved with an angular $http service response object

extension(name, settings) → Promise

Makes a resource extension request

http://docs.marklogic.com/REST/GET/v1/resources/[name]

Parameters

Name	Type	Optional	Description
name	String		resource extension name
settings	Object		angular `$http` service settings

Returns: Promise a promise resolved with an angular $http service response object

getDocument(uri, options) → Promise

Retrieves a document at the specified URI

http://docs.marklogic.com/REST/GET/v1/documents

Parameters

Name	Type	Optional	Description
uri	String		document URI
options	Object		URL params

Returns: Promise a promise resolved with an angular $http service response object

patchDocument(uri, patch) → Promise

Applies the provided patch to the document at the specified URI

http://docs.marklogic.com/REST/PATCH/v1/documents

Parameters

Name	Type	Optional	Description
uri	String		document URI
patch	Object		a document patch definition

Returns: Promise a promise resolved with the new document URI

queryConfig(name[, section]) → Promise

Retrieves stored search options

Parameters

Name	Type	Optional	Description
name	String		stored search options name
section	String	Yes	options section to retrieve

Returns: Promise a promise resolved with an angular $http service response object

request(endpoint, settings) → Promise

Makes a REST API request (all other methods wrap this)

Parameters

Name	Type	Optional	Description
endpoint	String		the request endpoint: can be version agnostic (`/search`) or specific (`/v1/search`)
settings	Object		angular `$http` service settings

Returns: Promise a promise resolved with an angular $http service response object

search([options][, combined]) → Promise

Makes a search request (POST if combined query, GET otherwise)

Parameters

Name	Type	Optional	Description
options	Object	Yes	URL params
combined	Object	Yes	a combined search object (identified by a `search` property)

Returns: Promise a promise resolved with an angular $http service response object

sparql(query[, params]) → Promise

Evaluates a SPARQL query

http://docs.marklogic.com/REST/GET/v1/graphs/sparql

Parameters

Name	Type	Optional	Description
query	String		a SPARQL query
params	Object	Yes	URL params

Returns: Promise a promise resolved with an angular $http service response object

suggest([params][, combined]) → Promise

Retrieves search phrase suggestions

Parameters

Name	Type	Optional	Description
params	Object	Yes	URL params
combined	Object	Yes	combined query

Returns: Promise a promise resolved with an angular $http service response object

updateDocument(doc, options) → Promise

Creates or updates a document at the specified URI (options.uri)

http://docs.marklogic.com/REST/PUT/v1/documents

Parameters

Name	Type	Optional	Description
doc	(Object or String)		document contents
options	Object		URL params

Returns: Promise a promise resolved with the new document URI

values(name[, params][, combined]) → Promise

Retrieves lexicon values

Parameters

Name	Type	Optional	Description
name	String		values definition name (from stored or combined search options)
params	Object	Yes	URL params
combined	Object	Yes	combined query

Returns: Promise a promise resolved with an angular $http service response object