Zum Hauptinhalt springen
API docs by Redocly

INFOMOTION Data Management Center (2022.2)

Dokumentation der API-Endpunkte

Authentifizierung

Loggt den Anwender über OpenID ein

Request Body schema: application/json
required
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Loggt den Anwender über die gegebenen Credentials ein

Request Body schema: application/json
required
name
string
password
string
authentication
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "password": "string",
  • "authentication": "string"
}

Loggt den Anwender über die gegebenen Credentials ein

Request Body schema: application/json
required
name
string
password
string
authentication
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "password": "string",
  • "authentication": "string"
}

Gibt eine Liste an Nutzern zurück

Responses

Gibt eine UNAUTHORIZED-Antwort zurück

Responses

Gibt den Status der aktuellen Sitzung zurück

Responses

Gibt die Authentifizierungseinstellungen zurück

Responses

Meldet die aktuelle Sitzung ab

Responses

Gibt den Hashwert eines Passworts zurück

path Parameters
password
required
string

Responses

Gibt eine Liste an Gruppen zurück

Responses

Wertelisten

Gibt die Werte einer gegebenen Werteliste zurück

path Parameters
domainId
required
integer <int32>
query Parameters
filterColumnFilter
string
labelColumnFilter
string

Responses

Aktualisiert eine gegebene Werteliste

path Parameters
domainId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Löscht eine gegebene Werteliste

path Parameters
domainId
required
integer <int32>

Responses

Gibt eine Liste aller Wertelisten zurück

Responses

Fügt eine neue Werteliste hinzu

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Validiert die Syntax einer Werteliste

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Deployment-Sets Import/ Export

Validiert ein Deploymentset einer übergebenen zip-Datei

query Parameters
includeLocalObjects
boolean
Default: true
skipDdl
boolean
Default: false
allowDrop
boolean
Default: false
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Validiert ein Deploymentset in ein gegebenes Verzeichnis

query Parameters
path
required
string
includeLocalObjects
boolean
Default: true
skipDdl
boolean
Default: false
allowDrop
boolean
Default: false

Responses

Importiert ein Deploymentset einer übergebenen zip-Datei

query Parameters
skipDdl
boolean
Default: false
allowDrop
boolean
Default: false
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Importiert ein Deploymentset aus einem gegebenen Verzeichnis

query Parameters
path
required
string
skipDdl
boolean
Default: false
allowDrop
boolean
Default: false

Responses

Exportiert ein Deploymentset als eine zip-Datei

query Parameters
deploymentSetId
integer <int32>

Responses

Exportiert ein Deploymentset in ein gegebenes Verzeichnis

query Parameters
path
required
string
incremental
boolean
Default: false
deploymentSetId
integer <int32>

Responses

Tabellen

Gibt die Datensätze einer Tabelle zurück

path Parameters
tableId
required
integer <int32>
query Parameters
qsOnly
integer <int32>
sortCol
string
sortDir
string
limit
integer <int32>
page
integer <int32>
globalFilter
string
filter
string

Responses

Aktualisiert einen Datensatz einer Tabelle

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Fügt einen Datensatz einer Tabelle hinzu

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Löscht einen Datensatz einer Tabelle

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Löscht einen Datensatz einer Tabelle

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Gibt eine Liste aller Tabellen und deren Berechtigung zurück

Responses

Gibt Informationen einer Tabelle und deren Berechtigung zurück

path Parameters
tableId
required
integer <int32>

Responses

Löscht alle Datensätze einer Tabelle

path Parameters
tableId
required
integer <int32>

Responses

Gibt eine Excel-Datei der Datensätze einer Tabelle zurück

path Parameters
tableId
required
integer <int32>
query Parameters
globalFilter
string
filter
string
skipHeader
boolean

Responses

Gibt eine Excel-Datei der Datensätze einer Tabelle zu einem bestimmten Zeitpunkt zurück

path Parameters
tableId
required
integer <int32>
query Parameters
datetime
required
string
globalFilter
string
filter
string

Responses

Gibt die Datensätze einer Tabelle zu einem bestimmten Zeitpunkt zurück

