Mavim Intelligent Xformation (Vorschau)
Die Integration von Mavim in Microsoft Power Platform ermöglicht eine nahtlose Interaktion zwischen den Prozessmanagement- und Transformationsfunktionen von Mavim mit dem Power Platform-Ökosystem. Benutzer können benutzerdefinierte Lösungen entwickeln, erweiterte Prozessbewertungen durchführen und von fundierten Berichtsdaten profitieren. Dadurch können Benutzer Workflows automatisieren, auf Prozesserkenntnisse zugreifen und Daten zwischen Mavim und Anwendungen wie Azure DevOps, Teams, Dataverse, Entra, ServiceNow, Jira, Workday usw. synchronisieren.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Service | Klasse | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Standard | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: - Azure Government Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Mavim servicedesk |
| URL | https://my.mavim.com |
| E‑Mail | servicedesk@mavim.com |
| Connectormetadaten | |
|---|---|
| Publisher | Mavim B.V |
| Website | https://www.mavim.com/ |
| Datenschutzrichtlinie | https://trustcenter.mavim.com/ |
| Kategorien | Unternehmensführung; Zusammenarbeit |
| Website | https://www.mavim.com/ |
| Datenschutzrichtlinie | https://trustcenter.mavim.com/ |
| Kategorien | Unternehmensführung; Zusammenarbeit |
| Website | https://www.mavim.com/ |
| Datenschutzrichtlinie | https://trustcenter.mavim.com/ |
| Kategorien | Unternehmensführung; Zusammenarbeit |
| Website | https://www.mavim.com/ |
| Datenschutzrichtlinie | https://trustcenter.mavim.com/ |
| Kategorien | Unternehmensführung; Zusammenarbeit |
Mavim Power Platform Connector
Übersicht
Der Mavim Power Platform Connector ermöglicht eine nahtlose Integration zwischen den Prozessmanagement- und Transformationsfunktionen von Mavim und dem Microsoft Power Platform Ökosystem. Mit diesem Connector können Benutzer Workflows automatisieren, auf Prozesserkenntnisse zugreifen und Daten zwischen Mavim und Anwendungen wie Azure DevOps, Teams, Dataverse, Entra, ServiceNow, Jira, Workday usw. synchronisieren.
Voraussetzungen
Stellen Sie vor der Verwendung dieses Connectors sicher, dass die folgenden Voraussetzungen erfüllt sind:
-
Lizenzierung:
- Sie müssen eine Lizenz für das Mavim Manager-Produkt mit mindestens einer Professional-Lizenz erworben haben.
- Sie müssen eine Lizenz für das Mavim iMprove-Produkt mit mindestens einer Professional-Lizenz erworben haben.
-
Datenbankzugriff:
- Sie benötigen Zugriff und die erforderlichen Berechtigungen für eine Mavim-Datenbank.
-
Unternehmensanwendungen:
Der Connector verwendet die OAuth-Authentifizierung. Sie müssen mindestens zwei Enterprise-Anwendungen aus dem Microsoft Katalog installieren:
- Mavim Cloud Enterprise Platform
- Mavim Power Platform Connector
Authentifizierung
Dieser Connector verwendet OAuth 2.0 für die Authentifizierung. Stellen Sie sicher, dass die erforderlichen Enterprise-Anwendungen in Ihrem Azure Entra installiert und konfiguriert sind.
Connectorfunktionen
- Abrufen, Hinzufügen, Aktualisieren und Löschen von Prozess- und Themendaten
- Abrufen detaillierter Informationen zu Prozessen und Themen im Zusammenhang mit Prozessen
- Abrufen und Aktualisieren von Prozessdokumentationen, Diagrammen und Beschreibungen
- Feldverwaltung: Hinzufügen, Aktualisieren und Löschen von Feldern eines Themas oder Prozesses und Verwalten (Hinzufügen, Aktualisieren, Löschen) von Beziehungen zwischen Themen oder zwischen Themen von Prozessen
- Zugreifen auf und Verwalten von Berichten, Überwachungsprotokollen und Systemprotokollen
- Integration in externe Systeme wie Dynamics 365, Infor, SAP und SharePoint
Schlüsselvorgänge
- Prozess- und Themenmanagement: Abrufen von Informationen zu Prozessen und Themen, Hinzufügen neuer Themen, Aktualisieren vorhandener Themen und Löschen von Themen oder prozessbezogenen Daten
- Prozessdokumentation: Abrufen und Aktualisieren von Prozessdokumenten, Diagrammen und Beschreibungen
- Feldverwaltung: Hinzufügen, Aktualisieren und Löschen von Feldern eines Themas oder Prozesses; Hinzufügen, Aktualisieren und Löschen von Beziehungen von Themen oder zwischen Themen von Prozessen
- Berichte: Zugreifen auf strukturierte und flache Berichte für Prozessthemen
- Überwachungsprotokolle: Abrufen von Überwachungspfadprotokollen für Themen
- External Connections: Integration mit Dynamics 365, Infor, SAP und SharePoint
Fehlerbehandlung
Der Connector gibt standardmäßige HTTP-Statuscodes zurück, um den Erfolg oder Fehler eines Vorgangs anzugeben. Häufige Fehlercodes sind:
-
400 Bad Request: Ungültige Eingabe oder Parameter -
401 Unauthorized: Fehler bei der Authentifizierung oder fehlender Authentifizierung -
403 Forbidden: Unzureichende Berechtigungen -
404 Not Found: Ressource nicht gefunden -
500 Internal Server Error: Unerwarteter Serverfehler
Support
Wenden Sie sich für den Support an den Mavim Service Desk:
- E-Mail:servicedesk@mavim.com
- Website:https://my.mavim.com
Eine Verbindung wird erstellt
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| Mavim Power Connector-Lizenzschlüssel | securestring | Mavim Power Connector-Lizenzschlüssel | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen aller Felder (flach) für ein Thema |
Gibt eine Liste von Feldern für das Thema zurück, das durch "topicId" im Repository mit einem optionalen benutzerdefinierten Trennzeichen für mehrwertige Felder angegeben wird, muss eine eindeutige ID sein (z. B. d0c123v456) |
| Abrufen der INFOR-Verbindungs-URL |
Gibt die Infor-Verbindungs-URL für das Thema und die Verbindung "TopicId" und "inforConnectionId" zurück, muss eindeutige Bezeichner sein (z. B. d0c123v456) |
| Abrufen Dynamics 365 Verbindungs-URL |
Gibt die Dynamics 365 Verbindungs-URL für das Thema und die Verbindung "TopicId" und "d365ConnectionId" zurück( z. B. d0c123v456) |
| Abrufen eines Felds eines Themas |
Gibt das feld zurück, das durch fieldId innerhalb der fieldset fieldsetId für das Thema und repository topicId, fieldsetId und fieldId angegeben werden muss eindeutiger Bezeichner (z. B. d0c123v456) |
| Abrufen von Berichten für ein Thema |
Gibt alle Berichte für das thema zurück, das durch "topicId" in der Repository topicId angegeben ist, muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Abrufen von Berichtsdaten für ein Thema(flach) |
Gibt flache Berichtsdaten für "topicId" und "reportId" zurück. Beide müssen eindeutige Bezeichner sein (z. B. d0c123v456) Unterstützt Paginierung und Sprachauswahl. |
| Abrufen von Beziehungsmerkmalen |
Gibt eine Auflistung von Merkmalen für die durch relationId im Repository angegebene Beziehung zurück. Die relationId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Abrufen von Diagramminhalten |
Gibt Diagramminhalte für das Thema und das Diagramm zurück, das durch "topicId" und "chartId" im Repository "topicId" und "chartId" angegeben ist, muss eindeutige Bezeichner sein (z. B. d0c123v456) Unterstützt die Cachesteuerung über den Quellabfrageparameter. |
| ABRUFEN von SAP-Verbindungsdetails |
Gibt die SAP-Verbindungsdetails für das Thema und die Verbindung "TopicId" und "sapConnectionId" zurück, müssen eindeutige Bezeichner sein (z. B. d0c123v456) |
| Abrufen von Themen, die nach Code oder Typ gefiltert werden |
Ruft Themen ab, die von einem bestimmten Code oder Typ innerhalb des durch repositoryId angegebenen Repositorys identifiziert werden. Der Code ist ein Themencode, und der Typ bezieht sich auf den Thementyp. Die Paginierung wird mithilfe von Seiten und Grenzwerten unterstützt. |
| Abrufen von Themen mit den angegebenen topid-IDs |
Ruft mehrere Themenressourcen für die bereitgestellten Themenbezeichner im Repository ab, das durch "repositoryId" identifiziert wird, muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Abrufen von Überwachungsprotokollen |
Gibt Überwachungsprotokolle für das thema zurück, das durch topicId im Repository angegeben wird. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) Unterstützt das Filtern nach Protokoll-ID, Bereich und Sprache. |
| Aktualisieren von Feldwerten |
Aktualisiert die Werte mehrerer Felder für das thema, das durch "topicId" im Repository angegeben wird. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Alle Felder auflisten |
Gibt alle Fieldsets aus dem Repository zurück, das durch repositoryId angegeben wurde. |
| Alle Symbole auflisten |
Gibt benutzerdefinierte Symbole und Systemsymbole aus dem Repository zurück, das durch repositoryId angegeben wird. |
| Auflisten von Merkmalen nach Beziehungstyp |
Gibt Merkmale für den angegebenen RelationshipType aus dem repository zurück, das durch repositoryId angegeben wird. |
| Beschreibung abrufen (nur Nur-Text) |
Gibt die Beschreibung des Themas zurück, das durch "topicId" in der Repository topicId angegeben ist, muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) Das Format kann Nur-Text oder HTML sein. |
| Beschreibung aktualisieren (nur Nur-Text) |
Aktualisiert die Nur-Text-Beschreibung des Themas, das durch "topicId" in der Repository topicId angegeben wird, muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Beziehung erstellen |
Erstellt eine Beziehung zwischen zwei Themen mit einem angegebenen Typ The topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Beziehung löschen |
Löscht die Beziehung zwischen zwei Themen The topicId and relationId must be unique identifiers (z.B. d0c123v456) |
| Beziehungen abrufen |
Gibt alle Beziehungen zurück, die dem Thema zugeordnet sind. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Beziehungseigenschaft aktualisieren |
Aktualisiert die angegebene Eigenschaft einer Beziehung Die topicId und relationId müssen eindeutige Bezeichner sein (z. B. d0c123v456) |
| Beziehungskategorien auflisten |
Gibt die vom System definierten Beziehungskategoriethemen (Who, Where, WithWhat, When, WhereTo) aus dem repository zurück, das durch repositoryId angegeben wird. |
| Erstellte Versionen auflisten |
Gibt alle erstellten Versionen aus dem repository zurück, das durch repositoryId angegeben wurde. |
| Leerer Papierkorb |
Löscht alle Themen aus dem Papierkorb im Repository, das durch repositoryId angegeben wird. |
| Listenbeschreibungsvorlagen |
Gibt Themenbeschreibungsvorlagen aus dem repository zurück, das durch repositoryId angegeben wurde. |
| Stammthema abrufen |
Gibt die Stammthemaressource für das repository zurück, das durch repositoryId identifiziert wurde. |
| Symbol abrufen |
Gibt ein benutzerdefiniertes Symbol oder ein Systemsymbol nach iconId aus dem repository zurück, das durch repositoryId angegeben wird. |
| Symbole nach Thementyp auflisten |
Gibt Symbole für den angegebenen topicType aus dem durch repositoryId angegebenen Repository zurück. |
| Thema "Gleichgeordnetes Erstellen" |
Erstellt ein Thema auf der gleichen hierarchischen Ebene wie das angegebene Referenzthema The topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) Der Anforderungstext muss den Themennamen, den Typ und das Symbol enthalten. |
| Thema abrufen |
Ruft die Themenressource ab, die durch "topicId" im Repository angegeben ist. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Thema aktualisieren |
Aktualisiert die von "topicId" identifizierte Themenressource im Repository, das durch repositoryId identifiziert wird. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Thema einfügen |
Fügt das Thema als gleichgeordnetes Element oder auf einer anderen Ebene relativ zum Referenzthema ein. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Thema löschen |
Löscht das Thema aus dem angegebenen Repository. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456). Der Vorgang ist unumkehrbar. |
| Themendiagramme auflisten |
Gibt alle Diagramme zurück, die mit dem Thema verknüpft sind, das durch "topicId" im Repository angegeben ist. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Themenkinder abrufen |
Ruft die unmittelbaren untergeordneten Themen für das Thema ab, das durch "topicId" im Repository angegeben wird. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Themenpfad zum Stamm abrufen |
Ruft den Pfad aus dem durch "topicId" angegebenen Thema zum Stammthema im Repository ab. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Thementypen auflisten |
Gibt alle verfügbaren Thementypen im Repository zurück, das durch repositoryId angegeben ist. |
| Untergeordnete Thementypen auflisten |
Gibt Typen des untergeordneten Themas zurück, das durch topicType aus dem durch repositoryId angegebenen Repository identifiziert wird. |
| Untergeordnetes Thema erstellen |
Erstellt ein Thema direkt unter dem angegebenen Referenzthema in der Hierarchie.The topicId must be a unique identifier (z.B. d0c123v456) The request body must include the topic name, type, and icon |
| Verschieben des Themas an eine neue Position |
Verschiebt das durch "topicId" angegebene Thema an die position, die durch movePosition im Repository definiert wird. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Verschieben des Themas zu einem neuen übergeordneten Element |
Verschiebt das durch "topicId" angegebene Thema in ein neues übergeordnetes Thema im Repository Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
| Versionsdefinitionen auflisten | <param name="repositoryId">Unique identifier of the repository</param> Returns all version definitions from the repository specified by repositoryId |
| Wiederherstellen eines gelöschten Themas aus dem Papierkorb |
Stellt das durch "topicId" angegebene Thema aus dem Papierkorb im Repository wieder her. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) |
Abrufen aller Felder (flach) für ein Thema
Gibt eine Liste von Feldern für das Thema zurück, das durch "topicId" im Repository mit einem optionalen benutzerdefinierten Trennzeichen für mehrwertige Felder angegeben wird, muss eine eindeutige ID sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
X-Trennzeichen
|
X-Separator | string |
X-Separator (Das benutzerdefinierte Trennzeichen, das als Trennzeichen verwendet wird, um die Mehrfachwerte zu trennen) |
|
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- array of FieldData
Abrufen der INFOR-Verbindungs-URL
Gibt die Infor-Verbindungs-URL für das Thema und die Verbindung "TopicId" und "inforConnectionId" zurück, muss eindeutige Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Infor Connection Id
|
inforConnectionId | True | string |
Infor Connection ID (Eindeutiger Bezeichner der Verbindung (z. B. d0c123v456)) |
|
Repository-ID
|
repositoryId | True | string |
Repository-ID (Die Datenbank-ID, zu der das Thema gehört) |
Gibt zurück
Infor Connection Information
- Körper
- InforConnectionInfo
Abrufen Dynamics 365 Verbindungs-URL
Gibt die Dynamics 365 Verbindungs-URL für das Thema und die Verbindung "TopicId" und "d365ConnectionId" zurück( z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
D365Connection-ID
|
d365ConnectionId | True | string |
D365Connection Id (Eindeutiger Bezeichner der Verbindung (z. B. d0c123v456)) |
|
Repository-ID
|
repositoryId | True | string |
Repository-ID (Die Datenbank-ID, zu der das Thema gehört) |
Gibt zurück
Dynamics 365 Verbindungsinformationen
- Körper
- D365ConnectionInfo
Abrufen eines Felds eines Themas
Gibt das feld zurück, das durch fieldId innerhalb der fieldset fieldsetId für das Thema und repository topicId, fieldsetId und fieldId angegeben werden muss eindeutiger Bezeichner (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Fieldset-ID
|
fieldsetId | True | string |
Fieldset-ID (Eindeutiger Bezeichner des Fieldsets (z. B. d0c123v456)) |
|
Feld-ID
|
fieldId | True | string |
Feld-ID (Eindeutiger Bezeichner des Felds (z. B. d0c123v456)) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- Körper
- Field
Abrufen von Berichten für ein Thema
Gibt alle Berichte für das thema zurück, das durch "topicId" in der Repository topicId angegeben ist, muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Datensprache
|
dataLanguage | string |
Data Language (Sprachcode für zurückgegebene Berichte (z. B. "en", "nl")) |
Gibt zurück
- response
- array of LinkedReports
Abrufen von Berichtsdaten für ein Thema(flach)
Gibt flache Berichtsdaten für "topicId" und "reportId" zurück. Beide müssen eindeutige Bezeichner sein (z. B. d0c123v456) Unterstützt Paginierung und Sprachauswahl.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Berichts-ID
|
reportId | True | string |
Berichts-ID (Eindeutiger Bezeichner des Berichts (z. B. d0c123v456)) |
|
Start von
|
startFrom | integer |
Start von (Startindex für Datensätze (optional)) |
|
|
Seitenlänge
|
pageLength | integer |
Seitenlänge (Anzahl der abzurufenden Datensätze (optional)) |
|
|
Datensprache
|
dataLanguage | string |
Data Language (Sprachcode für zurückgegebenen Bericht (z. B. "en", "nl")) |
Gibt zurück
- Körper
- FlatReport
Abrufen von Beziehungsmerkmalen
Gibt eine Auflistung von Merkmalen für die durch relationId im Repository angegebene Beziehung zurück. Die relationId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Die Datenbank-ID, zu der das Thema gehört) |
|
Beziehungs-ID
|
relationId | True | string |
Beziehungs-ID (Eindeutiger Bezeichner der Beziehung (z. B. d0c123v456)) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- array of RelationCharacteristic
Abrufen von Diagramminhalten
Gibt Diagramminhalte für das Thema und das Diagramm zurück, das durch "topicId" und "chartId" im Repository "topicId" und "chartId" angegeben ist, muss eindeutige Bezeichner sein (z. B. d0c123v456) Unterstützt die Cachesteuerung über den Quellabfrageparameter.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID () |
|
Diagramm-ID
|
chartId | True | string |
Diagramm-ID () |
|
Quelle
|
source | string |
Quelle (Steuert das Cacheverhalten (optional)) |
|
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- binary
ABRUFEN von SAP-Verbindungsdetails
Gibt die SAP-Verbindungsdetails für das Thema und die Verbindung "TopicId" und "sapConnectionId" zurück, müssen eindeutige Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Sap-Verbindungs-ID
|
sapConnectionId | True | string |
Sap Connection ID (Eindeutiger Bezeichner der Verbindung (z. B. d0c123v456)) |
|
Repository-ID
|
repositoryId | True | string |
Repository-ID (Die Datenbank-ID, zu der das Thema gehört) |
Gibt zurück
SAP-Verbindung
- Körper
- SAPConnectionInfo
Abrufen von Themen, die nach Code oder Typ gefiltert werden
Ruft Themen ab, die von einem bestimmten Code oder Typ innerhalb des durch repositoryId angegebenen Repositorys identifiziert werden. Der Code ist ein Themencode, und der Typ bezieht sich auf den Thementyp. Die Paginierung wird mithilfe von Seiten und Grenzwerten unterstützt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Code
|
code | string |
Code (Themencode) |
|
|
Typ
|
type | string |
Typ (Thementyp. Verweisen auf TopicType für zulässige Werte) |
|
|
Seite
|
page | integer |
Seite (Gibt an, welche Seite von Ergebnissen abgerufen werden soll (beginnend mit 1)) |
|
|
Begrenzung
|
limit | integer |
Limit (Definiert die maximale Anzahl von Elementen, die pro Seite zurückgegeben werden sollen) |
|
|
Repository-ID
|
repositoryId | True | string |
Repository-ID (Die Datenbank-ID, zu der das Thema gehört) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- array of Topic
Abrufen von Themen mit den angegebenen topid-IDs
Ruft mehrere Themenressourcen für die bereitgestellten Themenbezeichner im Repository ab, das durch "repositoryId" identifiziert wird, muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Berechtigungen einschließen
|
includePermissions | boolean |
Berechtigungen einschließen (zusätzliche Daten einschließen, z. B. "Berechtigungen") |
|
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
|
|
Werte
|
values | array of string |
Values (Represents a list of topic id's.) |
Gibt zurück
- response
- array of Topic
Abrufen von Überwachungsprotokollen
Gibt Überwachungsprotokolle für das thema zurück, das durch topicId im Repository angegeben wird. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) Unterstützt das Filtern nach Protokoll-ID, Bereich und Sprache.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Die Datenbank-ID, zu der das Thema gehört) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Protokoll-ID
|
logId | integer |
Protokoll-ID (Startprotokoll-ID für Paginierung (optional)) |
|
|
Bereich
|
range | integer |
Bereich (Anzahl der abzurufenden Überwachungsprotokolleinträge (optional)) |
|
|
Datensprache
|
dataLanguage | string |
Data Language (Sprachcode für zurückgegebene Protokolle (z. B. "en", "nl")) |
Gibt zurück
- response
- array of AuditLog
Aktualisieren von Feldwerten
Aktualisiert die Werte mehrerer Felder für das thema, das durch "topicId" im Repository angegeben wird. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
|
|
Fieldset-ID
|
fieldsetId | string |
Fieldset-ID (Die ID des Felds, zu dem das Feld gehört.) |
|
|
ID
|
id | string |
ID (Die ID, die ein Feld eindeutig identifiziert.) |
|
|
Wert
|
value |
Wert (Feldwert, der durch Typ Mavim.Processes.Api.v2.Dtos.Fields.FieldInfo.Type angegeben ist Verwendungsbeispiele: Geben Sie für ein Textfeld eine Zeichenfolge als Wert an. Beispiel: "Beispielwert" Geben Sie für ein Hyperlinkfeld eine URL-Zeichenfolge als Wert an. Beispiel: "https://www.mavim.com" Geben Sie für ein Zahlen- oder Dezimalfeld eine Zahl als Wert an. Beispiel: 1 oder 1.1 Geben Sie für ein boolesches Feld "true" oder "false" als Wert an. Beispiel: true Für ein Datumsfeld geben Sie datumsformatierte Zeichenfolge in ISO 8601 als Wert an. Beispiel: "2025-12-01" Wählen Sie für ein Listenfeld einen Eintrag aus der Optionseigenschaft des Felds als Wert aus. Beispiel: { "Element-ID" : "Elementname" } Geben Sie für ein Beziehungsfeld eine topicId als Wert und Struktur an, wie hier gezeigt. Beispiel: { "id": "d5926266c381v0" } Wählen Sie für ein Beziehungslistenfeld eine topicId aus der Optionseigenschaft des Felds als Wert und Struktur aus, wie hier gezeigt. Beispiel: { "id": "d5926266c381v0" } Geben Sie für ein Dateifeld ein Objekt mit einem Dateinamen und einem base64-codierten Dateiinhalt an. Beispiel: { "name": "sample.txt", "content": "U2FtcGxlIGNvbnRlbnQ=" } Geben Sie für ein mehrwertiges Textfeld ein Array von Zeichenfolgen als Wert an. Beispiel: ["Eintrag 1", "Eintrag 2"] Geben Sie für ein mehrwertiges Zahlen-/Dezimalfeld ein Array von Zahlen als Wert an. Beispiel: [1, 2] Geben Sie für ein mehrwertiges Datumsfeld ein Array von ISO 8601-formatierten Zeichenfolgen als Wert an. Beispiel: ["2025-12-01", "2025-12-02"] Geben Sie für ein mehrwertiges Hyperlinkfeld ein Array von URL-Zeichenfolgen als Wert an. Beispiel: ["https://www.mavim.com", "https://www.mavim.com/about"] Geben Sie für ein mehrwertiges Beziehungsfeld ein Array von Beziehungsobjekten als Wert an, und geben Sie an, ob ein Element hinzugefügt/aktualisiert/gelöscht oder keine Aktion ausgeführt werden soll. Beispiel: [ { "id": "d5926266c381v0", "isAdded": "false", "isUpdated": "false", "isDeleted": "false" }, //No action to be taken on this item { "id": "d5926266c382v0", "isAdded": "false", "isUpdated": "true", "isDeleted": "false" }, //Dieses Element wird von der bereitgestellten ID aktualisiert. { "id": "d59266c383v0", "isAdded": "false", "isUpdated": "false", "isDeleted": "true" }, //Das Element wird gelöscht. { "id": "d5926266c384v0", "isAdded": "true", "isUpdated": "false", "isDeleted": "false" }, //Das Element wird hinzugefügt. ] Geben Sie für ein mehrwertiges Dateifeld ein Array von Dateiobjekten als Wert an, und geben Sie an, ob ein Element hinzugefügt/aktualisiert/gelöscht oder keine Aktion ausgeführt werden soll. Beispiel: [ { "id": "d5926266c381v0", "isAdded": "false", "isUpdated": "false", "isDeleted": "false" }, //No action to be taken on this item. Beachten Sie, dass die ID eine vorhandene Datei eindeutig identifiziert. { "id": "d5926266c382v0", "name": "UpdatedFile.txt", "content": "U2FtcGxlIGNvbnRlbnQgMg==", "isAdded": "false", "isUpdated": "true", "isDeleted": "false" }, //Dieses Element wird von der bereitgestellten ID aktualisiert. { "id": "d59266c383v0", "isAdded": "false", "isUpdated": "false", "isDeleted": "true" }, //Das Element wird gelöscht. { "name": "sample.txt", "content": "U2FtcGxlIGNvbnRlbnQ=", "isAdded": "true", "isUpdated": "false", "isDeleted": "false" }, //Das Element wird hinzugefügt. Die ID wird generiert, sobald die Anforderung verarbeitet wird. ]) |
||
|
Typ
|
type | string |
Typ (FieldType, der angibt, welcher Datentyp in der Data-Eigenschaft enthalten ist) |
Alle Felder auflisten
Gibt alle Fieldsets aus dem Repository zurück, das durch repositoryId angegeben wurde.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- array of FieldsetInfo
Alle Symbole auflisten
Gibt benutzerdefinierte Symbole und Systemsymbole aus dem Repository zurück, das durch repositoryId angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ausschließen
|
exclude | string |
Ausschließen (Ausschließen von System- oder benutzerdefinierten Symbolen ("System" oder "benutzerdefiniert")) |
|
|
With
|
with | string |
Mit (Zusätzliche Daten einschließen, z. B. "Inhalt") |
|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- array of IconInfo
Auflisten von Merkmalen nach Beziehungstyp
Gibt Merkmale für den angegebenen RelationshipType aus dem repository zurück, das durch repositoryId angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Beziehungstyp
|
relationshipType | True | string |
Beziehungstyp (Der Beziehungstyp) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- array of RelationshipCharacteristic
Beschreibung abrufen (nur Nur-Text)
Gibt die Beschreibung des Themas zurück, das durch "topicId" in der Repository topicId angegeben ist, muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) Das Format kann Nur-Text oder HTML sein.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Quelle
|
source | string |
Quelle (Steuert das Cacheverhalten (optional)) |
|
|
Format
|
format | string |
Format (Format der Beschreibung. Zulässige Werte: Plain, Html) |
|
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- binary
Beschreibung aktualisieren (nur Nur-Text)
Aktualisiert die Nur-Text-Beschreibung des Themas, das durch "topicId" in der Repository topicId angegeben wird, muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
|
|
Beschreibung
|
description | string |
Beschreibung (Beschreibung des Themas) |
Beziehung erstellen
Erstellt eine Beziehung zwischen zwei Themen mit einem angegebenen Typ The topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Zur Themen-ID
|
toTopicId | string |
To Topic ID (The topic to which relationship is created. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)) |
|
|
Beziehungsart
|
relationType | string |
Beziehungstyp (Der Typ der Beziehung) |
|
|
Merkmals-ID
|
characteristicId | string |
Merkmals-ID (Die ID des Beziehungsmerkmals) |
Gibt zurück
Stellt einen Beziehungsbezeichner dar.
- Körper
- RelationshipId
Beziehung löschen
Löscht die Beziehung zwischen zwei Themen The topicId and relationId must be unique identifiers (z.B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Beziehungs-ID
|
relationId | True | string |
Beziehungs-ID (Eindeutiger Bezeichner der Beziehung (z. B. d0c123v456)) |
Beziehungen abrufen
Gibt alle Beziehungen zurück, die dem Thema zugeordnet sind. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Respositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
Gibt zurück
- response
- array of Relation
Beziehungseigenschaft aktualisieren
Aktualisiert die angegebene Eigenschaft einer Beziehung Die topicId und relationId müssen eindeutige Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Beziehungs-ID
|
relationId | True | string |
Beziehungs-ID (Eindeutiger Bezeichner der Beziehung (z. B. d0c123v456)) |
|
ID
|
id | string |
ID (Die ID der Relation-Eigenschaft, der die Beziehung zugeordnet werden soll.) |
|
|
Name
|
name | string |
Name (Represents the property of the relation that is being updated.) |
Beziehungskategorien auflisten
Gibt die vom System definierten Beziehungskategoriethemen (Who, Where, WithWhat, When, WhereTo) aus dem repository zurück, das durch repositoryId angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- array of Topic
Erstellte Versionen auflisten
Gibt alle erstellten Versionen aus dem repository zurück, das durch repositoryId angegeben wurde.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- array of CreatedVersion
Leerer Papierkorb
Löscht alle Themen aus dem Papierkorb im Repository, das durch repositoryId angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Listenbeschreibungsvorlagen
Gibt Themenbeschreibungsvorlagen aus dem repository zurück, das durch repositoryId angegeben wurde.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Thementyp
|
topicType | string |
Thementyp (Name des Thementyps) |
|
|
Themensymbol
|
topicIcon | string |
Themensymbol (Name des Themensymbols) |
|
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- array of DescriptionTemplate
Stammthema abrufen
Gibt die Stammthemaressource für das repository zurück, das durch repositoryId identifiziert wurde.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
Stellt eine Themenressource in der Mavim-API dar.
- Körper
- Topic
Symbol abrufen
Gibt ein benutzerdefiniertes Symbol oder ein Systemsymbol nach iconId aus dem repository zurück, das durch repositoryId angegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Symbol-ID
|
iconId | True | string |
Symbol-ID (Eindeutiger Symbolbezeichner) |
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- Körper
- IconInfo
Symbole nach Thementyp auflisten
Gibt Symbole für den angegebenen topicType aus dem durch repositoryId angegebenen Repository zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID () |
|
Thementyp
|
topicType | True | string |
Thementyp (Der Typ des Themas) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- object
Thema "Gleichgeordnetes Erstellen"
Erstellt ein Thema auf der gleichen hierarchischen Ebene wie das angegebene Referenzthema The topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456) Der Anforderungstext muss den Themennamen, den Typ und das Symbol enthalten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Referenzthemas (z. B. d0c123v456)) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
|
|
Name
|
name | True | string |
Name (Bezieht sich auf den Namen des zu erstellenden Themas.) |
|
Typ
|
type | string |
Typ (bezieht sich auf den Typ, von dem das erstellte Thema sein soll.) |
|
|
Ikone
|
icon | string |
Symbol (Bezieht sich auf die Symbolressourcen-ID, die für dieses Thema festgelegt werden soll.) |
|
|
Vorlage anwenden
|
applyTemplate | boolean |
Vorlage anwenden (bezieht sich darauf, ob der Benutzer eine Vorlage anwenden möchte oder nicht für dieses Thema.) |
Gibt zurück
Stellt einen Themenbezeichner dar.
- Körper
- TopicId
Thema abrufen
Ruft die Themenressource ab, die durch "topicId" im Repository angegeben ist. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Respositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
Stellt eine Themenressource in der Mavim-API dar.
- Körper
- Topic
Thema aktualisieren
Aktualisiert die von "topicId" identifizierte Themenressource im Repository, das durch repositoryId identifiziert wird. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
|
|
Name
|
name | string |
Name (Der Name des Themas.) |
|
|
Code
|
code | string |
Code (Der Code des Themas.) |
|
|
Bestellnummer
|
orderNumber | integer |
Order Number (The order of the topic among its siblings.) |
|
|
Typ
|
type | string |
Typ (Der Typ des Themas.) |
Thema einfügen
Fügt das Thema als gleichgeordnetes Element oder auf einer anderen Ebene relativ zum Referenzthema ein. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Position einfügen
|
pastePosition | string |
Position einfügen (Position zum Einfügen des Themas. Wenn nicht angegeben, ist die Standardposition unter) |
|
|
Referenzthema-ID
|
referenceTopicId | string |
Referenzthema-ID (The topic ID related to which the target topic will be pasted) |
|
|
Einschließen von Fieldsets
|
includeFieldsets | boolean |
Include Fieldsets (Controls whether to copy field set assignments from original topic) |
Gibt zurück
- response
- string
Thema löschen
Löscht das Thema aus dem angegebenen Repository. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456). Der Vorgang ist unumkehrbar.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
Themendiagramme auflisten
Gibt alle Diagramme zurück, die mit dem Thema verknüpft sind, das durch "topicId" im Repository angegeben ist. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Repository-ID
|
repositoryId | True | string |
Repository-ID (Die Datenbank-ID, zu der das Thema gehört) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- array of Chart
Themenkinder abrufen
Ruft die unmittelbaren untergeordneten Themen für das Thema ab, das durch "topicId" im Repository angegeben wird. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Respositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- array of Topic
Themenpfad zum Stamm abrufen
Ruft den Pfad aus dem durch "topicId" angegebenen Thema zum Stammthema im Repository ab. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- Körper
- TopicPath
Thementypen auflisten
Gibt alle verfügbaren Thementypen im Repository zurück, das durch repositoryId angegeben ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- object
Untergeordnete Thementypen auflisten
Gibt Typen des untergeordneten Themas zurück, das durch topicType aus dem durch repositoryId angegebenen Repository identifiziert wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID () |
|
Thementyp
|
topicType | True | string |
Thementyp (Name des Thementyps) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- array of TopicTypeInfo
Untergeordnetes Thema erstellen
Erstellt ein Thema direkt unter dem angegebenen Referenzthema in der Hierarchie.The topicId must be a unique identifier (z.B. d0c123v456) The request body must include the topic name, type, and icon
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
|
|
Name
|
name | True | string |
Name (Bezieht sich auf den Namen des zu erstellenden Themas.) |
|
Typ
|
type | string |
Typ (bezieht sich auf den Typ, von dem das erstellte Thema sein soll.) |
|
|
Ikone
|
icon | string |
Symbol (Bezieht sich auf die Symbolressourcen-ID, die für dieses Thema festgelegt werden soll.) |
|
|
Vorlage anwenden
|
applyTemplate | boolean |
Vorlage anwenden (bezieht sich darauf, ob der Benutzer eine Vorlage anwenden möchte oder nicht für dieses Thema.) |
Gibt zurück
Stellt einen Themenbezeichner dar.
- Körper
- TopicId
Verschieben des Themas an eine neue Position
Verschiebt das durch "topicId" angegebene Thema an die position, die durch movePosition im Repository definiert wird. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Position verschieben
|
movePosition | string |
Position verschieben (Position, um das Thema zu verschieben. Wenn nicht angegeben, ist die Standardposition oben) |
Verschieben des Themas zu einem neuen übergeordneten Element
Verschiebt das durch "topicId" angegebene Thema in ein neues übergeordnetes Thema im Repository Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Die Datenbank-ID, zu der das Thema gehört) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
|
Übergeordnete Themen-ID
|
parentTopicId | True | string |
Übergeordnete Themen-ID (Ruft die übergeordnete Themen-ID ab oder legt sie fest) |
Versionsdefinitionen auflisten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID () |
|
Datensprache
|
dataLanguage | string |
Datensprache (zu verwendende Datensprache. Wird standardmäßig englisch (en) angegeben.) |
Gibt zurück
- response
- array of VersionDefinition
Wiederherstellen eines gelöschten Themas aus dem Papierkorb
Stellt das durch "topicId" angegebene Thema aus dem Papierkorb im Repository wieder her. Die topicId muss ein eindeutiger Bezeichner sein (z. B. d0c123v456)
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Repository-ID
|
repositoryId | True | uuid |
Repository-ID (Eindeutiger Bezeichner des Repositorys) |
|
Themen-ID
|
topicId | True | string |
Themen-ID (Eindeutiger Bezeichner des Themas (z. B. d0c123v456)) |
Gibt zurück
WiederhergestellteTopicInfo
- Körper
- RestoredTopicInfo
Definitionen
ApprovalWorkflowInfo
Stellt Genehmigungskonfigurationseinstellungen dar, einschließlich der Aktivierung der Genehmigung und des Zeitraums, in dem die Genehmigung umgangen werden kann.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ist Genehmigungsworkflow aktiviert
|
isApprovalWorkflowEnabled | boolean | |
|
Umgehung von
|
bypassFrom | time | |
|
Umgehung an
|
bypassTo | time |
Diagramm
Stellt die Diagramm-ID und den Namen dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
ID (Diagramm-ID) |
|
Name
|
name | string |
Name (Diagrammname) |
D365ConnectionInfo
Dynamics 365 Verbindungsinformationen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
URL
|
url | string |
URL (Die URL der Dynamics 365-Verbindung.) |
Feld
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
ID (Die ID, die ein Feld eindeutig identifiziert.) |
|
Name
|
name | string |
Name (Der Name des Felds.) |
|
Typ
|
type | string |
Typ (Eine ganze Zahl, die den Typ des im Feld unterstützten Werts darstellt.) |
|
Wert
|
value |
Wert (Feldwert, der durch Typ Mavim.Processes.Api.v2.Dtos.Fields.Field.Type angegeben ist) |
|
|
Bestellung
|
order | integer |
Reihenfolge (Die Reihenfolge des Felds im Fieldset.) |
|
Options
|
options |
Optionen (Ruft Optionen ab, die der Liste zugeordnet sind.) |
|
|
Ist erforderlich
|
isRequired | boolean |
Is Required (Ein boolescher Wert, der angibt, ob ein Wert erforderlich ist) |
|
Ist schreibgeschützt
|
isReadOnly | boolean |
Ist schreibgeschützt (ein boolescher Wert, der angibt, ob das Feld schreibgeschützt ist) |
|
Ist mehrzeilige
|
isMultiLine | boolean |
Ist eine mehrzeilige Linie (ein boolescher Wert, der angibt, ob das Feld mehrzeilige Ist) |
|
Verwendung
|
usage | string |
Verwendung (Ruft die Verwendung ab oder legt sie fest; gilt nur für Listenfelder) |
|
Speicherort öffnen
|
openLocation | string |
Open Location (Contains the ID of a topic to expand in the tree navigation panel for selection.) |
FieldData
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Feld-ID
|
fieldId | string |
Feld-ID (Die ID, die ein Feld eindeutig identifiziert.) |
|
Fieldset-ID
|
fieldsetId | string |
Fieldset-ID (Die Fieldset-ID, zu der das Feld gehört.) |
|
Themen-ID
|
topicId | string |
Themen-ID (Die Themen-ID, zu der das Feld gehört.) |
|
Typ
|
type | string |
Typ (Eine ganze Zahl, die den Typ des im Feld unterstützten Werts darstellt.) |
|
Wert
|
value |
Wert (Feldwert, der durch Typ Mavim.Processes.Api.v2.Dtos.Fields.FieldData.Type angegeben ist) |
|
|
Zeichenfolgenwert
|
stringValue |
Zeichenfolgenwert (Durch Typ Mavim.Processes.Api.v2.Dtos.Fields.FieldData.Type angegebener Zeichenfolgenfeldwert) |
|
|
Feldsatzname
|
fieldsetName | string |
Fieldset Name (Der Name des Fieldset.) |
|
Name
|
name | string |
Name (Der Name des Felds.) |
|
Feldsatzreihenfolge
|
fieldsetOrder | integer |
Fieldset Order (The order of the fieldset relative to fieldsets in the requested topic.) |
|
Bestellung
|
order | integer |
Reihenfolge (Die Reihenfolge des Felds im Fieldset.) |
|
Options
|
options |
Optionen (Ruft Optionen ab, die der Liste zugeordnet sind.) |
|
|
Erforderlich
|
required | boolean |
Erforderlich (boolescher Wert, der angibt, ob ein Wert erforderlich ist) |
|
Nur Leseberechtigung
|
readOnly | boolean |
Schreibgeschützt (ein boolescher Wert, der angibt, ob das Feld schreibgeschützt ist) |
|
Ist mehrzeilige
|
isMultiLine | boolean |
Ist eine mehrzeilige Linie (ein boolescher Wert, der angibt, ob das Feld mehrzeilige Ist) |
|
Verwendung
|
usage | string |
Verwendung (Ruft die Verwendung ab oder legt sie fest; gilt nur für Listenfelder) |
|
Speicherort öffnen
|
openLocation | string |
Open Location (Contains the ID of a topic to expand in the tree navigation panel for selection.) |
|
Fieldset-Berechtigung
|
fieldsetPermission | string |
Fieldset Permission (Eine ganze Zahl, die den Typ der Berechtigung des Felds darstellt, zu dem dieses Feld gehört.) |
FieldRelation
Represents a field relation
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
ID (Beziehungs-ID) |
|
Name
|
name | string |
Name (Beziehungskategoriename) |
|
Ikone
|
icon | string |
Symbol (Die Ressourcen-ID des Symbols) |
|
Id des benutzerdefinierten Symbols
|
customIconId | string |
Benutzerdefinierte Symbol-ID (benutzerdefinierte Symbol-ID) |
InforConnectionInfo
Infor Connection Information
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
URL
|
url | string |
URL (Die URL der Infor-Verbindung.) |
Beziehung
Stellt eine Mavim-Beziehung dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
ID (Der eindeutige Beziehungsbezeichner) |
|
Ist Typ des Themas
|
isTypeOfTopic | boolean |
Is Type Of Topic (Specifies whether it is a type of topic and not an entity like Report) |
|
Kategorietyp
|
categoryType | string |
Kategorietyp (Der Kategorietyp, unter dem diese Beziehung gehört.) |
|
Typ
|
type | string |
Typ (Die Beziehungskategorie, zu der die Beziehung gehört. (Die 6 Ws)) |
|
Ikone
|
icon | string |
Symbol (Die Ressourcen-ID des Beziehungskategoriesymbols) |
|
Merkmal
|
characteristic | RelationCharacteristic |
Stellt eine Beziehungseigenschaft dar. |
|
withTopic
|
withTopic | WithTopic |
Represents a Relationship element |
|
withParentTopic
|
withParentTopic | FieldRelation |
Represents a field relation |
|
Ist Feldbeziehung
|
isFieldRelation | boolean |
Is Field Relation (Indicates whether the relation is specified in a field of a topic) |
RelationCharacteristik
Stellt eine Beziehungseigenschaft dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
ID (Merkmals-ID) |
|
Name
|
name | string |
Name (Merkmalsname) |
|
Ikone
|
icon | string |
Symbol (Systemsymbol) |
|
Id des benutzerdefinierten Symbols
|
customIconId | string |
Benutzerdefinierte Symbol-ID (benutzerdefinierte Symbol-ID) |
Beziehungs-ID
Stellt einen Beziehungsbezeichner dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | string |
WiederhergestellteTopicInfo
WiederhergestellteTopicInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Übergeordnete Themen-ID
|
parentTopicId | string | |
|
Themenreihenfolgenummer
|
topicOrderNumber | integer |
SAPConnectionInfo
SAP-Verbindung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Title
|
title | string |
Titel (Der Titel der SAP-Verbindung.) |
|
System
|
system | string |
System (Das System der SAP-Verbindung.) |
|
Transaktions-ID
|
transactionId | string |
Transaktions-ID (Die TransactionId der SAP-Verbindung.) |
|
Kunde
|
client | string |
Client (Der Client der SAP-Verbindung.) |
|
Sprache
|
language | string |
Sprache (Die Sprache der SAP-Verbindung.) |
Thema
Stellt eine Themenressource in der Mavim-API dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
ID (Eindeutiger Bezeichner für das Thema im Format dcv (z. B. d0c12v345)) |
|
Übergeordnete Themen-ID
|
parentTopicId | string |
Übergeordnete Themen-ID (Eindeutiger Bezeichner für das übergeordnete Thema im Format dcv (z. B. d0c12v345)) |
|
Quellthema-ID
|
sourceTopicId | string |
Quellthema-ID (Eindeutiger Bezeichner für das Quellthema im Format dcv (z. B. d0c12v345)) |
|
Id des benutzerdefinierten Symbols
|
customIconId | string |
Benutzerdefinierte Symbol-ID (eindeutiger Bezeichner für das benutzerdefinierte Symbol, das dem Thema zugeordnet ist, falls vorhanden) |
|
Name
|
name | string |
Name (Name des Themas) |
|
Typ
|
type | string |
Typ (Typ des Themas) |
|
Hat Kinder
|
hasChildren | boolean |
Hat Untergeordnete Elemente (Gibt an, ob das Thema untergeordnete Themen enthält) |
|
Ikone
|
icon | string |
Symbol (Dem Thema zugeordnetes Symbol) |
|
Code
|
code | string |
Code (Code des Themas) |
|
Bestellnummer
|
orderNumber | integer |
Bestellnummer (Reihenfolge des Themas zwischen den gleichgeordneten Elemente) |
|
Hat Diagramm
|
hasChart | boolean |
Has Chart (Indicates whether the topic has an associated chart) |
|
Hat Beschreibung
|
hasDescription | boolean |
Has Description (Indicates whether the topic has a description) |
|
Hat Felder
|
hasFields | boolean |
Hat Felder (Gibt an, ob das Thema Felder enthält) |
|
Hat Beziehungen
|
hasRelations | boolean |
Hat Beziehungen (Gibt an, ob das Thema Beziehungen hat) |
|
Hat Bericht
|
hasReport | boolean |
Has Report (Indicates whether the topic has an associated report) |
|
Enthält Unterthemen
|
hasSubTopics | boolean |
Enthält Unterthemen (Gibt an, ob das Thema Unterthemen enthält) |
|
Enthält externe Links
|
hasExternalLinks | boolean |
Enthält externe Links (Gibt an, ob das Thema über externe Links verfügt) |
|
Befindet sich im Papierkorb
|
isInRecycleBin | boolean |
Befindet sich im Papierkorb (Gibt an, ob sich das Thema im Papierkorb befindet) |
|
Erlaubnisse
|
permissions | TopicPermissions |
Vorgänge, die von einem Thema unterstützt werden. Enthält auch nützliche Metadaten zum Thema. Beispiel: Ob das Thema schreibgeschützt ist, ob es gelöscht werden kann usw. |
|
Themenberechtigungstyp
|
topicPermissionType | string |
Themenberechtigungstyp (Berechtigungsstufe des API-Benutzers für das Thema. Mögliche Werte: None, View, Read, Write) |
|
approvalWorkflowInfo
|
approvalWorkflowInfo | ApprovalWorkflowInfo |
Stellt Genehmigungskonfigurationseinstellungen dar, einschließlich der Aktivierung der Genehmigung und des Zeitraums, in dem die Genehmigung umgangen werden kann. |
|
Versionstyp
|
versionType | string |
Versionstyp (Versionstyp des Themas) |
|
Standardwerte
|
defaults | TopicDefaults |
Stellt die Standardoptionen zum Erstellen untergeordneter und gleichgeordneter Themen dar. |
|
Datum der letzten Mutation
|
lastMutationDate | date-time |
Datum der letzten Mutation (Datum der letzten Mutation) |
TopicDefaultIcon
Stellt das Standardsymbol zum Erstellen eines Themas dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
ID (Standardsymbol für das zu erstellende Thema.) |
|
Anzeigename
|
displayName | string |
Anzeigename (Der Anzeigename des Standardsymbols) |
|
Id des benutzerdefinierten Symbols
|
customIconId | string |
Benutzerdefinierte Symbol-ID (Standardsymbol für das zu erstellende Thema, wenn das Symbol auf "benutzerdefiniert" festgelegt ist.) |
TopicDefaultOptions
Stellt die Standardoptionen zum Erstellen eines Themas dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Hat Systemname
|
hasSystemName | boolean |
Hat Systemname (Gibt zurück, wenn der Thementitel ein Systemname ist, der vom Benutzer nicht bearbeitet werden kann.) |
|
Typ
|
type | TopicDefaultType |
Stellt den Standardtyp zum Erstellen eines Themas dar. |
|
Ikone
|
icon | TopicDefaultIcon |
Stellt das Standardsymbol zum Erstellen eines Themas dar. |
TopicDefaultType
Stellt den Standardtyp zum Erstellen eines Themas dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
ID (Standardtyp für das zu erstellende Thema.) |
|
Anzeigename
|
displayName | string |
Anzeigename (Der Anzeigename des Standardtyps) |
|
Ikone
|
icon | string |
Symbol (Das Symbol des Standardtyps) |
TopicDefaults
Stellt die Standardoptionen zum Erstellen untergeordneter und gleichgeordneter Themen dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
child
|
child | TopicDefaultOptions |
Stellt die Standardoptionen zum Erstellen eines Themas dar. |
|
Nextsibling
|
nextSibling | TopicDefaultOptions |
Stellt die Standardoptionen zum Erstellen eines Themas dar. |
TopicId
Stellt einen Themenbezeichner dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | string |
TopicInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Themen-ID
|
topicId | string |
Themen-ID (Die ID des Themas) |
|
Bestellung
|
order | integer |
Reihenfolge (Reihenfolge des Themas entlang des Pfads zum Stamm) |
TopicPath
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Pfad zu Stammthema-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.) |
|
Pfad zu Stammthemadetails
|
pathToRootTopicDetails | array of Topic |
Pfad zu Stammthemadetails (Listet alle im Pfad erwähnten Themendaten zusammen mit den unmittelbaren untergeordneten Elementen auf.) |
TopicPermissions
Vorgänge, die von einem Thema unterstützt werden. Enthält auch nützliche Metadaten zum Thema. Beispiel: Ob das Thema schreibgeschützt ist, ob es gelöscht werden kann usw.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ist Thema schreibgeschützt
|
isTopicReadOnly | boolean |
Ist Thema schreibgeschützt (Gibt zurück, ob das Thema grundsätzlich schreibgeschützt ist.) |
|
Ist schreibgeschützt
|
isReadOnly | boolean |
Ist schreibgeschützt (Gibt zurück, ob das Thema für den anfordernden Benutzer schreibgeschützt ist.) |
|
Untergeordnetes Thema erstellen
|
canCreateChildTopic | boolean |
Kann untergeordnetes Thema erstellen (Gibt zurück, ob das Thema neue untergeordnete Themen unter sich selbst erstellen kann.) |
|
Thema kann nach dem Erstellen eines Themas erstellt werden
|
canCreateTopicAfter | boolean |
Kann Thema danach erstellen (Gibt zurück, ob das Thema nach sich selbst ein neues gleichgeordnetes Thema erstellen kann.) |
|
Kann bearbeiten
|
canEdit | boolean |
Kann bearbeiten (Gibt zurück, ob das Thema bearbeitet werden kann) |
|
Kann kopieren
|
canCopy | boolean |
Kann kopieren (Gibt zurück, ob das Thema kopiert werden kann) |
|
Kann löschen
|
canDelete | boolean |
Kann löschen (Gibt zurück, ob das Thema gelöscht werden kann.) |
|
Rückgängigmachen des Löschens
|
canUndoDelete | boolean |
Kann Löschen rückgängigmachen (Gibt zurück, ob das Thema aus dem Papierkorb wiederhergestellt werden kann.) |
WithTopic
Represents a Relationship element
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
ID (Beziehungs-ID) |
|
Name
|
name | string |
Name (Beziehungskategoriename) |
|
Ikone
|
icon | string |
Symbol (Die Ressourcen-ID des Symbols) |
|
Id des benutzerdefinierten Symbols
|
customIconId | string |
Benutzerdefinierte Symbol-ID (benutzerdefinierte Symbol-ID) |
CreatedVersion
Stellt eine erstellte Version dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Versions-ID
|
versionId | string | |
|
Versionsname
|
versionName | string | |
|
Aktive Datensprachen
|
activeDataLanguages | array of string |
DescriptionTemplate
Beschreibungsvorlage
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Benutzer außer Kraft setzen
|
userOverridable | boolean |
Benutzerüberschreibbar (Gibt an, ob der Benutzer die Vorlageneinstellungen außer Kraft setzen kann.) |
|
Themensymbol
|
topicIcon | object |
Themensymbol (Symboldetails, die der Themenvorlage zugeordnet sind.) |
|
Thementyp
|
topicType | string |
Thementyp (Typ der Themenvorlage.) |
|
Vorlage beim Erstellen anwenden
|
applyTemplateOnCreate | boolean |
Vorlage beim Erstellen anwenden (Gibt an, ob die Vorlage beim Erstellen eines neuen Themas angewendet werden soll.) |
FieldsetInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Fieldset-ID
|
fieldsetId | string |
Fieldset-ID (Die ID des Felds, zu dem das Feld gehört.) |
|
Feldsatzname
|
fieldsetName | string |
Fieldset Name (Der Name des Fieldset.) |
IconInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Typ
|
type | string |
RelationshipCharacteristic
Represents a Relationship element
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
ID (Merkmals-ID) |
|
Name
|
name | string |
Name (Merkmalsname) |
|
Ikone
|
icon | string |
Symbol (Die Ressourcen-ID des Symbols) |
|
Id des benutzerdefinierten Symbols
|
customIconId | string |
Benutzerdefinierte Symbol-ID (benutzerdefinierte Symbol-ID) |
TopicTypeInfo
Informationen zum Typ eines Themas
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Thementyp-ID
|
topicTypeId | uuid |
Thementyp-ID (ID des Thementyps) |
|
Thematypname
|
topicTypeName | string |
Name des Thematyps (Name des Thementyps) |
|
Ist Systemthema
|
isSystemTopic | boolean |
Ist Systemthema (Gibt an, ob dies ein Systemthematyp ist) |
|
Symbol-ID
|
iconId | string |
Symbol-ID (ID des Symbols) |
|
Thementyp
|
topicType | string |
Thementyp (Der Typ des Themas) |
VersionDefinition
Stellt eine Versionsdefinition dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
ID (Die ID der Versionsdefinition) |
|
Name
|
name | string |
Name (Der Name der Versionsdefinition) |
AuditLog
Antwort für das Überwachungsprotokoll
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
ID (Die ID des Protokolleintrags) |
|
Themen-ID
|
topicId | string |
Themen-ID (Die DCV-ID des Themas) |
|
Sprache
|
language | string |
Sprache (Die Datensprache dieses Überwachungsprotokolleintrags.) |
|
Ereignistyp
|
eventType | string |
Ereignistyp (Der Typ des Überwachungsereignisses. Sie kann auf eine Titeländerung, eine Feldaktualisierung oder eine Änderung der Beziehung hinweisen.) |
|
Zeitstempel
|
timeStamp | date-time |
Zeitstempel (Der Zeitstempel, zu dem das Ereignis stattgefunden hat.) |
|
Geändert durch
|
changedBy | string |
Geändert von (Die E-Mail des Benutzers, der die Änderung vorgenommen hat.) |
|
Einzelheiten
|
details | string |
Details (Enthält unterschiedliche Werte basierend auf unterschiedlichem EventType. Wenn es sich bei dem Ereignistyp um ein Feld handelt, weist diese Eigenschaft den Feldnamen auf. Wenn der Ereignistyp eine Beziehung ist, weist diese Eigenschaft den Beziehungstyp auf.) |
|
Details Extra
|
detailsExtra | string |
Details Extra (Enthält unterschiedliche Werte basierend auf unterschiedlichem EventType. Wenn es sich bei dem Ereignistyp um ein Feld handelt, hat diese Eigenschaft den Namen des Fieldset. Für andere Ereignistypen wird dieses Feld ab sofort nicht verwendet.) |
|
Objekttyp
|
objectType | string |
Objekttyp (Zeigt den Objekttyp des Ereignisses) |
|
oldValue
|
oldValue | Changes | |
|
newValue
|
newValue | Changes | |
|
Alles aus Protokoll
|
allFromLog | boolean |
Alle aus dem Protokoll (Gibt an, ob alle Entitätsnamen aus dem Überwachungsprotokoll abgerufen werden, oder einige werden aus dem neuesten Status abgerufen, da das Überwachungsprotokoll nicht verfügbar war.) |
Änderungen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
parent
|
parent | Parent | |
|
relationshipDetails
|
relationshipDetails | RelationshipDetails | |
|
Themaname
|
topicName | string | |
|
Thementyp
|
topicType | string | |
|
Themensymbol
|
topicIcon | string | |
|
Bestellnummer
|
orderNumber | string | |
|
Einzelheiten
|
details | string | |
|
Details Extra
|
detailsExtra | string | |
|
Werte
|
values | array of string | |
|
Beziehungs-ID
|
relationId | string | |
|
Aus Themen-ID
|
fromTopicId | string | |
|
Aus Themenname
|
fromTopicName | string | |
|
Zur Themen-ID
|
toTopicId | string | |
|
Zum Themanamen
|
toTopicName | string | |
|
Beziehungsart
|
relationType | string |
FlatReport
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Flache Berichts-ID
|
flatReportId | integer | |
|
Themen-ID
|
topicId | string | |
|
Title
|
title | string | |
|
Ergebniszeilenanzahl
|
totalRowCount | integer | |
|
Inhalt
|
content | FlatReportContent |
FlatReportContent
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Rows
|
rows | array of object | |
|
Elemente
|
rows | object |
LinkedReports
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Verknüpfte Berichts-ID
|
linkedReportId | string | |
|
Name des verknüpften Berichts
|
linkedReportName | string |
Eltern
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Themen-ID
|
topicId | string | |
|
Themaname
|
topicName | string |
Beziehungsdetails
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Themen-ID
|
topicId | string | |
|
Themaname
|
topicName | string | |
|
Thementyp
|
topicType | string | |
|
Themensymbol
|
topicIcon | string | |
|
Bestellnummer
|
orderNumber | string |
binär
Dies ist der grundlegende Datentyp „binär“.
Objekt
Dies ist der Typ „Objekt“.
Schnur
Dies ist der grundlegende Datentyp "string".