Mavim-iMprove

With the Mavim connector you are able to build a digital twin of your organization by visualizing the relationships among people, process and technology and creates a map of business operations to help you monitor change, measure impact, and make informed business decisions to help you reach your destination. Our cloud software makes use of open standards for integration with third party applications, enabling simple adoption into any company’s technology stack.

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	servicedesk@mavim.com

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

Operation ID:

CreateTopicAfter

A new topic is created as a sibling after the referenced topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.
name	name	True	string	Gets or sets the name
type	type	True	string	Gets or sets the type
icon	icon	True	string	Gets or sets the icon

Returns

Body

ITopic

Create new child topic

Operation ID:

CreateChildTopic

A new topic is created as a child of the referenced topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.
name	name	True	string	Gets or sets the name
type	type	True	string	Gets or sets the type
icon	icon	True	string	Gets or sets the icon

Returns

Body

ITopic

Create relation

Operation ID:

SaveRelation

Creates a relation between two topics.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
fromElementDcv	fromElementDcv		string	FromElementDcv
toElementDcv	toElementDcv		string	ToElementDcv
relationshipType	relationshipType		string

Returns

Body

IRelationship

Delete a topic

Operation ID:

DeleteTopic

The specific topic requested by the topic id is deleted.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.

Returns

Body

ITopic

Delete relation from topic

Operation ID:

DeleteRelation

Deletes the relation by topic id and relationId.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.
The relation identifier.	relationId	True	string	The relation identifier.

Get a collection of topics

Operation ID:

GetRelationCategories

Get the relationship categories of the topic

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.

Returns

response

array of ITopic

Get API version

Operation ID:

Version

Retrieve the API version number.

Returns

response

string

Get availible icons for a topic type

Operation ID:

GetTopicIcons

Get a collection of icons for a specific topic type.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic type.	topicType	True	string	The Topic type.

Returns

response

object

Get field from topic

Operation ID:

GetFieldByDcvAndFieldsetId

Get a specific field by field and fieldset identifier for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The field set definition identifier.	fieldsetId	True	string	The field set definition identifier.
The field definition identifier.	fieldId	True	string	The field definition identifier.

Returns

Body

IField

Get the Charts of the topic

Operation ID:

GetTopicCharts

From a specific topic requested with the topic id, a collection of charts is returned.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.

Returns

response

array of IChart

Get the children af a topic

Operation ID:

GetTopicChildren

Get the children topics of the topic

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.

Returns

response

array of ITopic

Get the fields from topic

Operation ID:

GetTopicFields

From a specific topic requested with the topic id, a collection of fields is returned.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.

Returns

response

array of IField

Get the path of the supplied topic id to the root

Operation ID:

GetPathToRoot

Get the all topics in the path to the root topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.

Returns

Body

ITopicPath

Get the Relations of the topic

Operation ID:

GetTopicRelations

Get the Relations of the topic supplied by topic DCV ID.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.

Returns

response

array of IRelationship

Get the root topic

Operation ID:

GetTopicRoot

Get the root topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.

Returns

Body

ITopic

Get the sibling topics of the topic

Operation ID:

GetTopicSiblings

Get the siblings topics of the topic supplied by the topic id.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The DCV identifie.	topicId	True	string	The DCV identifie.

Returns

response

array of ITopic

Get Topic

Operation ID:

GetTopic

Get a specific topic by the DCV indentifier.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.

Returns

Body

ITopic

Get types for a topic

Operation ID:

GetTopicTypes

Get a collection of types for an specific topic supplied by the topic id.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The DCV identifie.	topicId	True	string	The DCV identifie.

Returns

response

object

Move a topic down in the branch

Operation ID:

MoveTopicLevelDown

Move a specific topic one place down in the branch.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.

Move a topic down in the branch

Operation ID:

MoveTopicDown

Move a specific topic one place down in the branch.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.

Move a topic to the bottom of the branch

Operation ID:

MoveTopicToBottom

Move a specific topic to the bottom of the branch.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.

Move a topic to the top of the branch

Operation ID:

MoveTopicToTop

Move a specific topic to the top of the branch.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.

Move a topic up in the branch

Operation ID:

MoveTopicUp

Move a specific topic one place up in the branch.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.

Move a topic up in the branch

Operation ID:

MoveTopicLevelUp

Move a specific topic one place up in the branch.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.

Update boolean field from topic

Operation ID:

UpdateBooleanSingleField

