Generic Resource
PEPPERI NOTIFICATION SERVICE
Actions Queue
CPI Node
TODO training

Upsert Document

Don't use for operative data, recommended for addon's meta data

the combination of AddonUUID+DistUUID+table must be unique and will serve as the partition, Key1 as sorted key

The Document Size is limited to 400Kb (including the keys)

CreationDateTime

ModificationDateTime

Hidden (including Expiration Date - TTL) - after one month that the hidden was set to true the document will be deleted

OwnerUUID - only the same addon that created the document can edit/delete

The Addons Data Layer will perform the following

  1. Merge - merge data in case of partial update

  2. publish - call PNS (i.e. publish) with the relevant Audit Object (update/insert and send only changes)

  3. dates - manage the modification and creation date time

  4. hidden - (including Expiration Date - TTL) - after one month that the hidden was set to true the document will be deleted

  5. OwnerUUID - internal field that will not be returned - or consider to define it as readonly

SecretKey uses for security, checking that the requested addon in the current addon. It is part of the client object - Client.AddonSecretKey

Hidden data will be deleted after 30 days

ExpirationDateTime can be used to set a date time in which the document will be deleted.

If we set both Hidden (true) and ExpirationDateTime we will use the given expiration and not the default 30 days

If we set Hidden false and the item not contains requested ExpirationDateTime the ExpirationDateTime will be deleted

ExpirationDateTime is not supported for cpimetadata items

post
Save data in dynamo

https://api.pepperi.com/v1.0/addons/data/{AddonUUID}/{table}
Allows save addon's data in dynamo DB
Request
Response
Request
Path Parameters
table
required
string
Key in dynamoDB
Headers
X-Pepperi-OwnerID
optional
string
The requested addonUUID (mandatory only for meta_data)
X-Pepperi-ActionID
optional
string
actionUUID for logging
X-Pepperi-SecretKey
required
string
addon secret key
Body Parameters
optional
object
Same object as returned in the "get"
Response
200: OK
successfully retrieved.
the updated object is returned

put
Create or Update

https://api.pepperi.com/v1.0/addons/data/{AddonUUID}/{table}/{key}
Same as POST but this will overwrite the complete document There is no need to provide "key" inside the document, if one is provided it must be the same as the {key} in the url
Request
Response
Request
Path Parameters
optional
string
Response
200: OK