Zum Hauptinhalt springen
API docs by Redocly

INFOMOTION Data Management Center

Dokumentation der API-Endpunkte

Admin

/api/admin/columns/{tableId}

Fügt eine oder mehrere neue Spalten zu einer gegebenen Tabelle hinzu

Authorizations:
Administrator
path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
Array
attributes
object (Attributes)
columnName
string
dataPrecision
integer <int32>
dataScale
integer <int32>
dataType
string
domainId
integer <int32>
domainInput
string
primaryKey
boolean
required
boolean
sortDir
string
sortOrder
integer <int32>
uuid
string <uuid>
visible
boolean
writable
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

/api/admin/columns/{tableId}/{columnId}

Löscht eine Spalte einer gegebenen Tabelle

Authorizations:
Administrator
path Parameters
tableId
required
integer <int32>
columnId
required
integer <int32>

Responses

/api/admin/columns/{tableId}/{columnId}

Aktualisiert eine Spalte einer gegebenen Tabelle

Authorizations:
Administrator
path Parameters
tableId
required
integer <int32>
columnId
required
integer <int32>
Request Body schema: application/json
required
attributes
object (Attributes)
columnName
string
dataPrecision
integer <int32>
dataScale
integer <int32>
dataType
string
domainId
integer <int32>
domainInput
string
primaryKey
boolean
required
boolean
sortDir
string
sortOrder
integer <int32>
uuid
string <uuid>
visible
boolean
writable
boolean

Responses

Request samples

Content type
application/json
{
  • "attributes": { },
  • "columnName": "string",
  • "dataPrecision": 0,
  • "dataScale": 0,
  • "dataType": "string",
  • "domainId": 0,
  • "domainInput": "string",
  • "primaryKey": true,
  • "required": true,
  • "sortDir": "string",
  • "sortOrder": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "visible": true,
  • "writable": true
}

/api/admin/columns/{untrackedTable}

Gibt eine Liste aller Spalten einer Tabelle zurück

Authorizations:
Administrator
path Parameters
untrackedTable
required
string

Responses

/api/admin/refreshCache

Aktualisiert den Cache aller Tabellen

Authorizations:
Administrator

Responses

/api/admin/reservedWords

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

Authorizations:
Administrator

Responses

/api/admin/tables

Fügt eine Tabelle hinzu

Authorizations:
Administrator
Request Body schema: application/json
required
Array of objects (GenericColumnInput)
object (GenericTableInput)

Responses

Request samples

Content type
application/json
{
  • "columns": [
    ],
  • "table": {
    }
}

/api/admin/tables/exists

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

Authorizations:
Administrator
query Parameters
attribute
required
string
value
required
string

Responses

/api/admin/tables/{tableId}

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

Authorizations:
Administrator
path Parameters
tableId
required
integer <int32>

Responses

/api/admin/tables/{tableId}

Aktualisiert die Metadaten einer gegebenen Tabelle

Authorizations:
Administrator
path Parameters
tableId
required
integer <int32>
Request Body schema: application/json
required
attributes
object (Attributes)
categoryId
integer <int32>
object (TableGrants)
hasDataPermissions
boolean
inMemory
boolean
sortOrder
integer <int32>
tableName
string
uuid
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "attributes": { },
  • "categoryId": 0,
  • "grants": {
    },
  • "hasDataPermissions": true,
  • "inMemory": true,
  • "sortOrder": 0,
  • "tableName": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

/api/admin/tables/{tableId}/{dropTableFlag}

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

Authorizations:
Administrator
path Parameters
tableId
required
integer <int32>
dropTableFlag
required
integer <int32>

Responses

/api/admin/untracked

Gibt eine Liste aller Tabellen zurück

Authorizations:
Administrator
query Parameters
repTableFlag
integer <int32>

Responses

Authentifizierung

/api/auth/groups

Gibt eine Liste an Gruppen zurück

Authorizations:
Administrator

Responses

/api/auth/hash/{password}

Gibt den Hashwert eines Passworts zurück

path Parameters
password
required
string

Responses

/api/auth/login

Loggt den Anwender über die gegebenen Credentials ein

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

Responses

Request samples

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

/api/auth/login/openId

Loggt den Anwender über OpenID ein

