API Overview

The following is a break-out of all non-data access functions. As this is a RESTful service, we don’t deal in terms of functions, but instead of resources and the actions that can be performed on them. Functions may be available across resources (for example, the statistics function can be accessed either at the higher level Customer, but can also be accessed at the App level).

Here are the following resources:

Customer: the customer resource maintains the state of data regarding your customer account, including statistics and detail information such as your organization’s name and any users or user groups belonging to your organization.

GET customer -- is the customer details function

Sub resources:
Key: GET -- get keys function
POST -- recycle keys function
Statistics: GET -- get statistics function
Users: GET -- get statistics function
POST -- create new users
PUT -- update existing user
DELETE -- delete existing user
Groups: GET -- list and details of user groups
POST -- create a new user group
PUT -- update existing user group
DELETE -- delete existing user group
App Search Engine: the search engine resource maintains the data regarding an individual search engine within your account. All data coming into Dragonglass is segregated based on the app search engine it belongs to. It also maintains a list of users and user groups that are allowed access to this search engine’s data.

GET -- is the app search engine detail function
POST -- is the create app search engine function
PUT -- the update app search engine details function
DELETE -- the delete app search engine function

Sub resources:
Users: GET -- list and details of users allowed to access this app
PUT --associate a user with this app, granting them access
DELETE -- disassociate a user with this app, revoking their access
Groups: GET -- list and details of user groups assigned to this app
PUT -- associate a group with this app, granting the entire group access
DELETE -- disassociate a group with this app, revoking their access
Job: the job resource represents a datasource attached to a search engine. You can use this resource to inspect job run histories, start new jobs, or delete data from previous job runs.

GET -- details of a particular job run
PUT -- start a job
PUT -- update a running job (cancel)
DELETE -- delete contents from a job’s previous runs
Index: The index resource maintains information about the storage of data within your search engine. You can control the real-time nature of the index (the more real time it is, the slower it will add data).

GET -- is the index details function
POST -- is the create index function
PUT -- is the update index details function
DELETE -- the delete index function
Data Types: A data type represents meta information about documents stored within a search engine. Data types can be attached to search engines, ensuring that once you have a type definition you like, you can maintain it across all your search engines. When attaching to a search engine, you can optionally add more meta information to the data type -- this extra information is only applicable within this search engine.

GET -- is the data type details function
POST -- is the create data type function
PUT -- is the update data type details function
PATCH -- is the partial update data type function
DELETE -- the delete data type function, removing all stored data for that type
Document: The document resource represents the individual items sent to be added to the search engine. You can use this resource to fetch, update, or create new items within the search engine. You can also remove individual items from the search engine. At it’s heart, the document resource represents a key value store. Given a particular index, data type, and id, a unique value is stored or manipulated.

GET - get document details
POST - create a new document
PUT - update an existing document
PATCH -- partially update an existing document
DELETE - delete an existing document
Search: The search resource is used to perform query operations on items stored in the search engine via the document resource.

GET - perform the parameterized query
POST - perform the parameterized query
DELETE - delete all documents that match the parameterized query