Mavim-iMprove

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Mavim servicedesk
URL	https://my.mavim.com
Email	[email protected]

Connector Metadata
Publisher	Mavim
Website	https://www.mavim.com/
Privacy policy	https://trustcenter.mavim.com/
Categories	Business Management;Collaboration

Using the Mavim iMprove Power Platform connector you are able to Create; Retrieve; Update and Delete topic. Updating fields and Create; Retrieve; Update and Delete relations.

The Mavim topics are stored in a hierarchical manner. Where the "Mavim database" is called the root topic. Below the root topic three children exists, where the Yellow cabinet is the working area; The green cabinet contains the created (read only) versions (as children) and the purple cabinet contains the (read only) imported versions (as children).

Only in the Yellow cabinet you can change the topics; fields and relations. All the topics; relations and fields have the unique identifier called DCV code. Only the root topic has a static indentifier (d0c2v0). All other items getting a generated number provided by the Mavim database.

Please note that for some topics (like "Recycle Bin" and "Relation Categories") business rules apply.

To see the data in a more visual way you could login into the Mavim iMprove web application using your credentials also used for the Microsoft Power Platform and the following URL: https://improve.mavimcloud.com/

Prerequisites

To be able to use Mavim Power Platform connector you require to have a Mavim Cloud database and an Microsoft Entra ID login from your own tenant.

• You need the Mavim Cloud database identifier (dbid);
• The user account should have an valid e-mail address linked to his account.

How to get credentials

During the on-boarding process we ask for an Microsoft Entra ID login name. This will be registered as the admin user of the Mavim cloud database. When the Cloud database is ready, Mavim will provide the database identifier also called dbid.

Getting started with your connector

The action GetRootTopic is to get the starting point of you hierarchical tree. This will return the root topic and all its properties. Simular actions are GetTopic for getting a specific topic; GetTopicChildren to get all the children topics; GetSiblings to get all the siblings of a topic.

All calls to the actions require the dbid to connect to your own Mavim database and a langage code. Supported data languages for the API are English (en) and Dutch (nl). Topics in the Mavim database have an unique DCV-code, this is the indentifier of a specific topic also called topicid.

MavimiMprove.GetTopicRoot(dbid,datalanguage);

Get the root topic.

Response (example)

{
    "business": {
        "canCreateChildTopic": false,
        "canCreateTopicAfter": false,
        "canDelete": false,
        "isReadOnly": true
    },
    "dcv": "d0c2v0",
    "hasChildren": true,
    "icon": "TreeIconID_DbGreen",
    "isInRecycleBin": false,
    "name": "Mavim Database",
    "orderNumber": -1,
    "typeCategory": "mavimElementContainer"
}

MavimiMprove.GetTopic(dbid,datalanguage,topicId)

Get a specific topic by the DCV indentifier.

Response (example)

    "business": {
        "canCreateChildTopic": true,
        "canCreateTopicAfter": true,
        "canDelete": true,
        "isReadOnly": false
    },
    "dcv": "d16730231c28607v0",
    "hasChildren": true,
    "icon": "TreeIconID_YellowOpen",
    "isInRecycleBin": false,
    "name": "PowerApps topic",
    "orderNumber": 20,
    "parent": "d16730231c24017v0",
    "resources": [
        {
            "Value": "subTopics"
        },
        {
            "Value": "fields"
        }
    ],
    "typeCategory": "mavimElementContainer"
}

MavimiMprove.GetTopicChildren(dbid, datalanguage, topicId)

Get the children topics of the topic

Response (example)

[
    {
        "business": {
            "canCreateChildTopic": true,
            "canCreateTopicAfter": true,
            "canDelete": true,
            "isReadOnly": false
        },
        "dcv": "d16730231c28632v0",
        "hasChildren": false,
        "icon": "TreeIconID_YellowOpen",
        "isInRecycleBin": false,
        "name": "Subtopic 1",
        "orderNumber": 1,
        "parent": "d16730231c28607v0",
        "typeCategory": "unknown"
    },
   {
        "business": {
            "canCreateChildTopic": true,
            "canCreateTopicAfter": true,
            "canDelete": true,
            "isReadOnly": false
        },
        "dcv": "d16730231c28633v0",
        "hasChildren": false,
        "icon": "TreeIconID_YellowOpen",
        "isInRecycleBin": false,
        "name": "Subtopic 2",
        "orderNumber": 2,
        "parent": "d16730231c28607v0",
        "typeCategory": "unknown"
    }
]

Other supported actions are

Topic

• CreateTopicAfter
• CreateChildTopic
• UpdateTopic
• DeleteTopic

Topic structure

• MoveTopicToTop
• MoveTopicToBottom
• MoveTopicUp
• MoveTopicDown
• MoveTopicLevelUp
• MoveTopicLevelDown
• GetPathToRoot

Fields

• GetTopicFields
• GetFieldByDcvAndFieldsetId
• UpdateFields
• UpdateBooleanSingleField
• UpdateTextSingleField
• UpdateTextMultiField
• UpdateNumberSingleField
• UpdateNumberMultiField
• UpdateDecimalSingleField
• UpdateDecimalMultiField
• UpdateDateSingleField
• UpdateDateMultiField
• UpdateListSingleField
• UpdateRelationshipSingleField
• UpdateRelationshipMultiField
• UpdateRelationshipListField
• UpdateSingleHyperlinkField
• UpdateMultiHyperlinkField

Relations

• GetTopicRelations
• SaveRelation
• DeleteRelation
• GetRelationCategories

Other

• GetTopicCharts
• GetTopicTypes
• GetTopicIcons
• Version

