Cinnamon - Data availability, quality & security

Key Principles

Similar principles as with the other APIs are relevant here.

Usage & Contents	This interface delivers the current data availabiliy for all portfolios The usage is mainly to feed the Scheduler Service to automatically schedule reports when data get's available
Reporting Business Logic	Report scheduling logic (given orders, portfolios availability and existing executions)
Consistency Rules	The following rules should be adhered to by any response and will eventually be checked when consuming a response: Consistency Rules * all portfolios available should be listed * the list of qualities should not include duplicates
Path	`/portfolio/availability`
Parameters	`portfolioId` (optional)	string	The id of the portfolio (or consolidation) in the data source
Example call	`/portfolio/availability`
Schema	ON REQUEST
Example	ON REQUEST

Usage & Contents	This interface delivers the data quality of a single portfolio The usage is mainly to document the data issues for a portfolio with quality status "issues"
Reporting Business Logic	None
Consistency Rules	The following rules should be adhered to by any response and will eventually be checked when consuming a response: id should be unique
Path	`/portfolio/quality`
Parameters	`portfolioId`	string	The id of the portfolio (or consolidation) in the data source
Parameters	`reportingDate`	string (date)	The date, the reporing is produced for.
Example call	`/portfolio/quality?portfolioId=E0002&reportingDate=2019-03-31`
Schema	ON REQUEST
Example	ON REQUEST

Usage & Contents	This interface delivers all portfolios of a location The usage is mainly to feed the Data Scope Service where the lists are tailored to represent a users data scope
Reporting Business Logic	Data scope calculation
Consistency Rules	The following rules should be adhered to by any response and will eventually be checked when consuming a response: Consistency Rules * Every portfolioId is a valid portfolio (e.g. returns data for /portfolio/masterdata) * The list of portfolios is a set (no duplicates)
Path	`/portfolio/bylocation`
Parameters	`location`	string	The id of the location `GLOBAL` (this location will deliver all the portfolios) `CH` `SG` etc.
Example call	`/portfolios?location=CH`
Schema	ON REQUEST
Example	ON REQUEST

Usage & Contents	This interface delivers all portfolio roles for a given user (e.g. if he is PM or CPM) The usage is mainly to feed the Data Scope Service tailor portfolio access
Reporting Business Logic	Data scope calculation
Consistency Rules	The following rules should be adhered to by any response and will eventually be checked when consuming a response: Consistency Rules * Every portfolioId is a valid portfolio (e.g. returns data for /portfolio/masterdata) * portfolioIds are unique within the response (no duplicates)
Path	`/user/portfolioroles`
Parameters	`userId`	string	The id of the user: example bmpi: marcus.braendle example CSAM: F883476
Example call	`/user/portfolioroles?userId=james.bond`
Schema	ON REQUEST
Example	ON REQUEST