Request Body schema: application/json
required
accessToken
string
idToken
string

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "idToken": "string"
}

/api/auth/login/password

Loggt den Anwender über die gegebenen Credentials ein

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

Responses

Request samples

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

/api/auth/logout

Meldet die aktuelle Sitzung ab

Responses

/api/auth/settings

Gibt die Authentifizierungseinstellungen zurück

Responses

/api/auth/status

Gibt den Status der aktuellen Sitzung zurück

Responses

/api/auth/unauthorized

Gibt eine UNAUTHORIZED-Antwort zurück

Responses

/api/auth/users

Gibt eine Liste an Nutzern zurück

Authorizations:
Administrator

Responses

Anwendungs-Informationen

/api/bom.json

Ruft einen "Software Bill of Materials" im CycloneDX-Format (JSON) ab.

Authorizations:
Administrator

Responses

Response samples

Content type
application/json
{ }

/api/license/info

Gibt Informationen zur Lizenz zurück

Responses

/api/sbom

Gibt eine SBOM im CycloneDX-Format zurück

Authorizations:
Administrator

Responses

Response samples

Content type
application/json
"string"

/api/theme/json

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

Responses

/api/version

Gibt Informationen zur verwendeten DMC-Version zurück

Responses

Response samples

Content type
application/json
{ }

Kategorien

/api/categories

Gibt eine Liste aller Kategorien zurück

Authorizations:
Valid User

Responses

/api/categories

Fügt eine neue Kategorie hinzu

Authorizations:
Administrator
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

/api/categories/refreshCache

Erneuert den Cache der Kategorien

Authorizations:
Valid User

Responses

/api/categories/{categoryId}

Löscht eine gegebene Kategorie

Authorizations:
Administrator
path Parameters
categoryId
required
integer <int32>

Responses

/api/categories/{categoryId}

Gibt die Merkmale einer Kategorie zurück

Authorizations:
Valid User
path Parameters
categoryId
required
integer <int32>

Responses

/api/categories/{categoryId}

Aktualisiert eine gegebene Kategorie

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

Responses

Request samples

Content type
application/json
"string"

Commands

/api/commands

Gibt eine Liste aller Commands zurück

Authorizations:
Valid User

Responses

/api/commands

Fügt ein neuen Command hinzu

Authorizations:
Administrator
Request Body schema: application/json
required
commandExec
string
commandId
integer <int32>
commandName
string
commandType
string
Enum: "EXEC" "DB_PROCEDURE" "WEBSERVICE"
Array of objects (CommandParameter)
qsAction
string
Enum: "NOTHING" "RUN" "RUN_WITH_MANUAL_RULES"
qsRuleTimeoutSeconds
integer <int32>
qsRuleViolationPolicy
string
Enum: "NEVER_DENY" "DENY_ON_ERROR" "DENY_ON_WARNING" "DENY_ON_INFO" "DENY_ON_ANY"
tableId
integer <int32>
uuid
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "commandExec": "string",
  • "commandId": 0,
  • "commandName": "string",
  • "commandType": "EXEC",
  • "parameters": [
    ],
  • "qsAction": "NOTHING",
  • "qsRuleTimeoutSeconds": 0,
  • "qsRuleViolationPolicy": "NEVER_DENY",
  • "tableId": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

/api/commands/executionInfo/{tableId}

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

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>

Responses

/api/commands/executionInfo/{tableId}/{commandId}

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

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>
commandId
required
integer <int32>

Responses

/api/commands/table/{tableId}

Gibt eine Liste aller Commands für eine bestimmte Tabelle zurück

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>

Responses

/api/commands/{commandId}

Löscht einen gegebenen Command

Authorizations:
Administrator
path Parameters
commandId
required
integer <int32>

Responses

/api/commands/{commandId}

Führt einen gegebenen Command aus

Authorizations:
Valid User
path Parameters
commandId
required
integer <int32>
query Parameters
waitForCompletion
boolean
Default: true
Request Body schema: application/json
property name*
additional property
object

Responses

Request samples

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

/api/commands/{commandId}

Aktualisiert einen gegebenen Command

