Doc Store
Retrieves the document content and version for the specified key. Returns 404 if the key does not exist. The version can be used for optimistic concurrency control in subsequent updates.
The document value has been successfully retrieved.
The key was not found.
Internal server error.
GET /sfp/api/doc-store/docs/{key} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
No content
Stores or updates a document with the specified key. Supports optimistic concurrency control via version parameter. If version is provided, it must match the current version for updates. For new documents, version should not be provided.
The document entry has been successfully created or updated.
Internal server error.
POST /sfp/api/doc-store/docs/{key} HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 12
{
"value": {}
}No content
Permanently removes a document from the store. This operation cannot be undone. Returns 404 if the key does not exist. Only users with owner role or application tokens can perform this operation.
The document entry has been successfully deleted.
The key was not found.
Version mismatch.
Internal server error.
DELETE /sfp/api/doc-store/docs/{key} HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 13
{
"version": 1
}No content
Retrieves only the version number for the specified key without the document content. Useful for checking if a document has been modified before fetching the full content. Returns 404 if the key does not exist.
The document version has been successfully retrieved.
The key was not found.
Internal server error.
GET /sfp/api/doc-store/docs/{key}/version HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
No content
Returns an array of all document keys in the store. This operation may be expensive for large stores. Keys are returned in no particular order. Use with caution in production environments with many documents.
When true, returns only documents that are not part of any collection (collection_id is null). When false or omitted, returns all documents including those in collections.
The list of keys has been successfully retrieved.
Internal server error.
GET /sfp/api/doc-store/docs HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
No content
Was this helpful?