Generic Resource
PEPPERI NOTIFICATION SERVICE
ADAL Import Export
Actions Queue
CPI Node
TODO training

Pages

The Pages resource

A standard pepperi resource that supports get & post

get
Pages resource

https://papi.pepperi.com/v1.0/pages
Request
Response
Request
Path Parameters
optional
string
Response
200: OK
[{
// Regular ADAL fields
"Hidden": false,
"CreationDateTime": "2021-07-22T13:00:11.360Z",
"ModificationDateTime": "2021-07-22T13:00:11.360Z",
// unique key.
// created on first upsert
"Key": "610bdf75-d66e-4126-bfc4-0bb74eeabcab",
// optional
"Name": "MyPage",
// optional
"Description": "",
// optional - default None Types: (Home, AccountHome, None)
"Type": "Home",
// A list of the blocks on the page
// We might want to move the actual data of each block to a seperate internal resource
"Blocks": [
{
// A Key of the block instance
"Key": "99dfdff5-d042-4f4b-94ec-1d4fb238adba",
// A copy of the relation object when this block was added the page
"Relation": {
"Name": "",
"SubType": "Ng12",
"AddonUUID": "a6f4fd84-d539-41a5-9ff6-946bddebf4d1",
"AddonRelativeURL": "/addon_block",
"ModuleName": "MyModule",
"ComponentName": "MyComponent"
},
// The block instance configuration
// that the block creates and edits in its editor
"Configuration": {},
// The block relation configuration
// not final
"PageConfiguration": {
"Consume": {
"Filter": {
"Resource": "transaction_lines",
"Fields": ["UnitsQuantity", "Item.TSABrand", "Transaction.Account.Type", "Transaction.Status"],
},
"Context": {
"Resource": "transaction"
}
},
"Produce": {
"Filters": [
{
"Resource": "transaction",
"Fields": ["UnitsQuantity", "Item.TSABrand", "Transaction.Account.Type", "Transaction.Status"],
}
],
"Context": {
"Resource": "transaction_lines"
}
}
}
}
],
// A list of sections in the page
"Layout": {
"Sections": [
{
// The unique key of the section
// mandatory
"Key": "99dfdff5-d042-4f4b-94ec-1d4fb238adba"
// the name of the section
// to be shown in the UI
"Name": ""
// Is the height of the section fixed,
// or is it dynamic based on the tallest block's height
// "IsHeightFixed": true,
// The fixed height
// or min height when IsHeightFixed=false
// The units is rem
"Height": 350,
// How do the columns split in the section
// For 1 part this must be empty
// For 2 parts this must be "1/2 1/2" | "1/3 2/3" | "2/3 1/3"
// For 3 parts this must be "1/3 1/3 1/3" | "1/2 1/4 1/4" | "1/4 1/2 1/4" | "1/4 1/4 1/2"
// For 4 parts this must be "1/4 1/4 1/4 1/4" etc.
"Split": "",
// The blocks in the section LTR
"Columns": [
{
// optional - default empty column
"Block": {
"Key": "99dfdff5-d042-4f4b-94ec-1d4fb238adba",
// Hide the block in certain screen sizes
// default is empty array
"Hide": ["Desktop", "Tablet", "Mobile"]
}
}
],
// Hide the section in certain screen sizes
// default is empty array
"Hide": ["Tablet", "Phablet", "Landscape"]
}
],
// The Gap between the sections
// optional - default is None (no gap)
"SectionsGap": "SM|MD|LG",
// The Gap between the column in the sections
// optional - default is None (no gap)
"CoulmnsGap": "SM|MD|LG",
// nonexisting or 0 - is 100%
// in pixel
"MaxWidth": 1200
}
}]