_load

splunkjs.Service.Resource._load

Loads the resource and stores the properties.

Syntax

_load: function(properties)

Parameters

Name Type Description
properties Object

The properties for this resource.

fetch

splunkjs.Service.Resource.fetch

Refreshes the resource by fetching the object from the server and loading it.

Syntax

fetch: function(callback)

Parameters

Name Type Description
callback Function

A function to call when the object is retrieved: (err, resource).

init

splunkjs.Service.Resource.init

Constructor for splunkjs.Service.Resource.

Syntax

init: function(service, path, namespace)

Parameters

Name Type Description
service splunkjs.Service

A Service instance.

path String

A relative endpoint path (for example, 'search/jobs').

namespace Object

Namespace information (owner, app, sharing).

Return

splunkjs.Service.Resource.

A new splunkjs.Service.Resource instance.

path

splunkjs.Service.Resource.path

Retrieves the REST endpoint path for this resource (with no namespace).

Syntax

path: function()

properties

splunkjs.Service.Resource.properties

Retrieves the current properties for this resource.

Syntax

properties: function()

Return

Object.

The properties for this resource.

state

splunkjs.Service.Resource.state

Retrieves the current full state of this resource.

Syntax

state: function()

Return

Object.

The current full state of this resource.

del

splunkjs.Service.Endpoint.del

Performs a relative DELETE request on an endpoint's path, combined with the parameters and a relative path if specified.

Syntax

del: function(relpath, params, callback)

Parameters

Name Type Description
relpath String

A relative path to append to the path.

params Object

A dictionary of parameters to add to the query string.

callback Function

A function to call when the request is complete: (err, response).

Examples

 // Will make a request to {service.prefix}/search/jobs/123456
 var endpoint = new splunkjs.Service.Endpoint(service, "search/jobs/12345");
 endpoint.delete("", {}, function() { console.log("DELETED"))});

get

splunkjs.Service.Endpoint.get

Performs a relative GET request on an endpoint's path, combined with the parameters and a relative path if specified.

Syntax

get: function(relpath, params, callback)

Parameters

Name Type Description
relpath String

A relative path to append to the path.

params Object

A dictionary of parameters to add to the query string.

callback Function

A function to call when the request is complete: (err, response).

Examples

 // Will make a request to {service.prefix}/search/jobs/123456/results?offset=1
 var endpoint = new splunkjs.Service.Endpoint(service, "search/jobs/12345");
 endpoint.get("results", {offset: 1}, function() { console.log("DONE"))});

post

splunkjs.Service.Endpoint.post

Performs a relative POST request on an endpoint's path, combined with the parameters and a relative path if specified.

Syntax

post: function(relpath, params, callback)

Parameters

Name Type Description
relpath String

A relative path to append to the path.

params Object

A dictionary of parameters to add to the body.

callback Function

A function to call when the request is complete: (err, response).

Examples

 // Will make a request to {service.prefix}/search/jobs/123456/control
 var endpoint = new splunkjs.Service.Endpoint(service, "search/jobs/12345");
 endpoint.post("control", {action: "cancel"}, function() { console.log("CANCELLED"))});