Mavim Intelligent Xformation (Preview)
Mavim's integration with Microsoft Power Platform enables seamless interaction between Mavim's process management and transformation capabilities with Power Platform ecosystem. Users can develop custom solutions, perform advanced process assessments, and benefit from insightful reporting data. This empowers users to automate workflows, access process insights, and synchronize data between Mavim and applications such as Azure DevOps, Teams, Dataverse, Entra, ServiceNow, Jira, Workday, and more
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | 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) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - 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) |
| 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) |
| Contact | |
|---|---|
| Name | Mavim servicedesk |
| URL | https://my.mavim.com |
| servicedesk@mavim.com |
| Connector Metadata | |
|---|---|
| Publisher | Mavim B.V |
| Website | https://www.mavim.com/ |
| Privacy policy | https://trustcenter.mavim.com/ |
| Categories | Business Management;Collaboration |
| Website | https://www.mavim.com/ |
| Privacy policy | https://trustcenter.mavim.com/ |
| Categories | Business Management;Collaboration |
| Website | https://www.mavim.com/ |
| Privacy policy | https://trustcenter.mavim.com/ |
| Categories | Business Management;Collaboration |
| Website | https://www.mavim.com/ |
| Privacy policy | https://trustcenter.mavim.com/ |
| Categories | Business Management;Collaboration |
Mavim Power Platform Connector
Overview
The Mavim Power Platform Connector enables seamless integration between Mavim’s process management and transformation capabilities and the Microsoft Power Platform ecosystem. This connector allows users to automate workflows, access process insights, and synchronize data between Mavim and applications such as Azure DevOps, Teams, Dataverse, Entra, ServiceNow, Jira, Workday, and more.
Prerequisites
Before using this connector, ensure the following prerequisites are met:
- Licensing:
- You must have purchased a license for the Mavim Manager product with at least one Professional license.
- You must have purchased a license for the Mavim iMprove product with at least one Professional license.
- Database Access:
- You must have access and the necessary permissions to a Mavim Database.
- Enterprise Applications:
The connector uses OAuth authentication. You must install at least two Enterprise Applications from the Microsoft Gallery:
- Mavim Cloud Enterprise Platform
- Mavim Power Platform Connector
Authentication
This connector uses OAuth 2.0 for authentication. Ensure the required Enterprise Applications are installed and configured in your Azure Entra.
Connector Capabilities
- Retrieve, add, update, and delete process and topic data
- Get detailed information about processes and topics related to processes
- Retrieve and update process documentation, charts, and descriptions
- Field management: add, update, and delete fields of a topic or process, and manage (add, update, delete) relationships between topics or between topics of processes
- Access and manage reports, audit logs, and system logs
- Integrate with external systems such as Dynamics 365, Infor, SAP, and SharePoint
Key Operations
- Process and Topic Management: Get information about processes and topics, add new topics, update existing topics, and delete topics or process-related data
- Process Documentation: Retrieve and update process documents, charts, and descriptions
- Field Management: Add, update, and delete fields of a topic or process; add, update, and delete relationships of topics or between topics of processes
- Reports: Access structured and flattened reports for process topics
- Audit Logs: Retrieve audit trail logs for topics
- External Connections: Integrate with Dynamics 365, Infor, SAP, and SharePoint
Error Handling
The connector returns standard HTTP status codes to indicate the success or failure of an operation. Common error codes include:
400 Bad Request: Invalid input or parameters401 Unauthorized: Authentication failed or missing403 Forbidden: Insufficient permissions404 Not Found: Resource not found500 Internal Server Error: Unexpected server error
Support
For support, contact the Mavim Service Desk:
- Email: servicedesk@mavim.com
- Website: https://my.mavim.com
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.
| Name | Type | Description | Required |
|---|---|---|---|
| Mavim Power Connector License Key | securestring | Mavim Power Connector License Key | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Create child topic |
Creates a topic directly under the specified reference topic in the hierarchy The topicId must be a unique identifier (e.g., d0c123v456) The request body must include the topic name, type, and icon |
| Create relationship |
Creates a relation between two topics with a specified type The topicId must be a unique identifier (e.g., d0c123v456) |
| Create sibling topic |
Creates a topic at the same hierarchical level as the specified reference topic The topicId must be a unique identifier (e.g., d0c123v456) The request body must include the topic name, type, and icon |
| Delete relationship |
Deletes the relation between two topics The topicId and relationId must be unique identifiers (e.g., d0c123v456) |
| Delete topic |
Deletes the topic from the specified repository. The topicId must be a unique identifier (e.g., d0c123v456). The operation is irreversible |
| Empty recycle bin |
Deletes all topics from the recycle bin in the repository specified by repositoryId |
| Get a field of a topic |
Returns the field specified by fieldId within the fieldset fieldsetId for the topic and repository topicId, fieldsetId, and fieldId must be unique identifiers (e.g., d0c123v456) |
| Get all fields (flattened) for a topic |
Returns a list of fields for the topic specified by topicId in the repository with an optional custom separator for multi value fields topicId must be a unique identifier (e.g., d0c123v456) |
| Get audit logs |
Returns audit logs for the topic specified by topicId in the repository The topicId must be a unique identifier (e.g., d0c123v456) Supports filtering by log ID, range, and language |
| Get chart content |
Returns chart content for the topic and chart specified by topicId and chartId in the repository Both topicId and chartId must be unique identifiers (e.g., d0c123v456) Supports cache control via the source query parameter |
| Get description (plain text only) |
Returns the description of the topic specified by topicId in the repository topicId must be a unique identifier (e.g., d0c123v456) The format can be plain text or HTML |
| Get Dynamics 365 connection URL |
Returns the Dynamics 365 connection URL for the topic and connection Both topicId and d365ConnectionId must be unique identifiers (e.g., d0c123v456) |
| Get icon |
Returns a custom icon or system icon by iconId from the repository specified by repositoryId |
| Get Infor connection URL |
Returns the Infor connection URL for the topic and connection Both topicId and inforConnectionId must be unique identifiers (e.g., d0c123v456) |
| Get relationship characteristics |
Returns a collection of characteristics for the relation specified by relationId in the repository The relationId must be a unique identifier (e.g., d0c123v456) |
| Get relationships |
Returns all relations associated with the topic The topicId must be a unique identifier (e.g., d0c123v456) |
| Get report data for a topic(Flattened) |
Returns flattened report data for topicId and reportId Both must be unique identifiers (e.g., d0c123v456) Supports pagination and language selection |
| Get reports for a topic |
Returns all reports for the topic specified by topicId in the repository topicId must be a unique identifier (e.g., d0c123v456) |
| Get root topic |
Returns the root topic resource for the repository identified by repositoryId |
| Get SAP connection details |
Returns the SAP connection details for the topic and connection Both topicId and sapConnectionId must be unique identifiers (e.g., d0c123v456) |
| Get topic |
Retrieves the topic resource specified by topicId in the repository The topicId must be a unique identifier (e.g., d0c123v456) |
| Get topic children |
Retrieves the immediate child topics for the topic specified by topicId in the repository The topicId must be a unique identifier (e.g., d0c123v456) |
| Get topic path to root |
Retrieves the path from the topic specified by topicId to the root topic in the repository The topicId must be a unique identifier (e.g., d0c123v456) |
| Get topics filtered by code or type |
Retrieves topics identified by a specific code or type within the repository specified by repositoryId The code is a topic code, and type refers to the topic type. Pagination is supported using page and limit |
| Get topics with the specified topid ids |
Retrieves multiple topic resources for the provided topic identifiers in the repository identified by repositoryId Each topic identifier must be a unique identifier (e.g., d0c123v456) |
| List all fieldsets |
Returns all the fieldsets from the repository specified by repositoryId |
| List all icons |
Returns custom icons and system icons from the repository specified by repositoryId |
| List characteristics by relationship type |
Returns characteristics for the specified relationshipType from the repository specified by repositoryId |
| List child topic types |
Returns types of the children topic identified by topicType from the repository specified by repositoryId |
| List created versions |
Returns all created versions from the repository specified by repositoryId |
| List description templates |
Returns topic description templates from the repository specified by repositoryId |
| List icons by topic type |
Returns icons for the specified topicType from the repository specified by repositoryId |
| List relationship categories |
Returns the system-defined relationship category topics (Who, Where, WithWhat, When, WhereTo) from the repository specified by repositoryId |
| List topic charts |
Returns all charts linked to the topic specified by topicId within the repository The topicId must be a unique identifier (e.g., d0c123v456) |
| List topic types |
Returns all topic types available in the repository specified by repositoryId |
| List version definitions |
Returns all version definitions from the repository specified by repositoryId |
| Move topic to a new parent |
Moves the topic specified by topicId to a new parent topic in the repository The topicId must be a unique identifier (e.g., d0c123v456) |
| Move topic to a new position |
Moves the topic specified by topicId to the position defined by movePosition in the repository The topicId must be a unique identifier (e.g., d0c123v456) |
| Paste topic |
Pastes the topic as a sibling or at a different level relative to the reference topic The topicId must be a unique identifier (e.g., d0c123v456) |
| Restore deleted topic from recycle bin |
Restores the topic specified by topicId from the recycle bin in the repository The topicId must be a unique identifier (e.g., d0c123v456) |
| Update description (plain text only) |
Updates the plain text description of the topic specified by topicId in the repository topicId must be a unique identifier (e.g., d0c123v456) |
| Update field values |
Updates the values of multiple fields for the topic specified by topicId in the repository The topicId must be a unique identifier (e.g., d0c123v456) |
| Update relationship property |
Updates the specified property of a relation The topicId and relationId must be unique identifiers (e.g., d0c123v456) |
| Update topic |
Updates the topic resource identified by topicId in the repository identified by repositoryId The topicId must be a unique identifier (e.g., d0c123v456) |
Create child topic
Creates a topic directly under the specified reference topic in the hierarchy The topicId must be a unique identifier (e.g., d0c123v456) The request body must include the topic name, type, and icon
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
|
|
Name
|
name | True | string |
Name (Refers to the name of the topic that is to be created.) |
|
Type
|
type | string |
Type (Refers to the type that the created topic should be of.) |
|
|
Icon
|
icon | string |
Icon (Refers to the icon resource Id that should be set for this topic.) |
|
|
Apply Template
|
applyTemplate | boolean |
Apply Template (Refers to whether the user wants to apply template or not for this topic.) |
Returns
Represents a topic identifier.
- Body
- TopicId
Create relationship
Creates a relation between two topics with a specified type The topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
To Topic Id
|
toTopicId | string |
To Topic Id (The topic to which relationship is created. The topicId must be a unique identifier (e.g., d0c123v456)) |
|
|
Relation Type
|
relationType | string |
Relation Type (The type of the relationship) |
|
|
Characteristic Id
|
characteristicId | string |
Characteristic Id (The Id of the Relationship characteristic) |
Returns
Represents a relationship identifier.
- Body
- RelationshipId
Create sibling topic
Creates a topic at the same hierarchical level as the specified reference topic The topicId must be a unique identifier (e.g., d0c123v456) The request body must include the topic name, type, and icon
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the reference topic (e.g., d0c123v456)) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
|
|
Name
|
name | True | string |
Name (Refers to the name of the topic that is to be created.) |
|
Type
|
type | string |
Type (Refers to the type that the created topic should be of.) |
|
|
Icon
|
icon | string |
Icon (Refers to the icon resource Id that should be set for this topic.) |
|
|
Apply Template
|
applyTemplate | boolean |
Apply Template (Refers to whether the user wants to apply template or not for this topic.) |
Returns
Represents a topic identifier.
- Body
- TopicId
Delete relationship
Deletes the relation between two topics The topicId and relationId must be unique identifiers (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Relation Id
|
relationId | True | string |
Relation Id (Unique identifier of the relationship (e.g., d0c123v456)) |
Delete topic
Deletes the topic from the specified repository. The topicId must be a unique identifier (e.g., d0c123v456). The operation is irreversible
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
Empty recycle bin
Deletes all topics from the recycle bin in the repository specified by repositoryId
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Get a field of a topic
Returns the field specified by fieldId within the fieldset fieldsetId for the topic and repository topicId, fieldsetId, and fieldId must be unique identifiers (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Fieldset Id
|
fieldsetId | True | string |
Fieldset Id (Unique identifier of the fieldset (e.g., d0c123v456)) |
|
Field Id
|
fieldId | True | string |
Field Id (Unique identifier of the field (e.g., d0c123v456)) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- Body
- Field
Get all fields (flattened) for a topic
Returns a list of fields for the topic specified by topicId in the repository with an optional custom separator for multi value fields topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
X-Separator
|
X-Separator | string |
X-Separator (The custom separator used as a delimiter to separate the multi values) |
|
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- array of FieldData
Get audit logs
Returns audit logs for the topic specified by topicId in the repository The topicId must be a unique identifier (e.g., d0c123v456) Supports filtering by log ID, range, and language
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (The database Id that the topic belongs to) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Log Id
|
logId | integer |
Log Id (Starting log ID for pagination (optional)) |
|
|
Range
|
range | integer |
Range (Number of audit log entries to retrieve (optional)) |
|
|
Data Language
|
data-language | string |
Data Language (Language code for returned logs (e.g., "en", "nl")) |
Returns
- response
- array of AuditLog
Get chart content
Returns chart content for the topic and chart specified by topicId and chartId in the repository Both topicId and chartId must be unique identifiers (e.g., d0c123v456) Supports cache control via the source query parameter
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id () |
|
Chart Id
|
chartId | True | string |
Chart Id () |
|
Source
|
source | string |
Source (Controls cache behavior (optional)) |
|
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- binary
Get description (plain text only)
Returns the description of the topic specified by topicId in the repository topicId must be a unique identifier (e.g., d0c123v456) The format can be plain text or HTML
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Source
|
source | string |
Source (Controls cache behavior (optional)) |
|
|
Format
|
format | string |
Format (Format of the description. Allowed values: Plain, Html) |
|
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- binary
Get Dynamics 365 connection URL
Returns the Dynamics 365 connection URL for the topic and connection Both topicId and d365ConnectionId must be unique identifiers (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
D365Connection Id
|
d365ConnectionId | True | string |
D365Connection Id (Unique identifier of the connection (e.g., d0c123v456)) |
|
Repository Id
|
repositoryId | True | string |
Repository Id (The database Id that the topic belongs to) |
Returns
Dynamics 365 Connection Information
- Body
- D365ConnectionInfo
Get icon
Returns a custom icon or system icon by iconId from the repository specified by repositoryId
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Icon Id
|
iconId | True | string |
Icon Id (Unique icon identifier) |
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- Body
- IconInfo
Get Infor connection URL
Returns the Infor connection URL for the topic and connection Both topicId and inforConnectionId must be unique identifiers (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Infor Connection Id
|
inforConnectionId | True | string |
Infor Connection Id (Unique identifier of the connection (e.g., d0c123v456)) |
|
Repository Id
|
repositoryId | True | string |
Repository Id (The database Id that the topic belongs to) |
Returns
Infor Connection Information
- Body
- InforConnectionInfo
Get relationship characteristics
Returns a collection of characteristics for the relation specified by relationId in the repository The relationId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (The database Id that the topic belongs to) |
|
Relation Id
|
relationId | True | string |
Relation Id (Unique identifier of the relationship (e.g., d0c123v456)) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- array of RelationCharacteristic
Get relationships
Returns all relations associated with the topic The topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the respository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
Returns
- response
- array of Relation
Get report data for a topic(Flattened)
Returns flattened report data for topicId and reportId Both must be unique identifiers (e.g., d0c123v456) Supports pagination and language selection
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Report Id
|
reportId | True | string |
Report Id (Unique identifier of the report (e.g., d0c123v456)) |
|
Start From
|
startFrom | integer |
Start From (Starting index for records (optional)) |
|
|
Page Length
|
pageLength | integer |
Page Length (Number of records to retrieve (optional)) |
|
|
Data Language
|
data-language | string |
Data Language (Language code for returned report (e.g., "en", "nl")) |
Returns
- Body
- FlatReport
Get reports for a topic
Returns all reports for the topic specified by topicId in the repository topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Data Language
|
data-language | string |
Data Language (Language code for returned reports (e.g., "en", "nl")) |
Returns
- response
- array of LinkedReports
Get root topic
Returns the root topic resource for the repository identified by repositoryId
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
Represents a topic resource in the Mavim API
- Body
- Topic
Get SAP connection details
Returns the SAP connection details for the topic and connection Both topicId and sapConnectionId must be unique identifiers (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Sap Connection Id
|
sapConnectionId | True | string |
Sap Connection Id (Unique identifier of the connection (e.g., d0c123v456)) |
|
Repository Id
|
repositoryId | True | string |
Repository Id (The database Id that the topic belongs to) |
Returns
SAP connection
- Body
- SAPConnectionInfo
Get topic
Retrieves the topic resource specified by topicId in the repository The topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the respository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
Represents a topic resource in the Mavim API
- Body
- Topic
Get topic children
Retrieves the immediate child topics for the topic specified by topicId in the repository The topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the respository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- array of Topic
Get topic path to root
Retrieves the path from the topic specified by topicId to the root topic in the repository The topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- Body
- TopicPath
Get topics filtered by code or type
Retrieves topics identified by a specific code or type within the repository specified by repositoryId The code is a topic code, and type refers to the topic type. Pagination is supported using page and limit
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Code
|
code | string |
Code (Topic code) |
|
|
Type
|
type | string |
Type (Topic type. Refer to TopicType for allowed values) |
|
|
Page
|
page | integer |
Page (Specifies which page of results to retrieve (starting from 1)) |
|
|
Limit
|
limit | integer |
Limit (Defines the maximum number of items to return per page) |
|
|
Repository Id
|
repositoryId | True | string |
Repository Id (The database Id that the topic belongs to) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- array of Topic
Get topics with the specified topid ids
Retrieves multiple topic resources for the provided topic identifiers in the repository identified by repositoryId Each topic identifier must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Include Permissions
|
includePermissions | boolean |
Include Permissions (Include additional data, e.g., "permissions") |
|
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
|
|
Values
|
values | array of string |
Values (Represents a list of topic id's.) |
Returns
- response
- array of Topic
List all fieldsets
Returns all the fieldsets from the repository specified by repositoryId
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- array of FieldsetInfo
List all icons
Returns custom icons and system icons from the repository specified by repositoryId
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Exclude
|
exclude | string |
Exclude (Exclude system or custom icons ("system" or "custom")) |
|
|
With
|
with | string |
With (Include additional data, e.g., "contents") |
|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- array of IconInfo
List characteristics by relationship type
Returns characteristics for the specified relationshipType from the repository specified by repositoryId
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Relationship Type
|
relationshipType | True | string |
Relationship Type (The type of relationship) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- array of RelationshipCharacteristic
List child topic types
Returns types of the children topic identified by topicType from the repository specified by repositoryId
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Type
|
topicType | True | string |
Topic Type (Name of the topic type) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- array of TopicTypeInfo
List created versions
Returns all created versions from the repository specified by repositoryId
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- array of CreatedVersion
List description templates
Returns topic description templates from the repository specified by repositoryId
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Type
|
topicType | string |
Topic Type (Name of the topic type) |
|
|
Topic Icon
|
topicIcon | string |
Topic Icon (Name of the topic icon) |
|
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- array of DescriptionTemplate
List icons by topic type
Returns icons for the specified topicType from the repository specified by repositoryId
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Type
|
topicType | True | string |
Topic Type (The type of the topic) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- object
List relationship categories
Returns the system-defined relationship category topics (Who, Where, WithWhat, When, WhereTo) from the repository specified by repositoryId
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- array of Topic
List topic charts
Returns all charts linked to the topic specified by topicId within the repository The topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Repository Id
|
repositoryId | True | string |
Repository Id (The database Id that the topic belongs to) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- array of Chart
List topic types
Returns all topic types available in the repository specified by repositoryId
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- object
List version definitions
Returns all version definitions from the repository specified by repositoryId
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
Returns
- response
- array of VersionDefinition
Move topic to a new parent
Moves the topic specified by topicId to a new parent topic in the repository The topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (The database Id that the topic belongs to) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Parent Topic Id
|
parentTopicId | True | string |
Parent Topic Id (Gets or sets the parent topic Id) |
Move topic to a new position
Moves the topic specified by topicId to the position defined by movePosition in the repository The topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Move Position
|
movePosition | string |
Move Position (Position to move the topic to. If unspecified, the default position is top) |
Paste topic
Pastes the topic as a sibling or at a different level relative to the reference topic The topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Paste Position
|
pastePosition | string |
Paste Position (Position to paste topic. If unspecified, default position is under) |
|
|
Reference Topic Id
|
referenceTopicId | string |
Reference Topic Id (The topic Id related to which the target topic will be pasted) |
|
|
Include Fieldsets
|
includeFieldsets | boolean |
Include Fieldsets (Controls whether to copy field set assignments from original topic) |
Returns
- response
- string
Restore deleted topic from recycle bin
Restores the topic specified by topicId from the recycle bin in the repository The topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
Returns
RestoredTopicInfo
- Body
- RestoredTopicInfo
Update description (plain text only)
Updates the plain text description of the topic specified by topicId in the repository topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
|
|
Description
|
description | string |
Description (The description of the topic) |
Update field values
Updates the values of multiple fields for the topic specified by topicId in the repository The topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
|
|
Fieldset Id
|
fieldsetId | string |
Fieldset Id (The Id of the fieldset the field belongs to.) |
|
|
Id
|
id | string |
Id (The Id that uniquely identifies a field.) |
|
|
Value
|
value |
Value (Field value indicated by Type Mavim.Processes.Api.v2.Dtos.Fields.FieldInfo.Type Usage examples: For a text field, provide a string as value. Example: "Sample value" For a hyperlink field, provide a URL string as value. Example: "https://www.mavim.com" For a number or decimal field, provide a number as value. Example: 1 or 1.1 For a boolean field, provide true or false as value. Example: true For a date field, provide date in ISO 8601 formatted string as value. Example: "2025-12-01" For a list field, pick an entry from the options property of the field as value. Example: { "Item Id" : "Item name" } For a relationship field, provide a topicId as value and structure it as shown here. Example: { "id": "d5926266c381v0" } For a relationshiplist field, pick a topicId from the options property of the field as value and structure it as shown here. Example: { "id": "d5926266c381v0" } For a file field, provide an object with a file name and a base64-encoded file content. Example: { "name": "sample.txt", "content": "U2FtcGxlIGNvbnRlbnQ=" } For a multi-valued text field, provide an array of strings as value. Example: ["Entry 1", "Entry 2"] For a multi-valued number/decimal field, provide an array of numbers as value. Example: [1, 2] For a multi-valued date field, provide an array of ISO 8601 formatted strings as value. Example: ["2025-12-01", "2025-12-02"] For a multi-valued hyperlink field, provide an array of URL strings as value. Example: ["https://www.mavim.com", "https://www.mavim.com/about"] For a multi-valued relationship field, provide an array of relationship objects as value, and specify whether an item should be added/updated/deleted or no action. Example: [ { "id": "d5926266c381v0", "isAdded": "false", "isUpdated": "false", "isDeleted": "false" }, //No action to be taken on this item { "id": "d5926266c382v0", "isAdded": "false", "isUpdated": "true", "isDeleted": "false" }, //This item will be updated by the provided id. { "id": "d5926266c383v0", "isAdded": "false", "isUpdated": "false", "isDeleted": "true" }, //The item will be deleted. { "id": "d5926266c384v0", "isAdded": "true", "isUpdated": "false", "isDeleted": "false" }, //The item will be added. ] For a multi-valued file field, provide an array of file objects as value, and specify whether an item should be added/updated/deleted or no action. Example: [ { "id": "d5926266c381v0", "isAdded": "false", "isUpdated": "false", "isDeleted": "false" }, //No action to be taken on this item. Note that the ID uniquely identifies an existing file. { "id": "d5926266c382v0", "name": "UpdatedFile.txt", "content": "U2FtcGxlIGNvbnRlbnQgMg==", "isAdded": "false", "isUpdated": "true", "isDeleted": "false" }, //This item will be updated by the provided id. { "id": "d5926266c383v0", "isAdded": "false", "isUpdated": "false", "isDeleted": "true" }, //The item will be deleted. { "name": "sample.txt", "content": "U2FtcGxlIGNvbnRlbnQ=", "isAdded": "true", "isUpdated": "false", "isDeleted": "false" }, //The item will be added. ID will be generated once the request is processed. ]) |
||
|
Type
|
type | string |
Type (FieldType indicating what type of data is in the Data property) |
Update relationship property
Updates the specified property of a relation The topicId and relationId must be unique identifiers (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Relation Id
|
relationId | True | string |
Relation Id (Unique identifier of the relationship (e.g., d0c123v456)) |
|
Id
|
id | string |
Id (The Id of the Relation property to associate the relation with.) |
|
|
Name
|
name | string |
Name (Represents the property of the relation that is being updated.) |
Update topic
Updates the topic resource identified by topicId in the repository identified by repositoryId The topicId must be a unique identifier (e.g., d0c123v456)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Repository Id
|
repositoryId | True | uuid |
Repository Id (Unique identifier of the repository) |
|
Topic Id
|
topicId | True | string |
Topic Id (Unique identifier of the topic (e.g., d0c123v456)) |
|
Data Language
|
data-language | string |
Data Language (Data language to use. Defaults to English (en) if not specified.) |
|
|
Name
|
name | string |
Name (The name of the topic.) |
|
|
Code
|
code | string |
Code (The code of the topic.) |
|
|
Order Number
|
orderNumber | integer |
Order Number (The order of the topic among its siblings.) |
|
|
Type
|
type | string |
Type (The type of topic.) |
Definitions
ApprovalWorkflowInfo
Represents approval configuration settings, including whether approval is enabled and the time range during which approval can be bypassed.
| Name | Path | Type | Description |
|---|---|---|---|
|
Is Approval Workflow Enabled
|
isApprovalWorkflowEnabled | boolean | |
|
Bypass From
|
bypassFrom | time | |
|
Bypass To
|
bypassTo | time |
Chart
Represents chart Id and name
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id (Chart Id) |
|
Name
|
name | string |
Name (Chart name) |
D365ConnectionInfo
Dynamics 365 Connection Information
| Name | Path | Type | Description |
|---|---|---|---|
|
Url
|
url | string |
Url (The url of the Dynamics 365 connection.) |
Field
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id (The Id that uniquely identifies a field.) |
|
Name
|
name | string |
Name (The name of the field.) |
|
Type
|
type | string |
Type (An integer representing the type of value supported in the field.) |
|
Value
|
value |
Value (Field value indicated by Type Mavim.Processes.Api.v2.Dtos.Fields.Field.Type) |
|
|
Order
|
order | integer |
Order (The order of the field in the fieldset.) |
|
Options
|
options |
Options (Gets options associated with the list.) |
|
|
Is Required
|
isRequired | boolean |
Is Required (A boolean that indicates whether a value is necessary) |
|
Is Read Only
|
isReadOnly | boolean |
Is Read Only (A boolean that indicates whether the field is readonly) |
|
Is Multi Line
|
isMultiLine | boolean |
Is Multi Line (A boolean that indicates whether the field is multiline) |
|
Usage
|
usage | string |
Usage (Gets or sets the usage; applicable for list fields only) |
|
Open Location
|
openLocation | string |
Open Location (Contains the Id of a topic to expand in the tree navigation panel for selection.) |
FieldData
| Name | Path | Type | Description |
|---|---|---|---|
|
Field Id
|
fieldId | string |
Field Id (The Id that uniquely identifies a field.) |
|
Fieldset Id
|
fieldsetId | string |
Fieldset Id (The fieldset Id to which the field belongs to.) |
|
Topic Id
|
topicId | string |
Topic Id (The topic Id to which the field belongs to.) |
|
Type
|
type | string |
Type (An integer representing the type of value supported in the field.) |
|
Value
|
value |
Value (Field value indicated by Type Mavim.Processes.Api.v2.Dtos.Fields.FieldData.Type) |
|
|
String Value
|
stringValue |
String Value (Stringified field value indicated by Type Mavim.Processes.Api.v2.Dtos.Fields.FieldData.Type) |
|
|
Fieldset Name
|
fieldsetName | string |
Fieldset Name (The name of the fieldset.) |
|
Name
|
name | string |
Name (The name of the field.) |
|
Fieldset Order
|
fieldsetOrder | integer |
Fieldset Order (The order of the fieldset relative to fieldsets in the requested topic.) |
|
Order
|
order | integer |
Order (The order of the field in the fieldset.) |
|
Options
|
options |
Options (Gets options associated with the list.) |
|
|
Required
|
required | boolean |
Required (A boolean that indicates whether a value is necessary) |
|
Read Only
|
readOnly | boolean |
Read Only (A boolean that indicates whether the field is readonly) |
|
Is Multi Line
|
isMultiLine | boolean |
Is Multi Line (A boolean that indicates whether the field is multiline) |
|
Usage
|
usage | string |
Usage (Gets or sets the usage; applicable for list fields only) |
|
Open Location
|
openLocation | string |
Open Location (Contains the Id of a topic to expand in the tree navigation panel for selection.) |
|
Fieldset Permission
|
fieldsetPermission | string |
Fieldset Permission (An integer representing the type of permission of fieldset this field belongs to.) |
FieldRelation
Represents a field relation
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id (Relationship Id) |
|
Name
|
name | string |
Name (Relationship category name) |
|
Icon
|
icon | string |
Icon (The resource Id of the icon) |
|
Custom Icon Id
|
customIconId | string |
Custom Icon Id (Custom Icon Id) |
InforConnectionInfo
Infor Connection Information
| Name | Path | Type | Description |
|---|---|---|---|
|
Url
|
url | string |
Url (The url of the Infor connection.) |
Relation
Represents a Mavim relation.
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id (The unique Relation identifier) |
|
Is Type Of Topic
|
isTypeOfTopic | boolean |
Is Type Of Topic (Specifies whether it is a type of topic and not an entity like Report) |
|
Category Type
|
categoryType | string |
Category Type (The category type under which this relation belongs to.) |
|
Type
|
type | string |
Type (The relation category the relation belongs to. (The 6 Ws)) |
|
Icon
|
icon | string |
Icon (The resource Id of the relation category icon) |
|
characteristic
|
characteristic | RelationCharacteristic |
Represents a Relationship characteristic |
|
withTopic
|
withTopic | WithTopic |
Represents a Relationship element |
|
withParentTopic
|
withParentTopic | FieldRelation |
Represents a field relation |
|
Is Field Relation
|
isFieldRelation | boolean |
Is Field Relation (Indicates whether the relation is specified in a field of a topic) |
RelationCharacteristic
Represents a Relationship characteristic
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id (Characteristic Id) |
|
Name
|
name | string |
Name (Characteristic name) |
|
Icon
|
icon | string |
Icon (System Icon) |
|
Custom Icon Id
|
customIconId | string |
Custom Icon Id (Custom Icon Id) |
RelationshipId
Represents a relationship identifier.
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
value | string |
RestoredTopicInfo
RestoredTopicInfo
| Name | Path | Type | Description |
|---|---|---|---|
|
Parent Topic Id
|
parentTopicId | string | |
|
Topic Order Number
|
topicOrderNumber | integer |
SAPConnectionInfo
SAP connection
| Name | Path | Type | Description |
|---|---|---|---|
|
Title
|
title | string |
Title (The Title of the SAP connection.) |
|
System
|
system | string |
System (The System of the SAP connection.) |
|
Transaction Id
|
transactionId | string |
Transaction Id (The TransactionId of the SAP connection.) |
|
Client
|
client | string |
Client (The Client of the SAP connection.) |
|
Language
|
language | string |
Language (The Language of the SAP connection.) |
Topic
Represents a topic resource in the Mavim API
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id (Unique identifier for the topic, in the format dcv (e.g., d0c12v345)) |
|
Parent Topic Id
|
parentTopicId | string |
Parent Topic Id (Unique identifier for the parent topic, in the format dcv (e.g., d0c12v345)) |
|
Source Topic Id
|
sourceTopicId | string |
Source Topic Id (Unique identifier for the source topic, in the format dcv (e.g., d0c12v345)) |
|
Custom Icon Id
|
customIconId | string |
Custom Icon Id (Unique identifier for the custom icon associated with the topic, if any) |
|
Name
|
name | string |
Name (Name of the topic) |
|
Type
|
type | string |
Type (Type of the topic) |
|
Has Children
|
hasChildren | boolean |
Has Children (Indicates whether the topic has child topics) |
|
Icon
|
icon | string |
Icon (Icon associated with the topic) |
|
Code
|
code | string |
Code (Code of the topic) |
|
Order Number
|
orderNumber | integer |
Order Number (Order of the topic among its siblings) |
|
Has Chart
|
hasChart | boolean |
Has Chart (Indicates whether the topic has an associated chart) |
|
Has Description
|
hasDescription | boolean |
Has Description (Indicates whether the topic has a description) |
|
Has Fields
|
hasFields | boolean |
Has Fields (Indicates whether the topic has fields) |
|
Has Relations
|
hasRelations | boolean |
Has Relations (Indicates whether the topic has relations) |
|
Has Report
|
hasReport | boolean |
Has Report (Indicates whether the topic has an associated report) |
|
Has Sub Topics
|
hasSubTopics | boolean |
Has Sub Topics (Indicates whether the topic has subtopics) |
|
Has External Links
|
hasExternalLinks | boolean |
Has External Links (Indicates whether the topic has external links) |
|
Is In Recycle Bin
|
isInRecycleBin | boolean |
Is In Recycle Bin (Indicates whether the topic is in the recycle bin) |
|
permissions
|
permissions | TopicPermissions |
Operations supported by a topic. Also includes useful metadata about the topic. Eg: whether the topic is read-only, whether it can be deleted, etc. |
|
Topic Permission Type
|
topicPermissionType | string |
Topic Permission Type (Permission level of the API user for the topic. Possible values: None, View, Read, Write) |
|
approvalWorkflowInfo
|
approvalWorkflowInfo | ApprovalWorkflowInfo |
Represents approval configuration settings, including whether approval is enabled and the time range during which approval can be bypassed. |
|
Version Type
|
versionType | string |
Version Type (Version type of the topic) |
|
defaults
|
defaults | TopicDefaults |
Represents the default options for creating child and sibling topics |
|
Last Mutation Date
|
lastMutationDate | date-time |
Last Mutation Date (Last mutation date) |
TopicDefaultIcon
Represents the default icon for creating a topic
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id (Default icon for the topic to be created.) |
|
Display Name
|
displayName | string |
Display Name (The display name of the default icon) |
|
Custom Icon Id
|
customIconId | string |
Custom Icon Id (Default custom icon for the topic to be created if the icon is set to custom.) |
TopicDefaultOptions
Represents the default options for creating a topic
| Name | Path | Type | Description |
|---|---|---|---|
|
Has System Name
|
hasSystemName | boolean |
Has System Name (Returns if the topic title is a system name which cannot be edited by the user.) |
|
type
|
type | TopicDefaultType |
Represents the default type for creating a topic |
|
icon
|
icon | TopicDefaultIcon |
Represents the default icon for creating a topic |
TopicDefaultType
Represents the default type for creating a topic
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id (Default type for the topic to be created.) |
|
Display Name
|
displayName | string |
Display Name (The display name of the default type) |
|
Icon
|
icon | string |
Icon (The icon of the default type) |
TopicDefaults
Represents the default options for creating child and sibling topics
| Name | Path | Type | Description |
|---|---|---|---|
|
child
|
child | TopicDefaultOptions |
Represents the default options for creating a topic |
|
nextSibling
|
nextSibling | TopicDefaultOptions |
Represents the default options for creating a topic |
TopicId
Represents a topic identifier.
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
value | string |
TopicInfo
| Name | Path | Type | Description |
|---|---|---|---|
|
Topic Id
|
topicId | string |
Topic Id (The Id of the Topic) |
|
Order
|
order | integer |
Order (Order of the topic along path to root) |
TopicPath
| Name | Path | Type | Description |
|---|---|---|---|
|
Path To Root Topic Ids
|
pathToRootTopicIds | array of TopicInfo |
Path To Root Topic Ids (A property of the response that consists of a list of topic Ids, starting from the root of the Mavim database.) |
|
Path To Root Topic Details
|
pathToRootTopicDetails | array of Topic |
Path To Root Topic Details (Lists all topic data mentioned in the path, along with their immediate children.) |
TopicPermissions
Operations supported by a topic. Also includes useful metadata about the topic. Eg: whether the topic is read-only, whether it can be deleted, etc.
| Name | Path | Type | Description |
|---|---|---|---|
|
Is Topic Read Only
|
isTopicReadOnly | boolean |
Is Topic Read Only (Returns whether the topic is inherently read-only.) |
|
Is Read Only
|
isReadOnly | boolean |
Is Read Only (Returns whether the topic is read-only for the requesting user.) |
|
Can Create Child Topic
|
canCreateChildTopic | boolean |
Can Create Child Topic (Returns whether the topic can create new child topics under itself.) |
|
Can Create Topic After
|
canCreateTopicAfter | boolean |
Can Create Topic After (Returns whether the topic can create a new sibling topic after itself.) |
|
Can Edit
|
canEdit | boolean |
Can Edit (Returns whether the topic can be edited) |
|
Can Copy
|
canCopy | boolean |
Can Copy (Returns whether the topic can be copied) |
|
Can Delete
|
canDelete | boolean |
Can Delete (Returns whether the topic can be deleted.) |
|
Can Undo Delete
|
canUndoDelete | boolean |
Can Undo Delete (Returns whether the topic can be recovered from recycle bin.) |
WithTopic
Represents a Relationship element
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id (Relationship Id) |
|
Name
|
name | string |
Name (Relationship category name) |
|
Icon
|
icon | string |
Icon (The resource Id of the icon) |
|
Custom Icon Id
|
customIconId | string |
Custom Icon Id (Custom Icon Id) |
CreatedVersion
Represents a Created Version
| Name | Path | Type | Description |
|---|---|---|---|
|
Version Id
|
versionId | string | |
|
Version Name
|
versionName | string | |
|
Active Data Languages
|
activeDataLanguages | array of string |
DescriptionTemplate
Description template
| Name | Path | Type | Description |
|---|---|---|---|
|
User Overridable
|
userOverridable | boolean |
User Overridable (Specifies whether the user can override the template settings.) |
|
Topic Icon
|
topicIcon | object |
Topic Icon (Icon details associated with the topic template.) |
|
Topic Type
|
topicType | string |
Topic Type (Type of the topic template.) |
|
Apply Template On Create
|
applyTemplateOnCreate | boolean |
Apply Template On Create (Indicates whether the template should be applied while creating a new topic.) |
FieldsetInfo
| Name | Path | Type | Description |
|---|---|---|---|
|
Fieldset Id
|
fieldsetId | string |
Fieldset Id (The Id of the fieldset the field belongs to.) |
|
Fieldset Name
|
fieldsetName | string |
Fieldset Name (The name of the fieldset.) |
IconInfo
| Name | Path | Type | Description |
|---|---|---|---|
|
Type
|
type | string |
RelationshipCharacteristic
Represents a Relationship element
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id (Characteristic Id) |
|
Name
|
name | string |
Name (Characteristic name) |
|
Icon
|
icon | string |
Icon (The resource Id of the icon) |
|
Custom Icon Id
|
customIconId | string |
Custom Icon Id (Custom Icon Id) |
TopicTypeInfo
Info on type of a topic
| Name | Path | Type | Description |
|---|---|---|---|
|
Topic Type Id
|
topicTypeId | uuid |
Topic Type Id (Id of the Topic Type) |
|
Topic Type Name
|
topicTypeName | string |
Topic Type Name (Name of the Topic Type) |
|
Is System Topic
|
isSystemTopic | boolean |
Is System Topic (Indicates if this is this a System Topic Type) |
|
Icon Id
|
iconId | string |
Icon Id (Id of the icon) |
|
Topic Type
|
topicType | string |
Topic Type (The type of the Topic) |
VersionDefinition
Represents a Version Definition
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Id (The Id of the Version Definition) |
|
Name
|
name | string |
Name (The name of the Version Definition) |
AuditLog
Response for the audit log
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | integer |
Id (The ID of the log entry) |
|
Topic Id
|
topicId | string |
Topic Id (The DCV Id of the topic) |
|
Language
|
language | string |
Language (The data language of this audit log entry.) |
|
Event Type
|
eventType | string |
Event Type (The type of the audit event. It could indicate a title change, a field update, or a change in relationship.) |
|
Time Stamp
|
timeStamp | date-time |
Time Stamp (The timestamp when the event took place.) |
|
Changed By
|
changedBy | string |
Changed By (The email of the user who made the change.) |
|
Details
|
details | string |
Details (Contains different values based on varying eventType. When event type is a field, this property has the field name. When the event type is a relationship, this property has the relationship type.) |
|
Details Extra
|
detailsExtra | string |
Details Extra (Contains different values based on varying eventType. When event type is a field, this property has the fieldset name. For other event types, this field is not used as of now.) |
|
Object Type
|
objectType | string |
Object Type (Shows the Object type of the event) |
|
oldValue
|
oldValue | Changes | |
|
newValue
|
newValue | Changes | |
|
All From Log
|
allFromLog | boolean |
All From Log (Indicates whether all entity names are retrieved from audit log or some are retrieved from the latest state as audit log wasn't available.) |
Changes
| Name | Path | Type | Description |
|---|---|---|---|
|
parent
|
parent | Parent | |
|
relationshipDetails
|
relationshipDetails | RelationshipDetails | |
|
Topic Name
|
topicName | string | |
|
Topic Type
|
topicType | string | |
|
Topic Icon
|
topicIcon | string | |
|
Order Number
|
orderNumber | string | |
|
Details
|
details | string | |
|
Details Extra
|
detailsExtra | string | |
|
Values
|
values | array of string | |
|
Relation Id
|
relationId | string | |
|
From Topic Id
|
fromTopicId | string | |
|
From Topic Name
|
fromTopicName | string | |
|
To Topic Id
|
toTopicId | string | |
|
To Topic Name
|
toTopicName | string | |
|
Relation Type
|
relationType | string |
FlatReport
| Name | Path | Type | Description |
|---|---|---|---|
|
Flat Report Id
|
flatReportId | integer | |
|
Topic Id
|
topicId | string | |
|
Title
|
title | string | |
|
Total Row Count
|
totalRowCount | integer | |
|
content
|
content | FlatReportContent |
FlatReportContent
| Name | Path | Type | Description |
|---|---|---|---|
|
Rows
|
rows | array of object | |
|
items
|
rows | object |
LinkedReports
| Name | Path | Type | Description |
|---|---|---|---|
|
Linked Report Id
|
linkedReportId | string | |
|
Linked Report Name
|
linkedReportName | string |
Parent
| Name | Path | Type | Description |
|---|---|---|---|
|
Topic Id
|
topicId | string | |
|
Topic Name
|
topicName | string |
RelationshipDetails
| Name | Path | Type | Description |
|---|---|---|---|
|
Topic Id
|
topicId | string | |
|
Topic Name
|
topicName | string | |
|
Topic Type
|
topicType | string | |
|
Topic Icon
|
topicIcon | string | |
|
Order Number
|
orderNumber | string |
binary
This is the basic data type 'binary'.
object
This is the type 'object'.
string
This is the basic data type 'string'.