path Parameters
tableId
required
integer <int32>
query Parameters
datetime
required
string
sortCol
string
sortDir
string
limit
integer <int32>
page
integer <int32>
globalFilter
string
filter
string

Responses

Gibt eine CSV-Datei der Datensätze einer Tabelle zu einem bestimmten Zeitpunkt zurück

path Parameters
tableId
required
integer <int32>
query Parameters
datetime
required
string
globalFilter
string
filter
string

Responses

Gibt die Anzahl der Datensätze einer Tabelle zu einem bestimmten Zeitpunkt zurück

path Parameters
tableId
required
integer <int32>
query Parameters
datetime
required
string
globalFilter
string
filter
string

Responses

Gibt die Anzahl der Datensätze einer Tabelle zurück

path Parameters
tableId
required
integer <int32>
query Parameters
qsOnly
integer <int32>
globalFilter
string
filter
string

Responses

Gibt eine CSV-Datei der Datensätze einer Tabelle zurück

path Parameters
tableId
required
integer <int32>
query Parameters
globalFilter
string
filter
string
skipHeader
boolean

Responses

Deployment-Sets

Fügt ein Objekt einem gegebenen Deploymentset hinzu

path Parameters
id
required
integer <int32>
type
required
string
Enum: "DOMAIN" "CATEGORY" "TABLE" "QS_RULE" "COMMAND" "DEPLOYMENT_SET"
uuid
required
string <uuid>
query Parameters
includeRequired
boolean
Default: true
includeRelated
boolean
Default: false

Responses

Fügt ein Objekt einem gegebenen Deploymentset hinzu

path Parameters
id
required
integer <int32>
type
required
string
Enum: "DOMAIN" "CATEGORY" "TABLE" "QS_RULE" "COMMAND" "DEPLOYMENT_SET"
uuid
required
string <uuid>
query Parameters
includeRequired
boolean
Default: true
includeRelated
boolean
Default: false

Responses

Löscht ein Objekt von einem gegebenen Deploymentset

path Parameters
id
required
integer <int32>
type
required
string
Enum: "DOMAIN" "CATEGORY" "TABLE" "QS_RULE" "COMMAND" "DEPLOYMENT_SET"
uuid
required
string <uuid>

Responses

Gibt ein gewähltes Deploymentset zurück

path Parameters
id
required
integer <int32>

Responses

Aktualisiert ein gegebenes Deploymentset

path Parameters
id
required
integer <int32>
Request Body schema: application/json
required
id
integer <int32>
name
string
uuid
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Löscht ein gegebenes Deploymentset

path Parameters
id
required
integer <int32>

Responses

Gibt Liste aller Deploymentsets zurück

Responses

Erstellt ein neues Deploymentset

Request Body schema: application/json
required
id
integer <int32>
name
string
uuid
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Gibt die Objekte eines gegebenen Deploymentsets zurück

path Parameters
id
required
integer <int32>
query Parameters
includeIndirect
boolean
Default: false

Responses

Schedules

Gibt Merkmale eines Schedules zurück

path Parameters
scheduleId
required
integer <int32>

Responses

Aktualisiert einen gegebenen Schedule

path Parameters
scheduleId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Löscht einen gegebenen Schedule

path Parameters
scheduleId
required
integer <int32>

Responses

Aktualisiert eine Mail-Konfiguration eines Schedules

path Parameters
scheduleId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Fügt eine Mail-Konfiguration einem Schedule hinzu

path Parameters
scheduleId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Löscht eine Mail-Konfiguration eines Schedules

path Parameters
scheduleId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Gibt Liste aller Schedules zurück

Responses

Fügt einen neuen Schedule hinzu

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Löscht eine Mail-Konfiguration eines Schedules

path Parameters
scheduleId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Gibt Mails eines Schedules zurück

path Parameters
scheduleId
required
integer <int32>

Responses

Löscht alle Mail-Konfiguration eines Schedules

path Parameters
scheduleId
required
integer <int32>

Responses

Gibt Schedules einer Tabelle zurück

path Parameters
tableId
required
integer <int32>

Responses

Version

Gibt Informationen zur verwendeten DMC-Version zurück

Responses

Response samples

