Go to main content
1/12
Contents
List of Examples
List of Tables
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
Conventions
1
SODA for REST Overview
1.1
Overview of the Representational State Transfer (REST) Architectural Style
2
Installing SODA for REST
3
Using SODA for REST
3.1
Creating a New Collection
3.2
Getting the List of Available Collections
3.3
Deleting a Collection
3.4
Inserting a Document into a Collection
3.5
Retrieving a Document from a Collection
3.6
Deleting a Document from a Collection
3.7
Bulk-Inserting Documents from a JSON Array
3.8
Listing the Documents in a Collection
3.9
Updating a Document in a Collection
3.10
Using a Filter Specification to Select Documents From a Collection
3.10.1
QBE.1.json
3.10.2
QBE.2.json
3.10.3
QBE.3.json
3.10.4
QBE.4.json
4
SODA for REST HTTP Operations
4.1
SODA for REST HTTP Operation URIs
4.2
SODA for REST HTTP Operation Response Bodies
4.3
GET schema
4.3.1
URL Pattern for GET schema
4.3.2
Response Codes for GET schema
4.4
GET collection
4.4.1
URL Pattern for GET collection
4.4.2
Response Codes for GET collection
4.4.3
Links Array for GET collection
4.5
GET object
4.5.1
URL Pattern for GET object
4.5.2
Request Headers for GET object
4.5.3
Response Codes for GET object
4.6
PUT collection
4.6.1
URL Pattern for PUT collection
4.6.2
Request Body for PUT collection (Optional)
4.6.3
Response Codes for PUT collection
4.7
PUT object
4.7.1
URL Pattern for PUT object
4.7.2
Request Body for PUT object
4.7.3
Response Codes for PUT object
4.8
DELETE collection
4.8.1
URL Pattern for DELETE collection
4.8.2
Response Codes for DELETE collection
4.9
DELETE object
4.9.1
URL Pattern for DELETE object
4.9.2
Response Codes for DELETE object
4.10
POST object
4.10.1
URL Pattern for POST object
4.10.2
Request Body for POST object
4.10.3
Response Codes for POST object
4.11
POST query
4.11.1
URL Pattern for POST query
4.11.2
Request Body for POST query
4.11.3
Response Codes for POST query
4.12
POST array insert
4.12.1
URL Pattern for POST array insert
4.12.2
Request Body for POST array insert
4.12.3
Response Codes for POST array insert
4.13
POST bulk delete
4.13.1
URL Pattern for POST bulk delete
4.13.2
Request Body for POST bulk delete (Optional)
4.13.3
Response Codes for POST bulk delete
5
Collection Specifications
5.1
Key Assignment Method
5.2
Versioning Method
6
Security
6.1
Authentication Mechanisms
6.2
Security Considerations for Development and Testing
Index
Scripting on this page enhances content navigation, but does not change the content in any way.