Authorizations:
Administrator
path Parameters
commandId
required
integer <int32>
Request Body schema: application/json
required
commandExec
string
commandId
integer <int32>
commandName
string
commandType
string
Enum: "EXEC" "DB_PROCEDURE" "WEBSERVICE"
Array of objects (CommandParameter)
qsAction
string
Enum: "NOTHING" "RUN" "RUN_WITH_MANUAL_RULES"
qsRuleTimeoutSeconds
integer <int32>
qsRuleViolationPolicy
string
Enum: "NEVER_DENY" "DENY_ON_ERROR" "DENY_ON_WARNING" "DENY_ON_INFO" "DENY_ON_ANY"
tableId
integer <int32>
uuid
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "commandExec": "string",
  • "commandId": 0,
  • "commandName": "string",
  • "commandType": "EXEC",
  • "parameters": [
    ],
  • "qsAction": "NOTHING",
  • "qsRuleTimeoutSeconds": 0,
  • "qsRuleViolationPolicy": "NEVER_DENY",
  • "tableId": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Datenberechtigung

/api/dataPerm/refreshCache

Aktualisiert den Cache der Berechtigungen auf Datensatzebene

Authorizations:
Valid User

Responses

/api/dataPerm/table/{tableId}

Löscht eine Berechtigung auf Datensatzebene einer Tabelle

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

Responses

Request samples

Content type
application/json
"string"

/api/dataPerm/table/{tableId}

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

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>

Responses

/api/dataPerm/table/{tableId}

Fügt eine Berechtigung auf Datensatzebene einer Tabelle hinzu

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

Responses

Request samples

Content type
application/json
"string"

/api/dataPerm/table/{tableId}

Aktualisiert eine Berechtigung auf Datensatzebene einer Tabelle

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

Responses

Request samples

Content type
application/json
"string"

/api/dataPerm/table/{tableId}/delete

Löscht eine Berechtigung auf Datensatzebene einer Tabelle

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

Responses

Request samples

Content type
application/json
"string"

Deployment: Gelöschte Objekte

/api/deployment/deletedObjects

Gibt Liste aller gelöschten Elemente zurück

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

Responses

Deployment: Import/ Export

/api/deployment/export/directory

Exportiert ein Deploymentset in ein gegebenes Verzeichnis

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

Responses

/api/deployment/export/git

Exportiert ein Deploymentset als commit in ein GIT-Repository

Authorizations:
Administrator
query Parameters
incremental
boolean
Default: false
deploymentSetId
integer <int32>
Request Body schema: application/json
required
authorEmail
string
authorName
string
branch
string
forcePush
boolean
pathInRepository
string
repositoryUrlWithCredentials
string
targetBranch
string

Responses

Request samples

Content type
application/json
{
  • "authorEmail": "string",
  • "authorName": "string",
  • "branch": "string",
  • "forcePush": true,
  • "pathInRepository": "string",
  • "repositoryUrlWithCredentials": "string",
  • "targetBranch": "string"
}

/api/deployment/export/zip

Exportiert ein Deploymentset als eine zip-Datei

Authorizations:
Administrator
query Parameters
deploymentSetId
integer <int32>

Responses

/api/deployment/import/directory

Importiert ein Deploymentset aus einem gegebenen Verzeichnis

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

Responses

/api/deployment/import/git

Importiert einen branch/commit/tag aus einem Git-Repository

Authorizations:
Administrator
query Parameters
includeLocalObjects
boolean
Default: true
skipDdl
boolean
Default: false
allowDrop
boolean
Default: false
Request Body schema: application/json
required
branchOrTag
string
pathInRepository
string
repositoryUrlWithCredentials
string

Responses

Request samples

Content type
application/json
{
  • "branchOrTag": "string",
  • "pathInRepository": "string",
  • "repositoryUrlWithCredentials": "string"
}

/api/deployment/import/zip

Importiert ein Deploymentset einer übergebenen zip-Datei

Authorizations:
Administrator
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"
}

/api/deployment/validate/directory

Validiert ein Deploymentset in ein gegebenes Verzeichnis

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

Responses

/api/deployment/validate/git

Validiert einen branch/commit/tag aus einem Git-Repository

Authorizations:
Administrator
query Parameters
includeLocalObjects
boolean
Default: true
skipDdl
boolean
Default: false
allowDrop
boolean
Default: false
Request Body schema: application/json
required
branchOrTag
string
pathInRepository
string
repositoryUrlWithCredentials
string