Updates a specific boolean field by field and fieldset identifier for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The field set definition identifier.	fieldsetId	True	string	The field set definition identifier.
The field definition identifier.	fieldId	True	string	The field definition identifier.
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		boolean

Returns

Body

IField

Update date field from topic

Operation ID:

UpdateDateSingleField

Updates a specific single value date field by field and fieldset identifier for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The field set definition identifier.	fieldsetId	True	string	The field set definition identifier.
The field definition identifier.	fieldId	True	string	The field definition identifier.
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		date-time

Returns

Body

IField

Update decimal field from topic

Operation ID:

UpdateDecimalSingleField

Updates a specific single value decimal field by field and fieldset identifier for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The field set definition identifier.	fieldsetId	True	string	The field set definition identifier.
The field definition identifier.	fieldId	True	string	The field definition identifier.
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		double

Returns

Body

IField

Update list field from topic

Operation ID:

UpdateListSingleField

Updates a specific list field by field and fieldset identifier for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The field set definition identifier.	fieldsetId	True	string	The field set definition identifier.
The field definition identifier.	fieldId	True	string	The field definition identifier.
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		object
options	options		object

Returns

Body

IField

Update multi value date field from topic

Operation ID:

UpdateDateMultiField

Updates a specific multi value date field by field and fieldset identifier for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The field set definition identifier.	fieldsetId	True	string	The field set definition identifier.
The field definition identifier.	fieldId	True	string	The field definition identifier.
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		array of date-time

Returns

Body

IField

Update multi value decimal field from topic

Operation ID:

UpdateDecimalMultiField

Updates a specific multi value decimal field by field and fieldset identifier for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The field set definition identifier.	fieldsetId	True	string	The field set definition identifier.
The field definition identifier.	fieldId	True	string	The field definition identifier.
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		array of double

Returns

Body

IField

Update multi value relationship field from topic

Operation ID:

UpdateRelationshipMultiField

Updates a specific multi value relationship field by field and fieldset identifier for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The field set definition identifier.	fieldsetId	True	string	The field set definition identifier.
The field definition identifier.	fieldId	True	string	The field definition identifier.
fieldId	fieldId		string
fieldsetId	fieldsetId		string
dcv	dcv		string
name	name		string
icon	icon		string

Returns

Body

IField

Update multi value text field from topic

Operation ID:

UpdateTextMultiField

Updates a specific multi value text field by field and fieldset identifier for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The field set definition identifier.	fieldsetId	True	string	The field set definition identifier.
The field definition identifier.	fieldId	True	string	The field definition identifier.
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		array of string

Returns

Body

IField

Update multivalue number field from topic

Operation ID:

UpdateNumberMultiField

Updates a specific boolean field by field and fieldset identifier for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The field set definition identifier.	fieldsetId	True	string	The field set definition identifier.
The field definition identifier.	fieldId	True	string	The field definition identifier.
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		array of integer

Returns

Body

IField

Update number field from topic

Operation ID:

UpdateNumberSingleField

Updates a specific single value number field by field and fieldset identifier for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The field set definition identifier.	fieldsetId	True	string	The field set definition identifier.
The field definition identifier.	fieldId	True	string	The field definition identifier.
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		integer

Returns

Body

IField

Update relationship field from topic

Operation ID:

UpdateRelationshipSingleField

Updates a specific single value relationship field by field and fieldset identifier for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The field set definition identifier.	fieldsetId	True	string	The field set definition identifier.
The field definition identifier.	fieldId	True	string	The field definition identifier.
fieldId	fieldId		string
fieldsetId	fieldsetId		string
dcv	dcv		string
name	name		string
icon	icon		string

Returns

Body

IField

Update relationshiplist field from topic

Operation ID:

UpdateRelationshipListField

Updates a specific single value relationshiplist field by field and fieldset identifier for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The field set definition identifier.	fieldsetId	True	string	The field set definition identifier.
The field definition identifier.	fieldId	True	string	The field definition identifier.
fieldId	fieldId		string
fieldsetId	fieldsetId		string
data	data		object

Returns

Body

IField

Update text field from topic

Operation ID:

UpdateTextSingleField

Updates a specific single value text field by field and fieldset identifier for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The field set definition identifier.	fieldsetId	True	string	The field set definition identifier.
The field definition identifier.	fieldId	True	string	The field definition identifier.
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		string

Returns

Body

IField

Updates a multivalue hyperlink field

Operation ID:

UpdateMultiHyperlinkField

