PEPPERI NOTIFICATION SERVICE
PFS - Pepperi File Service
Actions Queue
CPI Node
TODO training
😥
BulkGet (Archived)
Get multiple objects from a table with a single call
post
https://api.pepperi.com
/v1.0/addons/data/bulk_get/{addonUUID}/{table}
Bulk Get
BulkGet can be provided with up to 100 keys to retrieve items from an ADAL table. However, there is a limit of 6MB on the returned value. That means that if all 100 objects total to over 6MB, only some of them will return. All keys that failed to retrieve an object for that reason, will be included in the return object as an array of "UnprocessedKeys".
  • Maximum 100 keys as input. Requesting more will result in the failure of the entire operation.
  • Maximum 6MB as return value. It is possible that not all objects will return.
If while trying to retrieve an object, it is found that the object doesn't exist in the ADAL table, it will not be returned and its key will not be found in UnprocessedKeys.
Objects are returned in an un-ordered way, meaning that it is possible for the first returned object to correspond to the last key in the request, and vice versa.
BulkGet takes as input an array of keys intended for retrieval from the ADAL table:
1
{
2
"Keys":
3
[
4
"foo1",
5
"foo2",
6
// ...
7
"fooN" //up to 100 keys
8
]
9
}
Copied!
There must be NO duplicates in the request. That means, the input array may not contain a certain key more than once. A duplicate key will cause the entire operation to fail.
BulkGet outputs an object in the following format:
1
{
2
"Objects":
3
[{},{},...,{}],
4
"UnprocessedKeys":
5
{
6
"Keys": ["", "", ..., ""]
7
}
8
}
Copied!
The value of "UnprocessedKeys" can then be used to make another request to BulkGet for the rest of the objects.
Last modified 1mo ago
Copy link