Responses

Request samples

Content type
application/json
{
  • "branchOrTag": "string",
  • "pathInRepository": "string",
  • "repositoryUrlWithCredentials": "string"
}

/api/deployment/validate/zip

Validiert ein Deploymentset einer übergebenen zip-Datei

Authorizations:
Administrator
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"
}

Deployment: Deployment-Sets

/api/deployment/sets

Gibt Liste aller Deploymentsets zurück

Authorizations:
Administrator

Responses

/api/deployment/sets

Erstellt ein neues Deploymentset

Authorizations:
Administrator
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"
}

/api/deployment/sets/{id}

Löscht ein gegebenes Deploymentset

Authorizations:
Administrator
path Parameters
id
required
integer <int32>

Responses

/api/deployment/sets/{id}

Gibt ein gewähltes Deploymentset zurück

Authorizations:
Administrator
path Parameters
id
required
integer <int32>

Responses

/api/deployment/sets/{id}

Aktualisiert ein gegebenes Deploymentset

Authorizations:
Administrator
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"
}

/api/deployment/sets/{id}/objects

Gibt die Objekte eines gegebenen Deploymentsets zurück

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

Responses

/api/deployment/sets/{id}/objects/{type}/{uuid}

Löscht ein Objekt von einem gegebenen Deploymentset

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

Responses

/api/deployment/sets/{id}/objects/{type}/{uuid}

Fügt ein Objekt einem gegebenen Deploymentset hinzu

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

Responses

/api/deployment/sets/{id}/objects/{type}/{uuid}

Fügt ein Objekt einem gegebenen Deploymentset hinzu

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

Responses

Deployment-Sets

/api/deployment/sets/{deploymentSetId}/snapshots

Gibt alle Snapshots eines Deploymentsets zurück

Authorizations:
Administrator
path Parameters
deploymentSetId
required
integer <int32>

Responses

/api/deployment/sets/{deploymentSetId}/snapshots

Erstellt einen Snapshot eines Deploymentsets

Authorizations:
Administrator
path Parameters
deploymentSetId
required
integer <int32>

Responses

/api/deployment/sets/{deploymentSetId}/snapshots/{snapshotId}

Löscht einen Snapshot eines Deploymentsets

Authorizations:
Administrator
path Parameters
deploymentSetId
required
integer <int32>
snapshotId
required
integer <int32>

Responses

/api/deployment/sets/{deploymentSetId}/snapshots/{snapshotId}/zip

Gibt einen Snapshot eines Deploymentsets zurück

Authorizations:
Administrator
path Parameters
deploymentSetId
required
integer <int32>
snapshotId
required
integer <int32>

Responses

Wertelisten

/api/domains

Gibt eine Liste aller Wertelisten zurück

Authorizations:
Valid User

Responses

/api/domains

Fügt eine neue Werteliste hinzu

Authorizations:
Administrator
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

/api/domains/validate

Validiert die Syntax einer Werteliste

Authorizations:
Administrator
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

/api/domains/{domainId}

Löscht eine gegebene Werteliste

Authorizations:
Administrator
path Parameters
domainId
required
integer <int32>

Responses

/api/domains/{domainId}

Gibt die Werte einer gegebenen Werteliste zurück

Authorizations:
Valid User
path Parameters
domainId
required
integer <int32>
query Parameters
filterColumnFilter
string
labelColumnFilter
string
forceValues
string

Responses

/api/domains/{domainId}

Aktualisiert eine gegebene Werteliste

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

Responses

Request samples

Content type
application/json
"string"

Dateien

/api/files

Lädt eine gegebene Datei hoch

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

Responses

Request samples

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

/api/files/{tableId}

Gibt eine Liste aller Dateien einer Tabelle zurück

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>

Responses

/api/files/{tableId}

Setzt die Standardwerte einer Tabelle zum Import einer Datei

Authorizations:
Valid User
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": {
    }
}

/api/files/{tableId}/defaultImportParameters

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

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

Responses

Request samples

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

/api/files/{tableId}/defaultParserParameters

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

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>

Responses

/api/files/{tableId}/defaultParserParameters