Known issues and limitations

• Updating a topic description can only be done by our WOPI (Office for the web) API. On the My Mavim Portal you can find more information under the Mavim Developer API.
• The Mavim iMprove API supports the data languages English and Dutch.
• At the moment we only allow one tenant to access the Mavim cloud database. Guest users are not supported as of now.

Common errors and remedies

401 Unathorized

• Check if the users has access to the Mavim cloud database. Go to the user management of Mavim iMprove to ensure the correct users have access.
• Check if the user account has a valid e-mail adres.

404 Not found

• Check if the topic exists in the Mavim cloud database. You could use Mavim iMprove or the Mavim Manager to valdidate if it still exists.

FAQ

Where can I add additional users? Add additional users using the user management section in the Mavim iMprove application. Here you can add all the users that need access. Providing access to Mavim iMprove means that the user is allowed to use Mavim iMprove and the access to the API.

Serivce/API accounts Access to the Mavim database is only allowed by connecting with a named user. Mavim does not provide a clientid and secret authentication method to connect to the API.

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Create a new topic	A new topic is created as a sibling after the referenced topic.
Create new child topic	A new topic is created as a child of the referenced topic.
Create relation	Creates a relation between two topics.
Delete a topic	The specific topic requested by the topic id is deleted.
Delete relation from topic	Deletes the relation by topic id and relationId.
Get a collection of topics	Get the relationship categories of the topic
Get API version	Retrieve the API version number.
Get availible icons for a topic type	Get a collection of icons for a specific topic type.
Get field from topic	Get a specific field by field and fieldset identifier for a specific topic.
Get the Charts of the topic	From a specific topic requested with the topic id, a collection of charts is returned.
Get the children af a topic	Get the children topics of the topic
Get the fields from topic	From a specific topic requested with the topic id, a collection of fields is returned.
Get the path of the supplied topic id to the root	Get the all topics in the path to the root topic.
Get the Relations of the topic	Get the Relations of the topic supplied by topic DCV ID.
Get the root topic	Get the root topic.
Get the sibling topics of the topic	Get the siblings topics of the topic supplied by the topic id.
Get Topic	Get a specific topic by the DCV indentifier.
Get types for a topic	Get a collection of types for an specific topic supplied by the topic id.
Move a topic down in the branch	Move a specific topic one place down in the branch.
Move a topic down in the branch	Move a specific topic one place down in the branch.
Move a topic to the bottom of the branch	Move a specific topic to the bottom of the branch.
Move a topic to the top of the branch	Move a specific topic to the top of the branch.
Move a topic up in the branch	Move a specific topic one place up in the branch.
Move a topic up in the branch	Move a specific topic one place up in the branch.
Update boolean field from topic	Updates a specific boolean field by field and fieldset identifier for a specific topic.
Update date field from topic	Updates a specific single value date field by field and fieldset identifier for a specific topic.
Update decimal field from topic	Updates a specific single value decimal field by field and fieldset identifier for a specific topic.
Update list field from topic	Updates a specific list field by field and fieldset identifier for a specific topic.
Update multi value date field from topic	Updates a specific multi value date field by field and fieldset identifier for a specific topic.
Update multi value decimal field from topic	Updates a specific multi value decimal field by field and fieldset identifier for a specific topic.
Update multi value relationship field from topic	Updates a specific multi value relationship field by field and fieldset identifier for a specific topic.
Update multi value text field from topic	Updates a specific multi value text field by field and fieldset identifier for a specific topic.
Update multivalue number field from topic	Updates a specific boolean field by field and fieldset identifier for a specific topic.
Update number field from topic	Updates a specific single value number field by field and fieldset identifier for a specific topic.
Update relationship field from topic	Updates a specific single value relationship field by field and fieldset identifier for a specific topic.
Update relationshiplist field from topic	Updates a specific single value relationshiplist field by field and fieldset identifier for a specific topic.
Update text field from topic	Updates a specific single value text field by field and fieldset identifier for a specific topic.
Updates a multivalue hyperlink field	Updates a multi value hyperlink field for a specific topic.
Updates a singlevalue hyperlink field	Updates a single value hyperlink field for a specific topic.
Updates the fields from topic	Updates multiple types of fields for a specific topic.
Updates the name of the topic	Updates the name of a specific topic.

Create a new topic

Create new child topic

Create relation

Delete a topic

Delete relation from topic

Get a collection of topics

Get API version

Get availible icons for a topic type

Get field from topic

Get the Charts of the topic

Get the children af a topic

Get the fields from topic

Get the path of the supplied topic id to the root

Get the Relations of the topic

Get the root topic

Get the sibling topics of the topic

Get Topic

Get types for a topic

Move a topic down in the branch

Move a topic down in the branch

Move a topic to the bottom of the branch

Move a topic to the top of the branch

Move a topic up in the branch

Move a topic up in the branch

Update boolean field from topic

Update date field from topic

Update decimal field from topic

Update list field from topic

Update multi value date field from topic

Update multi value decimal field from topic

Update multi value relationship field from topic

Update multi value text field from topic

Update multivalue number field from topic

Update number field from topic

Update relationship field from topic

Update relationshiplist field from topic

Update text field from topic

Updates a multivalue hyperlink field

Updates a singlevalue hyperlink field

Updates the fields from topic

Updates the name of the topic

Definitions

CategoryType

FieldType

IChart

IField

IPathItem

IRelationship

IRelationshipElement

ISimpleDispatchInstruction

ITopic

ITopicBusiness

ITopicPath

RelationshipType

TopicResource

TopicType

string

object