Inyett API / Monitor
Monitor
Commercial Description
Data sets
Description | Method | Endpoint |
Get all portfolios | GET | /3/{profileCountry}/{companyId}/monitor/portfolios |
Create new portfolio | POST | /3/{profileCountry}/{companyId}/monitor/portfolios |
Get a specific portfolio based on portfolioId | GET | /3/{profileCountry}/{companyId}/monitor/portfolios/{id} |
Updated portfolio based on portfolioId | PUT | /3/{profileCountry}/{companyId}/monitor/portfolios/{id} |
Delete portfolio based on portfolioId | DELETE | /3/{profileCountry}/{companyId}/monitor/portfolios/{id} |
Get changes in a portfolio | GET | /3/{profileCountry}/{companyId}/monitor/portfolios/{id}/changes |
Update change status | PUT | /3/{profileCountry}/{companyId}/monitor/portfolios/{id}/changes |
Get companies in a portfolio | GET | /3/{profileCountry}/{companyId}/monitor/portfolios/{id}/companies |
Add company to portfolio | POST | /3/{profileCountry}/{companyId}/monitor/portfolios/{id}/companies |
Remove company from portfolio | DELETE | /3/{profileCountry}/{companyId}/monitor/portfolios/{id}/companies |
Get all settings for a portfolio | GET | /3/{profileCountry}/{companyId}/monitor/portfolios/{id}/settings |
Update settings | PUT | /3/{profileCountry}/{companyId}/monitor/portfolios/{id}/settings |
User Story: Streamlining Supplier Management with Monitor Platform
As a supply chain manager,
I want to utilise the Monitor platform to automate the monitoring of my company's suppliers,
So that we can ensure our ERP system reflects accurate and up-to-date supplier information without manual oversight.
Scenario: Setting up and managing supplier monitoring
- Creating a Portfolio for Monitoring (using POST /3/{profileCountry}/{companyId}/monitor/portfolios):
- Given the company needs to monitor a broad list of suppliers,
- When I log into the ERP system
- Then I can create a new portfolio, where I give it a specific name and save the returned `portfolioId`.
- Adding Suppliers to the Portfolio (using POST /3/{profileCountry}/{companyId}/monitor/portfolios/{id}/companies):
- Given I have a portfolio for supplier monitoring,
- When new suppliers need to be monitored,
- Then I can add these suppliers to the designated portfolio, selecting specific details for monitoring for each supplier.
- Monitoring Changes to Suppliers (using GET /3/{profileCountry}/{companyId}/monitor/portfolios/{id}/changes):
- Given suppliers are constantly updating their information,
- When changes are detected within the monitored portfolio,
- Then the Monitor platform notifies me so I can fetch the updated information to keep our ERP system current.
- Reviewing Portfolio and Supplier Status (using GET /3/{profileCountry}/{companyId}/monitor/portfolios):
- Given a need to overview all monitoring activities,
- When I access the Monitor platform’s portfolio overview,
- Then I can view all portfolios, including their names, statuses, and the suppliers being monitored.
- Updating Portfolio Settings as Needed (using PUT /3/{profileCountry}/{companyId}/monitor/portfolios/{id}/settings):
- Given monitoring needs may change over time,
- When I decide to update the monitoring settings of a portfolio,
- Then I can change the settings to better suit current monitoring objectives.
- Efficiently Managing Portfolios and Suppliers:
- Given changes in business strategy or supplier relationships,
- When portfolios or suppliers need to be updated or removed,
- Then I can use the platform to update (_PUT /3/{profileCountry}/{companyId}/monitor/portfolios/{id}_) or delete (_DELETE /3/{profileCountry}/{companyId}/monitor/portfolios/{id}_) portfolios, or remove suppliers from monitoring (_DELETE /3/{profileCountry}/{companyId}/monitor/portfolios/{id}/companies_).
Acceptance Criteria:
- Automated Monitoring: The platform must automate the tracking of changes in supplier information, alerting the supply chain manager of necessary updates.
- Flexibility in Management: Users must be able to easily add, update, or remove suppliers from portfolios, as well as manage the portfolios themselves.
- Up-to-Date ERP System: Following alerts on changes, the system allows for easy extraction of updated data to ensure the ERP system remains accurate.
- Customizable Monitoring: The platform must provide options to customize what information is monitored for each supplier, and allow changes in monitoring strategies through settings updates.
- Comprehensive Overview: Users should have access to an overview of all monitoring activities, including details on specific portfolios and the companies within them.
Outcome: By leveraging the Monitor platform according to the user story, the supply chain manager ensures continuous accuracy of the ERP system with minimal manual intervention, thereby streamlining the management of supplier information and enhancing operational efficiency.
Business Value Summary:
-
Operational Efficiency: Streamlines supplier information management, reducing manual effort and error.
-
Supplier Relationships: Enables proactive management, improving trust and collaboration.
-
Cost Savings: Reduces administrative costs by automating monitoring and updates, allowing strategic resource allocation.
-
Risk Mitigation: Facilitates early detection of supplier risks, enhancing supply chain resilience.
-
Scalability: Easily accommodates business growth without additional administrative burden.
-
Informed Decisions: Provides accurate, up-to-date supplier data for strategic planning and negotiations.
Outcome: The automation and efficiency gained through the Monitor platform significantly enhance operational processes, cost savings, and strategic decision-making capabilities, directly contributing to the company's competitive advantage and bottom line.