Setzt die Standardwerte einer Tabelle zum Parsen einer Datei

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

Responses

Request samples

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

/api/files/{tableId}/{fileId}/import

Importiert eine ausgewählte Datei einer Tabelle

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

Responses

Request samples

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

/api/files/{tableId}/{fileId}/parse

Parst eine ausgewählte Datei einer Tabelle

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

Responses

Request samples

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

QS-Regeln

/api/qs

Gibt alle QS-Regeln zurück

Authorizations:
Valid User

Responses

/api/qs

Fügt eine neue QS-Regel hinzu

Authorizations:
Administrator
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

/api/qs/overview

Gibt alle QS-Ergebnisse nach Schweregrad zurück

Authorizations:
Valid User
query Parameters
waitForCompletion
boolean
Default: true

Responses

/api/qs/refreshCache

Erneuert den Cache der QS-Regeln

Authorizations:
Valid User
query Parameters
waitForCompletion
boolean
Default: false

Responses

/api/qs/refreshCache/{tableId}

Erneuert den Cache der QS-Regeln einer Tabelle

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

Responses

/api/qs/results

Gibt alle QS-Ergebnisse nach Tabelle zurück

Authorizations:
Valid User
query Parameters
waitForCompletion
boolean
Default: true

Responses

/api/qs/results/{tableId}

Gibt alle QS-Ergebnisse einer Tabelle zurück

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

Responses

/api/qs/ruleExecutionInfo

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

Authorizations:
Valid User

Responses

/api/qs/ruleExecutionInfo/{tableId}

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

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>

Responses

/api/qs/validate/{tableId}

Validiert das SQL einer QS-Regeln

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

Responses

Request samples

Content type
application/json
"string"

/api/qs/{ruleId}

Löscht eine gegebene QS-Regel

Authorizations:
Administrator
path Parameters
ruleId
required
integer <int32>

Responses

/api/qs/{ruleId}

Aktualisiert eine gegebene QS-Regel

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

Responses

Request samples

Content type
application/json
"string"

Tabellenzugriffsberechtigung

/api/tablePerm/refreshCache

Aktualisiert den Cache der Berechtigungen auf Tabellenebene

Authorizations:
Valid User

Responses

/api/tablePerm/table/{tableId}

Löscht eine Berechtigung auf Tabellenebene einer Tabelle

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

Responses

Request samples

Content type
application/json
"string"

/api/tablePerm/table/{tableId}

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

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>

Responses

/api/tablePerm/table/{tableId}

Fügt eine Berechtigung auf Tabellenebene einer Tabelle hinzu

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

Responses

Request samples

Content type
application/json
"string"

/api/tablePerm/table/{tableId}

Aktualisiert eine Berechtigung auf Tabellenebene einer Tabelle

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

Responses

Request samples

Content type
application/json
"string"

/api/tablePerm/table/{tableId}/delete

Löscht eine Berechtigung auf Tabellenebene einer Tabelle

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

Responses

Request samples

Content type
application/json
"string"

Tabellen

/api/tables

Gibt eine Liste aller Tabellen und deren Berechtigung zurück

Authorizations:
Valid User

Responses

/api/tables/{tableId}

Löscht alle Datensätze einer Tabelle

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>

Responses

/api/tables/{tableId}

Gibt Informationen einer Tabelle und deren Berechtigung zurück

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>

Responses

/api/tables/{tableId}/csv

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

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>
query Parameters
globalFilter
string
filter
string
skipHeader
boolean

Responses

/api/tables/{tableId}/data

Löscht einen Datensatz einer Tabelle

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

Responses

Request samples

Content type
application/json
"string"

/api/tables/{tableId}/data

Gibt die Datensätze einer Tabelle zurück

Authorizations:
Valid User
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

/api/tables/{tableId}/data

Fügt einen Datensatz einer Tabelle hinzu

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

Responses

Request samples

Content type
application/json
"string"

/api/tables/{tableId}/data

Aktualisiert einen Datensatz einer Tabelle

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

Responses

Request samples

Content type
application/json
"string"

/api/tables/{tableId}/data/count

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

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>
query Parameters
qsOnly
integer <int32>
globalFilter
string
filter
string

Responses