Updates a multi value hyperlink field for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The fieldset identifier.	fieldsetId	True	string	The fieldset identifier.
The field identifier.	fieldId	True	string	The field identifier.
data	data		array of string

Returns

Body

IField

Updates a singlevalue hyperlink field

Operation ID:

UpdateSingleHyperlinkField

Updates a single value hyperlink field for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
The fieldset identifier.	fieldsetId	True	string	The fieldset identifier.
The field identifier.	fieldId	True	string	The field identifier.
data	data		string

Returns

Body

IField

Updates the fields from topic

Operation ID:

UpdateFields

Updates multiple types of fields for a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The topic identifier.	topicId	True	string	The topic identifier.
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		string
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		array of string
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		integer
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		array of integer
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		boolean
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		double
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		array of double
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		date-time
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		array of date-time
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		object
options	options		object
fieldId	fieldId		string
fieldsetId	fieldsetId		string
dcv	dcv		string
name	name		string
icon	icon		string
fieldId	fieldId		string
fieldsetId	fieldsetId		string
dcv	dcv		string
name	name		string
icon	icon		string
fieldId	fieldId		string
fieldsetId	fieldsetId		string
data	data		object
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		uri
fieldsetId	fieldsetId		string
fieldId	fieldId		string
setOrder	setOrder		integer
order	order		integer
topicId	topicId		string
setName	setName		string
fieldName	fieldName		string
fieldValueType	fieldValueType		string
required	required		boolean
readonly	readonly		boolean
usage	usage		string
dcv	dcv		string
name	name		string
icon	icon		string
openLocation	openLocation		string
data	data		array of uri

Returns

Body

IField

Updates the name of the topic

Operation ID:

UpdateTopic

Updates the name of a specific topic.

Parameters

Name	Key	Required	Type	Description
The Mavim database identifier.	dbId	True	uuid	The Mavim database identifier.
The Topic language.	dataLanguage	True	string	The Topic language.
The Topic identifier.	topicId	True	string	The Topic identifier.
name	name		string	Gets or sets the title

Returns

Body

ITopic

Definitions

CategoryType

string

FieldType

string

IChart

Name	Path	Type	Description
dcv	dcv	string
name	name	string

IField

Name	Path	Type	Description
fieldsetId	fieldsetId	string
fieldId	fieldId	string
setOrder	setOrder	integer
order	order	integer
setName	setName	string
fieldName	fieldName	string
topicId	topicId	string
fieldValueType	fieldValueType	FieldType
required	required	boolean
readonly	readonly	boolean
usage	usage	string
relationshipCategory	relationshipCategory	IRelationshipElement
characteristic	characteristic	IRelationshipElement
openLocation	openLocation	string

IPathItem

Name	Path	Type	Description
order	order	integer
dcvId	dcvId	string

IRelationship

Name	Path	Type	Description
dcv	dcv	string
isTypeOfTopic	isTypeOfTopic	boolean
category	category	string
categoryType	categoryType	CategoryType
relationshipType	relationshipType	RelationshipType
icon	icon	string
userInstruction	userInstruction	IRelationshipElement
dispatchInstructions	dispatchInstructions	array of ISimpleDispatchInstruction
characteristic	characteristic	IRelationshipElement
withElement	withElement	IRelationshipElement
withElementParent	withElementParent	IRelationshipElement

IRelationshipElement

Name	Path	Type	Description
dcv	dcv	string
name	name	string
icon	icon	string

ISimpleDispatchInstruction

Name	Path	Type	Description
typeName	typeName	string
dcv	dcv	string
name	name	string
icon	icon	string

ITopic

Name	Path	Type	Description
dcv	dcv	string
parent	parent	string
hasChildren	hasChildren	boolean
name	name	string
typeCategory	typeCategory	TopicType
icon	icon	string
orderNumber	orderNumber	integer
resources	resources	array of TopicResource
isInRecycleBin	isInRecycleBin	boolean
business	business	ITopicBusiness

ITopicBusiness

Name	Path	Type	Description
isReadOnly	isReadOnly	boolean
canDelete	canDelete	boolean
canCreateChildTopic	canCreateChildTopic	boolean
canCreateTopicAfter	canCreateTopicAfter	boolean

ITopicPath

Name	Path	Type	Description
path	path	array of IPathItem
data	data	array of ITopic

RelationshipType

string

TopicResource

string

TopicType

string

string

This is the basic data type 'string'.

object

This is the type 'object'.