Content type
application/json
"string"

QS-Regeln

Aktualisiert eine gegebene QS-Regel

path Parameters
ruleId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Löscht eine gegebene QS-Regel

path Parameters
ruleId
required
integer <int32>

Responses

Gibt alle QS-Regeln zurück

Responses

Fügt eine neue QS-Regel hinzu

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Validiert das SQL einer QS-Regeln

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Erneuert den Cache der QS-Regeln

query Parameters
waitForCompletion
boolean
Default: false

Responses

Erneuert den Cache der QS-Regeln einer Tabelle

path Parameters
tableId
required
integer <int32>
query Parameters
waitForCompletion
boolean
Default: false

Responses

Gibt den Ausführungsstatus von QS-Regeln zurück

Responses

Gibt den Ausführungsstatus von QS-Regeln zurück

path Parameters
tableId
required
integer <int32>

Responses

Gibt alle QS-Ergebnisse nach Tabelle zurück

query Parameters
waitForCompletion
boolean
Default: true

Responses

Gibt alle QS-Ergebnisse einer Tabelle zurück

path Parameters
tableId
required
integer <int32>
query Parameters
waitForCompletion
boolean
Default: true

Responses

Gibt alle QS-Ergebnisse nach Schweregrad zurück

query Parameters
waitForCompletion
boolean
Default: true

Responses

Admin

Aktualisiert die Metadaten einer gegebenen Tabelle

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Löscht eine gegebene Tabelle, wobei das Löschen auf der Datenbank übersteuert werden kann

path Parameters
tableId
required
integer <int32>
dropTableFlag
required
integer <int32>

Responses

Aktualisiert eine Spalte einer gegebenen Tabelle

path Parameters
tableId
required
integer <int32>
columnId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Löscht eine Spalte einer gegebenen Tabelle

path Parameters
tableId
required
integer <int32>
columnId
required
integer <int32>

Responses

Fügt eine Tabelle hinzu

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Aktualisiert den Cache aller Tabellen

Responses

Fügt eine neue Spalte zu einer gegebenen Tabelle hinzu

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Gibt eine Liste aller Tabellen zurück

query Parameters
repTableFlag
integer <int32>

Responses

Prüft, ob ein Tabellenname bereits in den Metadaten und den DB-Namen existiert

query Parameters
attribute
required
string
value
required
string

Responses

Gibt eine Liste an allen reservierten Begriffen zurück, welche nicht als Tabellen- oder Spaltennamen verwendet werden dürfen

Responses

Gibt eine Liste aller Spalten einer Tabelle zurück

path Parameters
untrackedTable
required
string

Responses

Löscht eine gegebene Tabelle, wobei das Löschen auf der Datenbank übersteuert werden kann

path Parameters
tableId
required
integer <int32>
dropTableFlag
required
integer <int32>

Responses

Kategorie

Gibt die Merkmale einer Kategorie zurück

path Parameters
categoryId
required
integer <int32>

Responses

Aktualisiert eine gegebene Kategorie

path Parameters
categoryId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Löscht eine gegebene Kategorie

path Parameters
categoryId
required
integer <int32>

Responses

Gibt eine Liste aller Kategorien zurück

Responses

Fügt eine neue Kategorie hinzu

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Erneuert den Cache der Kategorien

Responses

Commands

Aktualisiert einen gegebenen Command

path Parameters
commandId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Führt einen gegebenen Command aus

path Parameters
commandId
required
integer <int32>
query Parameters
waitForCompletion
boolean
Default: true

Responses

Löscht einen gegebenen Command

path Parameters
commandId
required
integer <int32>

Responses

Gibt eine Liste aller Commands zurück

Responses

Fügt ein neuen Command hinzu

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Gibt den Status einer Command-Ausführung zurück

path Parameters
tableId
required
integer <int32>

Responses

Gibt den Status einer Command-Ausführung zurück

path Parameters
tableId
required
integer <int32>
commandId
required
integer <int32>

Responses

Snapshots

Gibt alle Snapshots eines Deploymentsets zurück

path Parameters
deploymentSetId
required
integer <int32>

Responses

Erstellt einen Snapshot eines Deploymentsets

