Here is a series of sample queries and mutations for the ReflowOS client API (which uses GraphQL) that will be needed to achieve the use cases proposed in this manual.
The API is flexible enough to satisfy a wider range of use cases and scenario, according to the stakeholders needs.
Think of the following ones as a starting point to help shape your apps and ideas.
You can also refer to the full auto-generated API documentation.
Register a new user
Get the current user details
The current logged in account and user. Contains different fields (including private information) than querying for myAgent.
Display currently logged in agent profile
Display any agent profile
Display the activities on the local instance (paginated)
Contains all activities from the instance.
Display a user's activities (paginated)
Display current user's feed (paginated)
Contains activities from people, agents or groups the current user is following.
Display all users (paginated)
Define the network sentiment
Read more about this usecase
Phase 1. Populate the network with activities
Create a location
Populate the network with a set of meaningful locations, so that they will be filterable and associated with specific events.
Create a unit
Create the units that will be used within the network
Record an offer (inventory entry)
Record a need (wishlist entry)
Publish an offer or a need (proposal)
- Publish a proposal
- Link the offer or need (intent) to the proposal
Publish a proposal (by itself)
Create a process
An activity that changes inputs into outputs. It could transform or transport economic resource(s).
Conduct an economic event that results in a completely new resource
Conduct an economic event on an existing resource
Conduct an economic event between an existing resource and a new resource
Start a discussion upon an offer or a need
Phase 2. Search and filter aggregated data
Look for proposals at a specific place
Look for proposals near a specific location
Look for proposals from a specific agent
Look for proposals with a specific scope (eg. a community)
Look for all proposals tagged with a specific category / taxonomy
Look for all EconomicEvents within a specific scope
Look for all EconomicEvents of a specific agent
Generate a material passport
Read more about this usecase
To generate a material passport, it is needed to create economic events, resources and processes that are bound each other.
Following some examples of data coming from economic resource, event and process queries
Filter resources by current location
Filter resources by tags
Track back from an EconomicResource
Currently is only possible to go one level back in the chain. It will always return an EconomicEvent, when tracing back from an EconomicResource.
Track back from an EconomicEvent
Currently is only possible to go one level back in the chain. Tracing back from an EconomicEvent, it may return a Process or an EconomicResource
Track back from a Process
Currently is only possible to go one level back in the chain. Tracing back from a Process, it will return an EconomicEvent