/api/tables/{tableId}/data/delete

Löscht einen Datensatz einer Tabelle

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

Responses

Request samples

Content type
application/json
"string"

/api/tables/{tableId}/hist/count

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

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>
query Parameters
datetime
required
string
globalFilter
string
filter
string

Responses

/api/tables/{tableId}/hist/csv

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

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>
query Parameters
datetime
required
string
globalFilter
string
filter
string

Responses

/api/tables/{tableId}/hist/data

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

Authorizations:
Valid User
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

/api/tables/{tableId}/hist/xlsx

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

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>
query Parameters
datetime
required
string
globalFilter
string
filter
string

Responses

/api/tables/{tableId}/xlsx

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

Authorizations:
Valid User
path Parameters
tableId
required
integer <int32>
query Parameters
globalFilter
string
filter
string
skipHeader
boolean

Responses

Tasks & Trigger

/api/tasks

Gibt eine Liste aller Tasks inklusive der zugehörigen Trigger hinzu

Authorizations:
Administrator

Responses

/api/tasks

Fügt einen neuen Task hinzu

Authorizations:
Administrator
Request Body schema: application/json
required
One of
QsMailTaskParameters (object)
id
integer <int32>
name
string
object
type
required
string
uuid
string <uuid>

Responses

Request samples

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

/api/tasks/qsMail/html

Erzeugt eine QS-Mail für die übergebenen Tabellen als Vorschau

Authorizations:
Administrator
query Parameters
tableId
required
Array of integers <int32> [ items <int32 > ]
executeManualRules
boolean
Default: false

Responses

/api/tasks/{taskId}

Löscht einen Task inklusive aller dafür vorhandenen Trigger

Authorizations:
Administrator
path Parameters
taskId
required
integer <int32>

Responses

/api/tasks/{taskId}

Ruft einen spezifischen Task inklusive der zugehörigen Trigger ab

Authorizations:
Administrator
path Parameters
taskId
required
integer <int32>

Responses

/api/tasks/{taskId}

Aktualisiert einen vorhandenen Task. Es sind Änderungen am Namen, den Optionen sowie den Standard-Werten für Parameter (soweit vorhanden) möglich. Der Typ kann nicht geändert werden.

Authorizations:
Administrator
path Parameters
taskId
required
integer <int32>
Request Body schema: application/json
required
One of
QsMailTaskParameters (object)
id
integer <int32>
name
string
object
type
required
string
uuid
string <uuid>

Responses

Request samples

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

/api/tasks/{taskId}/triggers

Ruft für einen Task definierten Trgigger ab

Authorizations:
Administrator
path Parameters
taskId
required
integer <int32>

Responses

/api/tasks/{taskId}/triggers

Definiert für einen Task einen neuen Trigger

Authorizations:
Administrator
path Parameters
taskId
required
integer <int32>
Request Body schema: application/json
required
One of
id
integer <int32>
name
string
object
taskId
integer <int32>
QsMailTaskParameters (object)
type
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "options": {
    },
  • "taskId": 0,
  • "taskParameters": {
    },
  • "type": "string"
}

/api/tasks/{taskId}/triggers/{triggerId}

Löscht einen für einen Task definierten Trigger.

Authorizations:
Administrator
path Parameters
taskId
required
integer <int32>
triggerId
required
integer <int32>

Responses

/api/tasks/{taskId}/triggers/{triggerId}

Ruft einen spezifischen für einen Task definierten Trigger ab

Authorizations:
Administrator
path Parameters
taskId
required
integer <int32>
triggerId
required
integer <int32>

Responses

/api/tasks/{taskId}/triggers/{triggerId}

Aktualisiert einen für einen Task definierten Trigger. Es sind Änderungen am Namen sowieden Optionen des Triggers sowie den an den Task übergebenen Parametern möglich. Die Art des Triggerskann nicht verändert werden.

Authorizations:
Administrator
path Parameters
taskId
required
integer <int32>
triggerId
required
integer <int32>
Request Body schema: application/json
required
One of
id
integer <int32>
name
string
object
taskId
integer <int32>
QsMailTaskParameters (object)
type
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "options": {
    },
  • "taskId": 0,
  • "taskParameters": {
    },
  • "type": "string"
}