path Parameters
deploymentSetId
required
integer <int32>

Responses

Gibt einen Snapshot eines Deploymentsets zurück

path Parameters
deploymentSetId
required
integer <int32>
snapshotId
required
integer <int32>

Responses

Löscht einen Snapshot eines Deploymentsets

path Parameters
deploymentSetId
required
integer <int32>
snapshotId
required
integer <int32>

Responses

Tabellenzugriffsberechtigung

Gibt eine Liste an Berechtigung auf Tabellenebene einer Tabelle zurück

path Parameters
tableId
required
integer <int32>

Responses

Aktualisiert eine Berechtigung auf Tabellenebene einer Tabelle

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Fügt eine Berechtigung auf Tabellenebene einer Tabelle hinzu

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Löscht eine Berechtigung auf Tabellenebene einer Tabelle

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Löscht eine Berechtigung auf Tabellenebene einer Tabelle

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Aktualisiert den Cache der Berechtigungen auf Tabellenebene

Responses

Datenberechtigung

Gibt eine Liste an Berechtigung auf Datensatzebene einer Tabelle zurück

path Parameters
tableId
required
integer <int32>

Responses

Aktualisiert eine Berechtigung auf Datensatzebene einer Tabelle

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Fügt eine Berechtigung auf Datensatzebene einer Tabelle hinzu

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Löscht eine Berechtigung auf Datensatzebene einer Tabelle

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Löscht eine Berechtigung auf Datensatzebene einer Tabelle

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Aktualisiert den Cache der Berechtigungen auf Datensatzebene

Responses

Dateien

Lädt eine gegebene Datei hoch

Request Body schema: application/json
file
required
string <binary>
object (FileParserParameters)

Responses

Request samples

Content type
application/json
{
  • "file": "string",
  • "parserParameters": {
    }
}

Gibt eine Liste aller Dateien einer Tabelle zurück

path Parameters
tableId
required
integer <int32>

Responses

Setzt die Standardwerte einer Tabelle zum Import einer Datei

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
file
required
string <binary>
required
object (FileParserParameters)

Responses

Request samples

Content type
application/json
{
  • "file": "string",
  • "parserParameters": {
    }
}

Parst eine ausgewählte Datei einer Tabelle

path Parameters
tableId
required
integer <int32>
fileId
required
integer <int32>
Request Body schema: application/json
required
object (FileParserParameters)
separator
string
skipHeaderLines
integer <int32>
skipFooterLines
integer <int32>
noHeader
boolean

Responses

Request samples

Content type
application/json
{
  • "parserParameters": {
    }
}

Importiert eine ausgewählte Datei einer Tabelle

path Parameters
tableId
required
integer <int32>
fileId
required
integer <int32>
Request Body schema: application/json
required
object (FileParserParameters)
sheetName
string
required
object (SheetImportParameters)

Responses

Request samples

Content type
application/json
{
  • "parserParameters": {
    },
  • "sheetName": "string",
  • "importParameters": {
    }
}

Gibt die Standardwerte einer Tabelle zum Parsen einer Datei zurück

path Parameters
tableId
required
integer <int32>

Responses

Setzt die Standardwerte einer Tabelle zum Parsen einer Datei

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
object (FileParserParameters)
separator
string
skipHeaderLines
integer <int32>
skipFooterLines
integer <int32>
noHeader
boolean

Responses

Request samples

Content type
application/json
{
  • "parserParameters": {
    }
}

Gibt die Standardwerte einer Tabelle zum Import einer Datei zurück

path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
sheetName
string
required
object (SheetImportParameters)

Responses

Request samples

Content type
application/json
{
  • "sheetName": "string",
  • "importParameters": {
    }
}

Gelöschte Objekte

Gibt Liste aller gelöschten Elemente zurück

query Parameters
type
string
Enum: "DOMAIN" "CATEGORY" "TABLE" "QS_RULE" "COMMAND" "DEPLOYMENT_SET"

Responses

Lizenz

Gibt Informationen zur Lizenz zurück

Responses

Parameter

Gibt JSON zurück, über welches das Styling des Frontends gesetzt wird

Responses