Request format
The following format is for the HTTP Request to create, update, fetch, and
delete data items in
BEMS
: <HTTP Method> jsonstore/<serviceName>/<option> <request-header> <request-body>
- Where <HTTP Method> is POST, GET, or DELETE.
- Where <serviceName> is the name of the URI. For example, bookmarks.
- Where <option> is one of the following actions:
- createupdate: Use with POST to create or update one or more records.
- read/<id>: Use with GET to fetch the record with the specified Id.
- fetch: Use with POST to fetch one or multiple records.
- delete/<id>: Use with DELETE to delete the record with the specified Id.
- delete: Use with POST to delete multiple records.
The following is a sample request header:
Content-Type: application/json X-Good-GD-AuthToken: <GDAuthToken> X-Good-GEMS-Scope:<scope> X-Good-GEMS-RegistrationId: <RegistrationId>
- Where <scope> specifies where an object can be stored and retrieved from. The scope is included in every request header. You can specify one for the following scopes:
- User: The User scope allows for the object to be accessed, modified, and retrieved by any application on any device that is assigned to the user.
- Application: The application scope allows for the object to be accessed, modified, and retrieved only by the specified application on any device assigned to the user.
- Container: The container scope allows for the object to be accessed, modified, and retrieved only by the specified container for the user.
- Where <RegistrationId> specifies the unique ID for the client application in the request header. The registration ID is used as the originator in the GEMSUpdate message to other client applications. RegistrationId is only used when you create, update, and delete bookmarks.