React-M API

Get started with React-M™, the world's only data-triggered TODO management system.

SUMMARY :

If you have any questions that are unanswered in this documentation, contact jbardin@microshare.io.

Introduction

If you want to understand how works React-M, take a look at our page describing how it works : https://docs.microshare.io/docs/2/general/reactm-user-guide/

Creating a Task

The data triggered task will be generated by our robot system that analyse the data and trigger new tasks depending on parameters. To do so, you need to have the solution set up by microshare, as part of our ALPHA, BETA solution or product.
Create your own tasks :

You can create your own tasks through API.

Api

To follow these explaination you must have go through our API explanations first : https://docs.microshare.io/docs/2/technical/api/quick-start/

To use the api for our ToDo, here are the details :

URL : /processes/TODO?Authorization=

replace by the corresponding value

wfhostname is the same as the tutorial set up. For the sessionKey, while you do your authentication you should see in the response the session key.

**BODY : **

{
    "REQUEST": {
        "INPUT": {
            "FACTS": {
                "todos": [
                    {
                        "item": "'Pls Cln' was received from 1st Floor.",
                        "isChecked": false
                    }
                ],
                "title": "'Pls Cln' at 1st Floor.",
                "notificationTitle": "'Pls Cln' was received from 1st Floor.",
                "notificationBody": "Please go to the location and act on the request",
                "listAssignee": "assigne1@microshare.io,assigne2@microshare.io",
                "wf_location": "Wework Microshare,1st Floor, North - Men, Restroom",
                "wf_metaTags": "bathroom,toilet",
                "location1": "Wework Microshare",
                "location2": "1st Floor",
                "location3": "North - Men",
                "location4": "Restroom"
            }
        }
    }
}

These settings are mandatory settings:

listAssignee - (String) list of users who access the task separated by comma.

notificationTitle - (String) Custom your notification title. (default: “New task available for you.”)

notificationBody - (String) Custom your body notification text. (default: “Click to Claim, Close, or Ignore.”)

title - (String) Title of the task in React-M app. (default : 1st subtask)

todos - (Array[Object]) Subtasks of the ToDO.

wf_location - (String) Location of the event, comma separated

wf_metaTags - (String) Metatags about the event and event location, comma separated

“location1”: “location2”: “location3”: “location4 - (String) - Each layers of the location.

These settings are available for a different workflow path in ReactM :

wf_includeSteps - steps to include, string like : accept,do - to define which steps to keep for a lighter process (if no step to include, then this parameter is skipped)

wf_excludeSteps: "steps to exclude, string like : accept" - to define which steps to skip for a lighter process, would be overwrite by wf_includeSteps (if all steps to exclude, then this parameter is skipped)

These settings are mandatory for better statistics on rectM uses :

wf_originType - (String) Origin data type like "feedback", "motion"

wf_originEvent - (String) Origin data event like "clean", "paper", "soap" ...

wf_productBrand - (String) Microshare Product Branding of this task like "eversmart"

wf_product - (String) Microshare Product Type of this task like "clean" (for Es Clean)

task_category - (String) Type of category (maintenance, device_health, cleaning, organisation ...)

task_id - (String) Id of the task in this category

These “configReactM” settings are optionals:

// Activity Timer String: https://en.wikipedia.org/wiki/ISO_8601#Durations

startingPriorityUpdate - (Int) Is this task higher priority, specify a starting priority value. (default: 0)

remindingPriorityUpdate - (Int) At every reminder trigger, does it imply to make the priority higher? If yes it will be happen to the priority (default: 50)

globalReminderTime - (Activity Timer String) How long does the app wait to remind the users about an open task if nobody took it ?
For all the steps, would be overwrite by steps definitions (default: PT2H => 2 hours)

globalTimeoutTime - (Activity Timer String) How long does the app wait before it closes a task if nobody took it ? For all the steps, would be overwrite by steps definitions (default: PT2H => 2 hours)

acceptReminderTime - (Activity Timer String) How long does the app wait to remind the users about an open task if nobody took it ? For the Accept step (default: PT2H => 2 hours)

doReminderTime - (Activity Timer String) How long does the app wait to remind the users about an open task if nobody took it ? For the Do step (default: PT2H => 2 hours)

doReminderTime - (Activity Timer String) How long does the app wait to remind the users about an open task if nobody took it ? For the Done step (default: PT2H => 2 hours)

acceptTimeoutTime - (Activity Timer String) How long does the app wait before it closes a task if nobody took it ? For the Accept step (default: PT3H => 3 hours)

doTimeoutTime - (Activity Timer String) How long does the app wait before it closes a task if nobody took it ? For the Do step (default: PT3H => 3 hours)

doTimeoutTime - (Activity Timer String) How long does the app wait before it closes a task if nobody took it ? For the Done step (default: PT3H => 3 hours)