Home
Invoke mRounds Tasks Using APIs
Innovapptive exposes certain APIs that can be used by applications and create tasks like creating operator rounds, dynamically generate round plans, and so on.
Dynamically Generate and Partially Execute a Round
A round plan is a blueprint that outlines the structure and steps of a round. You must first create a round plan and then generate a round from the round plan.
Create a Round and Partially Execute It
The Post Round Plan API service allows you to create a round and execute it partially based on the round plan details request.

Title and Copyright
Review the guide's release details, copyright notices, and terms of use.
Preface
Understand audience, know related documents and products and conventions followed in this document.
What's New for mRounds Configurators
Find new and expanded configuration guidance for Maximo, Dozuki, AVEVA PI, iMES, Gensuite and Shift Handover Reports.
Integrate mRounds with External Systems
Configure external-system connections for master data synchronization, data export, email, and maintenance integrations.
Onboard Tenants/Super Admins
Use the Tenant Management module to create tenant or super admin roles for onboarded customers/user and provide access to the applications and modules.
Create and Manage Master Data
Master Data forms the foundation of the system, providing essential information such as plants, shifts, locations, assets, units of measurement, and response sets. Properly setting up master data ensures seamless work order management, asset tracking, and operational efficiency.
Onboard Users and Assign Roles
Use the User Management module to create roles and so on, create users, and assign relevant roles to the users.
Invoke mRounds Tasks Using APIs
Innovapptive exposes certain APIs that can be used by applications and create tasks like creating operator rounds, dynamically generate round plans, and so on.
- Generate API Keys for mRounds
  Generate a tenant API key so that external applications can call mRounds APIs.
- Create Rounds Using APIs
  Learn how to create rounds using APIs
- Dynamically Generate and Partially Execute a Round
  A round plan is a blueprint that outlines the structure and steps of a round. You must first create a round plan and then generate a round from the round plan.
  - Get the Round Plans List
    The Get Round Plans List API service allows you to fetch the round plans list based on query parameters. If no query parameters are passed, by default, it fetches the published round plans list with a limit of 100.
  - Get Round Plan Details
    The Get Round Plan Details API service allows you to fetch specific round plan details with tasks based on the roundPlanId path parameter. It returns location or asset wise round plan details.
  - Create a Round and Partially Execute It
    The Post Round Plan API service allows you to create a round and execute it partially based on the round plan details request.
  - View Updated Details in the mRounds Mobile App
    You can view all the pre-filled responses on the mobile application.
- API Error Codes
  Identify the error codes that mRounds APIs return.

Create a Round and Partially Execute It

The Post Round Plan API service allows you to create a round and execute it partially based on the round plan details request.

To create and execute a round partially:

Click Authorize.
In the Available Authorizations pop-up, enter the API Key value and click Authorize.
Click Close.
Expand the Post method with rounds.
Click Try it out.

Provide the following request parameters:


Field Name	Description
tenantid*	Enter the Tenant ID created by Tenant Management.

In the Request Body section, edit the code by adding pre-filled values as required.
Note:
This Dynamic Rounds Generation using APIs process supports only five Response Types. They are Text Answer, Number, Date Range, Date & Time, and Photo. The format of the pre-filled response must be base 64 for images, ISO string for Date & Time, and Date Range response types.
For example,
```
{
  "roundPlanId": "addd59d8-84ae-4221-a2ed-51a4a60a25a0",
  "assignedTo": "abc@iinovapptive.com",
  "tasks": [
    {
      "id": "Q1",
      "value": "Tom Curran"
    },
    {
      "id": "Q2",
      "value": "209.09"
    },
    {
      "id": "Q3",
      "value": "2023-07-31T08:11:31.526Z"
    },
    {
      "id": "Q4",
      "value": "2023-07-31T08:11:31.526Z"
    },
    {
      "id": "Q5",
      "value": "2023-07-31T08:44:24.526Z;2023-07-30T08:44:24.526Z"
    },
    {
      "id": "Q6",
      "value": "<base64-encoded image>"
    }
  ]
}
```
Add the base 64 string (id: Q6) for the image response type.

Note:
If you provide the email ID of the person who needs to work on the round in the Assign to field, then the round is assigned to the user and automatically appears in the My Rounds screen of the user with the In-progress state in the user's mobile application.
Click Execute.

The following response is displayed.