openapi: 3.0.0 info: title: DomainService --> Big Data Graph-Query-Service description: Big Data System for indexing, and searching unstructured data in a structured way. termsOfService: https://phoenix-systems.ch contact: name: Phoenix Systems AG url: https://phoenix-systems.ch email: support@phoenix-systems.ch license: name: Phoenix Systems AG url: https://phoenix-systems.ch version: 1.8.6.6 servers: - url: / variables: {} tags: - name: Global API - name: Global API - name: Capture MetaData API - name: Data - json import/export - name: Data - json import/export - name: Test Data Generator API - name: Diagram API - name: Diagram API - name: Diagram API - name: Diagram API - name: Diagram API - name: Diagram API - name: Diagram API - name: Diagram API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Administration API - name: Hint API - name: Hint API - name: Hint API - name: Hint API - name: Hint API - name: Hint API - name: Hint API - name: Hint API - name: Solr Querygenerator API - name: Solr Querygenerator API - name: Trigger API - name: Trigger API - name: Trigger API - name: Trigger API - name: Trigger API - name: Trigger API - name: Trigger API - name: Trigger API - name: Administration API - name: Administration API - name: Admin User API - name: Admin User API - name: Admin User API - name: Admin User API - name: Admin User API - name: Admin User API - name: Admin User API - name: Admin User API - name: Admin User API - name: Admin User API - name: Admin User API - name: Admin User API - name: Admin User API - name: Admin User API - name: Admin User API - name: Admin User API - name: Admin User API - name: Domain Administration API - name: Domain Administration API - name: Domain Administration API - name: Domain Administration API - name: Index API - name: Index API - name: Object API - name: Object API - name: Object API - name: Object API - name: Object API - name: Object API - name: Object API - name: Register API - name: Register API - name: Register API - name: Data - CSV import/export - name: Data - CSV import/export - name: Data - CSV import/export - name: Data - CSV import/export - name: Data - CSV import/export - name: Data - CSV import/export - name: Data - CSV import/export - name: Data - CSV import/export - name: Data - CSV import/export - name: Data - CSV import/export - name: Data - CSV import/export - name: Data - CSV import/export - name: Data - CSV import/export - name: Data - CSV import/export - name: Data - CSV import/export - name: Data - CSV import/export - name: Data Import API - name: Data Import API - name: Data Import API - name: Data Import API - name: Data Import API - name: Data Import API - name: Data Import API - name: Data Import API - name: Data Import API - name: Data Import API - name: Data Import API - name: Data Import API - name: Data Import API - name: File API - name: File API - name: File API - name: File API - name: File API - name: File API - name: File API - name: File API - name: File API - name: File API - name: FTP Connection - Up-/Download files to FTP Server - name: FTP Connection - Up-/Download files to FTP Server - name: FTP Connection - Up-/Download files to FTP Server - name: FTP Connection - Up-/Download files to FTP Server - name: FTP Connection - Up-/Download files to FTP Server - name: FTP Connection - Up-/Download files to FTP Server - name: FTP Connection - Up-/Download files to FTP Server - name: FTP Connection - Up-/Download files to FTP Server - name: Object History API - name: Object History API - name: MetaData API - name: MetaData API - name: MetaData API - name: MetaData API - name: MetaData API paths: /api/application/cleanup/{domain}/{sheme}: get: tags: - Domain Administration API summary: Cleanup of the registered space. Removes all data, metadata and registration of the registered space. description: Cleanup of the registered space. Removes all data, metadata and registration of the registered space. This should only be used through development. operationId: cleanRegistration parameters: - name: domain in: path required: true style: simple schema: type: string default: core - name: application in: path required: true style: simple schema: type: string responses: default: description: Default Response. content: application/json: schema: type: string security: - APIKEY: [] /api/application/cleanupdata/{domain}/{sheme}: get: tags: - Domain Administration API summary: Cleanup of the registered space. Removes all data, but keeps the metadata. description: Cleanup of the registered space. Removes all data, but keeps the metadata.This should only be used through development. operationId: cleanUpData parameters: - name: domain in: path required: true style: simple schema: type: string default: core - name: application in: path required: true style: simple schema: type: string responses: default: description: Default Response. content: application/json: schema: type: string security: - APIKEY: [] /api/application/domain/all: get: tags: - Domain Administration API summary: Delivers all Domains. description: Delivers all registered Domains of the BigData System. operationId: getAllregisteredDomains responses: default: description: Default Response. content: application/json: schema: type: array items: type: string security: - APIKEY: [] /api/application/getRegisteredApps: get: tags: - Domain Administration API summary: Delivers all . description: Delivers all registered Applications of the BigData System. operationId: getAllregisteredApps responses: default: description: Default Response. content: application/json: schema: type: array items: type: string security: - APIKEY: [] /api/capture/{domain}/{scheme}/{type}/{embedded}: post: tags: - Capture MetaData API summary: Capture a json structure and creates MetaData out of it. description: Capture a json structure and creates MetaData out of it. operationId: captureJson parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: type in: path description: Name of Object type. required: true style: simple schema: type: string - name: embedded in: path description: Prefered relations (embedded or decoupled). Embedded kind of composite, decoupled kind of joined. required: true style: simple schema: type: boolean default: "true" requestBody: description: Data of objects to be captured. content: application/json: schema: type: object required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/csv/{domain}/{scheme}: get: tags: - Data - CSV import/export summary: List of existing import infos (triggered version). operationId: getCsvImportInfos parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] put: tags: - Data - CSV import/export summary: Save CSV import (triggered version) infos. operationId: saveCsvImportInfos parameters: - name: domain in: path required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CsvImportInfo' responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] post: tags: - Data - CSV import/export summary: Create CSV import (triggered version) infos. operationId: createObject parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CsvImportInfo' responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/csv/{domain}/{scheme}/byName/{name}: get: tags: - Data - CSV import/export summary: Get import infos (triggered version) by name. operationId: getCsvImportInfoByName parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: name in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/csv/{domain}/{scheme}/csvFile/{filename}: delete: tags: - Data - CSV import/export summary: Deletes the temp CSV file. operationId: deleteTempCsvFile parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: filename in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/csv/{domain}/{scheme}/pausetrigger/{triggerName}: get: tags: - Data - CSV import/export summary: Stops the Trigger import (kind of pause). operationId: stopTrigger parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: triggerName in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/csv/{domain}/{scheme}/restarttrigger/{triggerName}: get: tags: - Data - CSV import/export summary: Restarts an existing Trigger (resume). operationId: startTrigger parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: triggerName in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/csv/{domain}/{scheme}/results/{csvImportName}/{rows}: get: tags: - Data - CSV import/export summary: Returns the results of the previous imports in cronological order. operationId: getResults parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: csvImportName in: path required: true style: simple schema: type: string - name: rows in: path required: true style: simple schema: type: integer default: "10" responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/csv/{domain}/{scheme}/start/{name}: get: tags: - Data - CSV import/export summary: Start the CSV import (triggered version). operationId: startImport parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: name in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/csv/{domain}/{scheme}/stop/{triggerName}: get: tags: - Data - CSV import/export summary: Stop the CSV import (triggered version). operationId: stopImport parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: triggerName in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/csv/{domain}/{scheme}/tempcsvfiles: get: tags: - Data - CSV import/export summary: Lists the CSV files inside the temp folder. operationId: getTempCsvFileName parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/csv/{domain}/{scheme}/upload: post: tags: - Data - CSV import/export summary: Imports data for the domain and scheme in csv format. operationId: importData parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string requestBody: description: The Contract content: multipart/form-data: schema: type: object properties: file: type: string format: binary responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/csv/{domain}/{scheme}/{ftpconnectionname}/listFtpDir: get: tags: - Data - CSV import/export summary: Lists the content of the declared sFTP correction. operationId: checkConnection parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: ftpconnectionname in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/csv/{domain}/{scheme}/{id}: get: tags: - Data - CSV import/export summary: Get import infos (triggered version) by ID. operationId: getCsvImportInfoById parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: id in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] delete: tags: - Data - CSV import/export summary: Deletes a Trigger by ID. operationId: deleteTriggerById parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string - name: id in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/csv/{domain}/{scheme}/{importName}/csvheaders: get: tags: - Data - CSV import/export summary: Lists the CSV Headers of the CSV file declared in the CsvImportInfo object. operationId: getCsvHeaderFields parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: importName in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/data/{domain}/{scheme}/export/{type}: get: tags: - Data - json import/export summary: Exports data for the domain and scheme in compressed (zipped) json format. description: Exports data for the domain and scheme in compressed (zipped) json format. operationId: exportData parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: type in: path description: Name of Object type. style: simple schema: type: string default: "" responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/data/{domain}/{scheme}/import: post: tags: - Data - json import/export summary: Imports data for the domain and scheme in compressed (zipped) json format. description: Imports data for the domain and scheme in compressed (zipped) json format. operationId: importData parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string requestBody: description: The Contract content: multipart/form-data: schema: type: object properties: file: type: string format: binary responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/dataimport/checkConnection: post: tags: - Data Import API summary: Returns the DB connection is correct or not. description: Returns the DB connection is correct or not. operationId: checkConnection requestBody: content: application/json: schema: $ref: '#/components/schemas/DbConnection' responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/dataimport/{domain}/{scheme}: get: tags: - Data Import API summary: List of existing import infos (triggered version). description: List of existing import infos (triggered version). operationId: getDbImportInfos parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core - name: scheme in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] put: tags: - Data Import API summary: Save DB import (triggered version) infos. description: Save DB import (triggered version) infos. operationId: saveDbImportInfos parameters: - name: domain in: path required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DbImportInfo' responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] post: tags: - Data Import API summary: Create DB import (triggered version) infos. operationId: createObject parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core - name: scheme in: path required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DbImportInfo' responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/dataimport/{domain}/{scheme}/byName/{name}: get: tags: - Data Import API summary: Get import infos (triggered version) by ID. description: Get import infos (triggered version) by ID. operationId: getDbImportInfoByName parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core - name: scheme in: path required: true style: simple schema: type: string - name: name in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/dataimport/{domain}/{scheme}/driver: get: tags: - Data Import API summary: List of availavle DB Drivers (triggered version). description: List of availavle DB Drivers (triggered version). operationId: getAvailableDBDriver parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core - name: scheme in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/dataimport/{domain}/{scheme}/pausetrigger/{triggerName}: get: tags: - Data Import API summary: Stops the Trigger import (kind of pause). description: Stops the Trigger import (kind of pause). operationId: stopTrigger parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core - name: scheme in: path required: true style: simple schema: type: string - name: triggerName in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/dataimport/{domain}/{scheme}/restarttrigger/{triggerName}: get: tags: - Data Import API summary: Restarts an existing Trigger (resume). description: Restarts an existing Trigger (resume). operationId: startTrigger parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core - name: scheme in: path required: true style: simple schema: type: string - name: triggerName in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/dataimport/{domain}/{scheme}/results/{dbImportName}/{rows}: get: tags: - Data Import API summary: Returns the results of the previous imports in cronological order. description: Returns the results of the previous imports in cronological order. operationId: getResults parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core - name: scheme in: path required: true style: simple schema: type: string - name: dbImportName in: path required: true style: simple schema: type: string - name: rows in: path required: true style: simple schema: type: integer default: "10" responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/dataimport/{domain}/{scheme}/start/{name}: get: tags: - Data Import API summary: Start the DB import (triggered version). description: Start the DB import (triggered version). operationId: startImport parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core - name: scheme in: path required: true style: simple schema: type: string - name: name in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/dataimport/{domain}/{scheme}/stop/{triggerName}: get: tags: - Data Import API summary: Stop the DB import (triggered version). description: Stop the DB import (triggered version). operationId: stopImport parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core - name: scheme in: path required: true style: simple schema: type: string - name: triggerName in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/dataimport/{domain}/{scheme}/{id}: get: tags: - Data Import API summary: Get import infos (triggered version) by ID. description: Get import infos (triggered version) by ID. operationId: getDbImportInfoById parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core - name: scheme in: path required: true style: simple schema: type: string - name: id in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] delete: tags: - Data Import API summary: Deletes a Trigger by ID. description: Deletes a Trigger by ID. operationId: deleteTriggerById parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core - name: id in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/diagram/{domain}/{scheme}: get: tags: - Diagram API summary: Query for a Domain Diagram by domainName and scheme. description: Query for an Domain Diagram by domainName and scheme. operationId: getDomainById parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] put: tags: - Diagram API summary: Stores a Domain Diagram in the DomainService. description: Stores a Domain Diagram in the DomainService. operationId: updateDomain parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string requestBody: description: DomainDiagram object. content: application/json: schema: $ref: '#/components/schemas/DomainDiagram' required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] post: tags: - Diagram API summary: Stores a Domain Diagram in the DomainService. description: Stores a Domain Diagram in the DomainService. operationId: createDomain parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string requestBody: description: DomainDiagram object. content: application/json: schema: $ref: '#/components/schemas/DomainDiagram' required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] delete: tags: - Diagram API summary: Deletes a Domain Diagram by domain. description: Deletes a omain by domain. operationId: deleteDomainById parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/diagram/{domain}/{scheme}/generate: get: tags: - Diagram API summary: Generates a Diagram for the domain. description: Generates a Diagram for the domain. operationId: generate parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/diagram/{domain}/{scheme}/publish: get: tags: - Diagram API summary: Delivers the publish Informations. description: Delivers the publish Informations. operationId: getPublishInfo parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] put: tags: - Diagram API summary: Publishes Domain Diagram to the MetaData. description: Publishes Domain Diagram to the MetaData. operationId: publish parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/diagram/{domain}/{scheme}/resetpositions: post: tags: - Diagram API summary: Recalculates the Node positions. description: Recalculates the Node positions. operationId: resetPositions parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string requestBody: description: DomainDiagram object. content: application/json: schema: $ref: '#/components/schemas/DomainDiagram' required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/domain: get: tags: - Administration API summary: List of existing Domain documents. description: List of existing Domain documents. operationId: getDomains responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] put: tags: - Administration API summary: Stores a Domain Document in the DomainService. description: Stores a Domain Document in the DomainService. operationId: updateDomain requestBody: description: Domain objects. content: application/json: schema: $ref: '#/components/schemas/Domain' required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] post: tags: - Administration API summary: Stores a Domain Document in the DomainService. description: Stores a Domain Document in the DomainService. operationId: createDomain requestBody: description: Domain objects. content: application/json: schema: $ref: '#/components/schemas/Domain' required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/domain/by/{name}: get: tags: - Administration API summary: Query for an Domain document by name. description: Query for an Domain document by name. operationId: getDomain parameters: - name: name in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] delete: tags: - Administration API summary: Deletes a domain by name. description: Deletes a domain by name. operationId: deleteDomainByName parameters: - name: name in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/domain/client/by/{domain}: get: tags: - Administration API summary: List of ConnectionClient documents. description: List of ConnectionClient documents. operationId: getConnectionClients parameters: - name: domain in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/domain/client/{domain}: put: tags: - Administration API summary: Stores a ConnectionClient document in the DomainService. description: Stores a ConnectionClient document in the DomainService. operationId: updateConnectionClient parameters: - name: domain in: path required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string requestBody: description: ConnectionClient objects. content: application/json: schema: $ref: '#/components/schemas/DomainClientConnection' required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] post: tags: - Administration API summary: Stores a ConnectionClient document in the DomainService. description: Stores a ConnectionClient document in the DomainService. operationId: createConnectionClient parameters: - name: domain in: path required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string requestBody: description: ConnectionClient object. content: application/json: schema: $ref: '#/components/schemas/DomainClientConnection' required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/domain/client/{id}: get: tags: - Administration API summary: Query for a ConnectionClient document by id. description: Query for a ConnectionClient document by id. operationId: getDomainById parameters: - name: id in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] delete: tags: - Administration API summary: Deletes a connectionClient by name. description: Deletes a connectionClient by name. operationId: deleteConnectionClientById parameters: - name: id in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/domain/genApiKey: get: tags: - Administration API summary: Generates a new ApiKey. operationId: generateApiKey responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/domain/merge: get: tags: - Administration API summary: Copies/merges a domain (source) to a target domain. description: Copies/merges a domain (source) to a target domain. operationId: MergeIndexes parameters: - name: sourceDomainName in: query description: Source domain. required: true style: simple schema: type: string - name: domainName in: query description: Target domain. required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/domain/shard/by/{domain}: get: tags: - Administration API summary: List of Shard documents. description: List of Shard documents. operationId: getShards parameters: - name: domain in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/domain/shard/{domain}: put: tags: - Administration API summary: Stores a Shard document in the DomainService. description: Stores a Shard document in the DomainService. operationId: updateShard parameters: - name: domain in: path required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string requestBody: description: Shard objects. content: application/json: schema: $ref: '#/components/schemas/Shard' required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] post: tags: - Administration API summary: Stores a Shard document in the DomainService. description: Stores a Shard document in the DomainService. operationId: createShard parameters: - name: domain in: path required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string requestBody: description: Shard object. content: application/json: schema: $ref: '#/components/schemas/Shard' required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/domain/shard/{id}: get: tags: - Administration API summary: Query for a Shard document by id. description: Query for a Shard document by id. operationId: getDomainById parameters: - name: id in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] delete: tags: - Administration API summary: Deletes a shard by name. description: Deletes a shard by name. operationId: deleteShardById parameters: - name: id in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/domain/{id}: get: tags: - Administration API summary: Query for an Domain document by id. description: Query for an Domain document by id. operationId: getDomainById parameters: - name: id in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] delete: tags: - Administration API summary: Deletes a domain by ID. description: Deletes a domain by ID. operationId: deleteDomainById parameters: - name: id in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/files/{domain}/{scheme}: post: tags: - File API summary: Upload file operationId: testUploadFile parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path required: true style: simple schema: type: string requestBody: description: The Contract content: multipart/form-data: schema: type: object properties: file: type: string format: binary responses: default: description: Default Response. content: application/json;charset=UTF-8: schema: type: string security: - APIKEY: [] /api/files/{domain}/{scheme}/download/{fileId}: get: tags: - File API summary: Delivers the File + Info. description: Delivers the File + Info for the internal fileId operationId: getFile parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path required: true style: simple schema: type: string - name: fileId in: path required: true style: simple schema: type: string responses: "200": description: FileRo Object. content: text/plain: schema: {} security: - APIKEY: [] /api/files/{domain}/{scheme}/info: get: tags: - File API summary: Delivers Filtered List of Files. description: Delivers Filtered List of Files. operationId: readFiles parameters: - name: rows in: query style: simple schema: type: integer default: "25" - name: language in: query style: simple schema: type: string default: EN - name: filter in: query style: simple schema: type: array items: type: string - name: facet in: query style: simple schema: type: array items: type: string - name: start in: query style: simple schema: type: integer default: "0" - name: query in: query style: simple schema: type: string default: '*:*' - name: sort in: query style: simple schema: type: string default: transactionid_string desc - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path required: true style: simple schema: type: string responses: "200": description: FileRo Object. content: application/json: {} security: - APIKEY: [] /api/files/{domain}/{scheme}/info/enriched: get: tags: - File API summary: Get enriched Filters of Fileinfo. description: Get enriched Filters of Fileinfo. operationId: enrichFilters parameters: - name: rows in: query style: simple schema: type: integer default: "25" - name: field in: query style: simple schema: type: string - name: start in: query style: simple schema: type: integer default: "0" - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path required: true style: simple schema: type: string responses: "200": content: application/json: {} security: - APIKEY: [] /api/files/{domain}/{scheme}/info/filters: get: tags: - File API summary: Get Filters for File Queries. description: Get Filters for File Queries. operationId: readFileFilters parameters: - name: field in: query style: simple schema: type: string - name: filter in: query style: simple schema: type: array items: type: string - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path required: true style: simple schema: type: string responses: "200": description: Get Filters for File Queries. content: application/json: {} security: - APIKEY: [] /api/files/{domain}/{scheme}/info/{id}: get: tags: - File API summary: Get a specific Fileinfo for an ID. description: Get a specific Fileinfo for an ID. operationId: readFile parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path required: true style: simple schema: type: string - name: id in: path required: true style: simple schema: type: string responses: "200": description: FileRo Object. content: application/json: {} security: - APIKEY: [] /api/files/{domain}/{scheme}/upload: post: tags: - File API summary: File Upload function. For uploading unspecific files. description: File Upload function. For uploading unspecific files. Normally userd by the DomainConnector (DomainClient). operationId: uploadFile parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path required: true style: simple schema: type: string requestBody: content: '*/*': schema: type: string responses: "200": description: Result Object. content: application/json: {} "204": description: Missing content. "401": description: Application is not registered. security: - APIKEY: [] /api/files/{domain}/{scheme}/upload/{fileId}: delete: tags: - File API summary: Deletes the File + Info for an ID. description: Deletes the File + Info for an ID. operationId: deleteFile parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path required: true style: simple schema: type: string - name: fileId in: path required: true style: simple schema: type: string responses: "200": description: Deletes the File. content: application/json;charset=UTF-8: {} "401": description: Application is not registered. security: - APIKEY: [] /api/files/{domain}/{scheme}/upload/{fileid}: put: tags: - File API summary: File Upload function. For updating unspecific files. description: File Upload function. updating unspecific files. Normally userd by the DomainConnector (DomainClient). operationId: updateFile parameters: - name: data in: query style: simple schema: type: string - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path required: true style: simple schema: type: string - name: fileid in: path required: true style: simple schema: type: string responses: "200": description: Result Object. content: application/json: {} "204": description: Missing content. "401": description: Application is not registered. security: - APIKEY: [] /api/files/{domain}/{scheme}/{id}: put: tags: - File API summary: File Update function. For uploading files through multipartcontents in the httpServletRequest. description: 'File Update function. For uploading files through httpServletRequest. Creates and Stores the file data as Base64 encoded byte stream and an additional info object with all file informations ' operationId: updateFile parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path required: true style: simple schema: type: string - name: id in: path required: true style: simple schema: type: string responses: "200": description: Result Object. content: application/json: {} "401": description: Application is not registered. "500": description: Internal Error. Connectivity security: - APIKEY: [] /api/ftp/{domain}/{scheme}: get: tags: - FTP Connection - Up-/Download files to FTP Server summary: List of existing FTP Connection objects. operationId: getFtpConnectionInfos parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] put: tags: - FTP Connection - Up-/Download files to FTP Server summary: Save FTP Connection Object. operationId: saveFtpConnectionInfos parameters: - name: domain in: path required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FtpConnection' responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] post: tags: - FTP Connection - Up-/Download files to FTP Server summary: Create FTP Connection Object, which keeps the infos. operationId: createObject parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FtpConnection' responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/ftp/{domain}/{scheme}/byName/{name}: get: tags: - FTP Connection - Up-/Download files to FTP Server summary: Get FTP Connections infos by name. operationId: getFtpConnectionByName parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: name in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/ftp/{domain}/{scheme}/checkConnection: post: tags: - FTP Connection - Up-/Download files to FTP Server summary: Returns whether the sFTP connection is connectable or not. operationId: checkConnection requestBody: content: application/json: schema: $ref: '#/components/schemas/FtpConnection' responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/ftp/{domain}/{scheme}/listDirs/{ftpConnectionName}: get: tags: - FTP Connection - Up-/Download files to FTP Server summary: Delivers the dir structur of the FTP server. Also for testing FTP connection operationId: listDirectory parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: ftpConnectionName in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/ftp/{domain}/{scheme}/{id}: get: tags: - FTP Connection - Up-/Download files to FTP Server summary: Get FTP Connections infos by ID. operationId: getFtpConnectionById parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string - name: scheme in: path required: true style: simple schema: type: string - name: id in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] delete: tags: - FTP Connection - Up-/Download files to FTP Server summary: Deletes a FTP Connection by ID. operationId: deleteFtpConnectionById parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string - name: id in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/hierarchy/type/{domain}/{scheme}/{fields}: get: tags: - Administration API summary: Returns the Entity Tree Structure for the domain. description: Returns the Entity Tree Structure for the domain. operationId: getHierachyAll parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: fields in: path description: Including Field informations. required: true style: simple schema: type: boolean default: "false" responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/hierarchy/type/{domain}/{scheme}/{fields}/{type}/{fields}: get: tags: - Administration API summary: Returns the Entity Tree Structure for the domain and the given type (Entity simple name). description: Returns the Entity Tree Structure for the domain and the given type (Entity simple name). operationId: getHierachy parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: type in: path description: Name of Object type. required: true style: simple schema: type: string - name: fields in: path description: Including Field informations. required: true style: simple schema: type: boolean default: "false" responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/hint: put: tags: - Hint API summary: Updates a hint. description: Updates a hint. operationId: updateHint parameters: - name: Language in: header style: simple schema: type: string requestBody: description: Domain objects. content: application/json: schema: $ref: '#/components/schemas/Hint' required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] post: tags: - Hint API summary: Creates a new Hint. description: Creates a new Hint. operationId: saveHint parameters: - name: Language in: header style: simple schema: type: string requestBody: description: Domain objects. content: application/json: schema: $ref: '#/components/schemas/Hint' required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/hint/apiKey: get: tags: - Hint API summary: Search hints by phrase. description: Search hints by phrase. operationId: getApiKeyForDocs responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/hint/comment/{elementid}: put: tags: - Hint API summary: Adds a comment to a hint. description: Adds a comment to a hint. operationId: addComment parameters: - name: elementid in: path required: true style: simple schema: type: string - name: Language in: header style: simple schema: type: string requestBody: description: Domain objects. content: application/json: schema: type: string required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/hint/id/{id}: get: tags: - Hint API summary: Get Hint by id. description: Get Hint by id. operationId: getHintById parameters: - name: id in: path required: true style: simple schema: type: string - name: Language in: header style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/hint/search/{lang}/{phrase}: get: tags: - Hint API summary: Search hints by phrase. description: Search hints by phrase. operationId: searchHint parameters: - name: phrase in: path required: true style: simple schema: type: string - name: Language in: header style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/hint/{elementid}: get: tags: - Hint API summary: Get Hint by elementid. description: Get Hint by elementid. operationId: getHint parameters: - name: elementid in: path required: true style: simple schema: type: string - name: Language in: header style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] delete: tags: - Hint API summary: Deletes a hint by elementId. description: Deletes a hint by elementId. operationId: deleteDomainById parameters: - name: elementid in: path required: true style: simple schema: type: string - name: Language in: header style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/history/{domain}/{scheme}/{id}/{depth}: get: tags: - Object History API summary: Returns history objects. description: Each DomainEntity Object, annotated by the DomainHistory Annotation, gets a history entry on changes. For getting the history informations like the changes in form of diffs or the whole object in a former state, just requestby the id and the depth you need. operationId: readObjects parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: id in: path description: DomainId of the DomainEntity Object. required: true style: simple schema: type: string - name: depth in: path description: Number of depth (default = 1). style: simple schema: type: integer default: "1" responses: "200": description: List of History Objects content: application/json: {} "500": description: Internal Error. Connectivity security: - APIKEY: [] /api/history/{domain}/{scheme}/{id}/{depth}/{fieldname}: get: tags: - Object History API summary: Returns the history of a field content, before it was changed. description: Returns the history of a field content, before it was changed. operationId: getHistory parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: id in: path description: DomainId of the DomainEntity Object. required: true style: simple schema: type: string - name: depth in: path description: Number of depth (default = 1). style: simple schema: type: integer default: "1" - name: fieldname in: path description: Fieldname, you want to see teh history. required: true style: simple schema: type: string responses: "200": description: List of History Objects content: application/json: {} "500": description: Internal Error. Connectivity security: - APIKEY: [] /api/index/reindex: get: tags: - Index API summary: Reindex the System. description: Reindex the System. operationId: reIndex parameters: - name: batchSize in: query description: batchSize. required: true style: simple schema: type: integer default: "5000" responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - APIKEY: [] /api/index/reindex/{domain}: get: tags: - Index API summary: Reindex the data for given domain (space). description: Reindex the data for given domain (space). operationId: reIndexDomain parameters: - name: batchSize in: query description: batchSize. required: true style: simple schema: type: integer default: "5000" - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core example: Core responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - APIKEY: [] /api/metadata/{domain}/{scheme}: put: tags: - MetaData API summary: Put a list of DomainMetaData objects. description: Puts/Updates the DomainMetaData of an DomainEntity Object. Every Application Object which is annotated with @DomainEntity will be a Document in the DomainService and should have its MetaData to make complex queries through all relations. operationId: updateMetaData parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string requestBody: description: DomainMetaData object that needs to be added to the DomainService. content: application/json: schema: type: object properties: fullClassName: type: string childFieldList: type: object documentFieldList: type: object objectFieldList: type: object simpleClassName: type: string nodeFieldList: type: object historyContext: type: boolean excludeEmpty: type: boolean application: type: string primitiveFieldList: type: object domain: type: string id: type: string isIntegrity: type: boolean required: true responses: "200": description: DomainIds content: application/json: schema: type: object properties: fullClassName: type: string childFieldList: type: object documentFieldList: type: object objectFieldList: type: object simpleClassName: type: string nodeFieldList: type: object historyContext: type: boolean excludeEmpty: type: boolean application: type: string primitiveFieldList: type: object domain: type: string id: type: string isIntegrity: type: boolean "400": description: Bad request. "404": description: The Application is not registered. "500": description: Internal Server Error. security: - APIKEY: [] post: tags: - MetaData API summary: Post a list of DomainMetaData objects. description: Posts/Creates the DomainMetaData of an DomainEntity Object. Every Application Object which is annotated with @DomainEntity will be a Document in the DomainService and should have its MetaData to make complex queries through all relations. operationId: createMetaData parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string requestBody: description: DomainMetaData object that needs to be added to the DomainService. content: application/json: schema: type: object properties: fullClassName: type: string childFieldList: type: object documentFieldList: type: object objectFieldList: type: object simpleClassName: type: string nodeFieldList: type: object historyContext: type: boolean excludeEmpty: type: boolean application: type: string primitiveFieldList: type: object domain: type: string id: type: string isIntegrity: type: boolean required: true responses: "200": description: DomainIds content: application/json: {} "400": description: Bad request. "404": description: The Application is not registered. "500": description: Internal Server Error. security: - APIKEY: [] delete: tags: - MetaData API summary: Deletes all MetaData Objects. description: Deletes all MetaData Objects. This is useful for the initializing prozess at server start. Will be done by the DomainClient at the DomainEntity scanning process. operationId: deleteAllMetaData parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of the app, to be registered. required: true style: simple schema: type: string responses: "200": description: Okay message. "400": description: The scheme could not be found. "500": description: Something went wrong. security: - APIKEY: [] /api/metadata/{domain}/{scheme}/{classname}: get: tags: - MetaData API summary: Get the stored MetaData Object for the classname. description: Delivers the MetaData of an DomainEntity Object. Every Application Object which is annotated with @DomainEntity will be a Document in the DomainService and should have its MetaData. operationId: getMetaData parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: classname in: path description: Name of DomainEntity class. required: true style: simple schema: type: string responses: "200": description: DomainMetaData content: application/json: schema: type: object properties: fullClassName: type: string childFieldList: type: object documentFieldList: type: object objectFieldList: type: object simpleClassName: type: string nodeFieldList: type: object historyContext: type: boolean excludeEmpty: type: boolean application: type: string primitiveFieldList: type: object domain: type: string id: type: string isIntegrity: type: boolean "400": description: DomainMetaObject not found security: - APIKEY: [] delete: tags: - MetaData API summary: Delete a specific MetaData Object for a className. description: Delete a specific MetaData Object for a className. operationId: deleteMetaData parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: classname in: path description: Name of DomainEntity class. required: true style: simple schema: type: string responses: "200": description: Okay message. "400": description: The scheme could not be found. "500": description: Something went wrong. security: - APIKEY: [] /api/objects/{domain}/{scheme}/query/{type}: get: tags: - Object API summary: Queries for DomainEntity objects. This Query will be executed with internal subqueries. description: Queries for DomainEntity objects.This Query will be executed with internal subqueries in case of subtypes with its queries are denoted in the fieldlist and the metaData informations are available in the domainService. operationId: searchField parameters: - name: rows in: query style: simple schema: type: integer default: "25" - name: filter in: query style: simple schema: type: array items: type: string - name: facet in: query style: simple schema: type: array items: type: string - name: start in: query style: simple schema: type: integer default: "0" - name: query in: query style: simple schema: type: string default: '*:*' - name: sort in: query style: simple schema: type: string default: transactionid_string desc - name: field in: query style: simple schema: type: array items: type: string - name: terms in: query style: simple schema: type: array items: type: string - name: shards in: query style: simple schema: type: array items: type: string - name: additionalparam in: query style: simple schema: type: array items: type: string - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path required: true style: simple schema: type: string - name: type in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - APIKEY: [] post: tags: - Object API summary: Queries for DomainEntity objects by posting a Query object. This Query will be executed with internal subqueries. description: Queries for DomainEntity objects.This Query will be executed with internal subqueries in case of subtypes with its queries are denoted in the fieldlist and the metaData informations are available in the domainService. operationId: searchNative parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path required: true style: simple schema: type: string - name: type in: path required: true style: simple schema: type: string requestBody: description: Query object. content: application/json: schema: $ref: '#/components/schemas/Query' required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - APIKEY: [] /api/objects/{domain}/{scheme}/{type}: get: tags: - Object API summary: Filtered List of Objects. This Query will be executed without internal subqueries. description: This Query will be executed without internal subqueries. This Query is normally used for the searching of Objects/Documents which are not defind as a DomainEntity Object by annotation. operationId: readObjects parameters: - name: rows in: query style: simple schema: type: integer default: "25" - name: filter in: query style: simple schema: type: array items: type: string - name: facet in: query style: simple schema: type: array items: type: string - name: start in: query style: simple schema: type: integer default: "0" - name: query in: query style: simple schema: type: string default: '*:*' - name: sort in: query style: simple schema: type: string default: transactionid_string desc - name: field in: query style: simple schema: type: array items: type: string - name: terms in: query style: simple schema: type: array items: type: string - name: shards in: query style: simple schema: type: array items: type: string - name: additionalparam in: query style: simple schema: type: array items: type: string - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: type in: path description: Name of Object type. required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - APIKEY: [] put: tags: - Object API summary: Updates/Puts a list of objects in the DomainService. description: Updates/Puts a list of objects in the DomainService. Indexes all object data depending on its annotations in the search index. operationId: updateObject parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: type in: path description: Name of Object type. required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string requestBody: description: Data of objects that needs to be added to the DomainService. content: application/json: schema: type: object required: true responses: "200": description: DomainIds content: application/json: {} "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - APIKEY: [] post: tags: - Object API summary: Stores a list of objects in the DomainService. description: Stores a list of objects in the DomainService. Indexes all object data depending on its annotations in the search index. Returns generated domainIds. operationId: createObject parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: type in: path description: Name of Object type. required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string requestBody: description: Data of objects that needs to be added to the DomainService. content: application/json: schema: type: object required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - APIKEY: [] delete: tags: - Object API summary: Deletes objects for the type and ID. description: Deletes objects for the type and ID. operationId: deleteContent parameters: - name: id in: query style: simple schema: type: array items: type: string - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path required: true style: simple schema: type: string - name: type in: path required: true style: simple schema: type: string - name: userid in: header style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - APIKEY: [] /api/objects/{domain}/{scheme}/{type}/{id}: get: tags: - Object API summary: Query for an object by id. This Query will be executed without internal subqueries. description: This Query will be executed without internal subqueries. This Query is normally used for the searching of an Object/Document which is not defind as a DomainEntity Object by annotation. operationId: readObject parameters: - name: filter in: query style: simple schema: type: array items: type: string - name: sort in: query style: simple schema: type: string default: transactionid_string desc - name: field in: query style: simple schema: type: array items: type: string - name: terms in: query style: simple schema: type: array items: type: string - name: shards in: query style: simple schema: type: array items: type: string - name: additionalparam in: query style: simple schema: type: array items: type: string - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: type in: path description: Name of Object type. required: true style: simple schema: type: string - name: id in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - APIKEY: [] /api/openapi-ui: get: tags: - Global API summary: OpenAPI Redirect description: OpenAPI Redirect operationId: pathRedirect responses: default: description: Default Response. content: '*/*': schema: type: object /api/openapi-ui/{filepath}: get: tags: - Global API summary: OpenAPI Redirect description: OpenAPI Redirect operationId: wildcardRedirect responses: default: description: Default Response. content: '*/*': schema: type: object /api/orgunit: get: tags: - Admin User API summary: Returns all existing OrgUnits (Only for SuperAdmins). operationId: getOrgUnits responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] put: tags: - Admin User API summary: Updates the OrgUnit (Only for SuperAdmins). operationId: updateOrgUnit requestBody: content: application/json: schema: $ref: '#/components/schemas/OrgUnit' responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] post: tags: - Admin User API summary: Creates an OrgUnit (Only for SuperAdmins). operationId: createOrgUnit requestBody: content: application/json: schema: $ref: '#/components/schemas/OrgUnit' responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/orgunit/add/{userId}/{orgunit}: put: tags: - Admin User API summary: Authorizes the user for the orgUnit (Only for SuperAdmins). operationId: addDomainToUser parameters: - name: userId in: path required: true style: simple schema: type: string - name: orgunit in: path required: true style: simple schema: type: string responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/orgunit/byname/{orgunit}: get: tags: - Admin User API summary: Returns the OrgUnits by name (Only for SuperAdmins). operationId: getOrgUnit parameters: - name: orgunit in: path required: true style: simple schema: type: string responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/orgunit/remove/{userId}/{orgunit}: put: tags: - Admin User API summary: Removes the authorization of the user for the Orgunit (Only for SuperAdmins). operationId: removeDomainFromUser parameters: - name: userId in: path required: true style: simple schema: type: string - name: orgunit in: path required: true style: simple schema: type: string responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/orgunit/users/byname/{orgunit}: get: tags: - Admin User API summary: Returns users belonging to the OrgUnits (Only for SuperAdmins). operationId: getUsersForOrgUnit parameters: - name: orgunit in: path required: true style: simple schema: type: string responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/orgunit/{orgunitId}: get: tags: - Admin User API summary: Returns the OrgUnits by id (Only for SuperAdmins). operationId: getOrgUnitById parameters: - name: orgunitId in: path required: true style: simple schema: type: string responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/orgunit/{orgunit}: delete: tags: - Admin User API summary: Removes the OrgUnit by name (Only for SuperAdmins). operationId: removeOrgUnit parameters: - name: orgunit in: path required: true style: simple schema: type: string responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/query/{domain}/{scheme}/replacertest/{type}/{subqueries}: get: tags: - Solr Querygenerator API summary: Generates a default Solr query object for the type. !Only for Testing! description: Generates a default Solr query object for the type. !Only for Testing! operationId: replace parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: type in: path description: Name of Object type. required: true style: simple schema: type: string - name: subqueries in: path description: Generate also subqueries. required: true style: simple schema: type: boolean default: "true" responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/query/{domain}/{scheme}/{type}: get: tags: - Solr Querygenerator API summary: Generates a default Solr query object for the type. description: Generates a default Solr query object for the type. operationId: getQuery parameters: - name: domain in: path description: Name of your domain (space). required: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of your App. required: true style: simple schema: type: string - name: type in: path description: Name of Object type. required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/register/{domain}/{scheme}: get: tags: - Register API summary: Delivers Properties of an registered Application. description: Useful to check if your application is already registered. Without a registration the DomainService will refuse requests. operationId: getRegistration parameters: - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of the app, to be registered. required: true style: simple schema: type: string responses: "200": description: Json with application properties. security: - APIKEY: [] put: tags: - Register API summary: Update properties of your Application. description: Updates the registration properties of an application at the Domainservice. The Application should have a webhook, only if necessary Endpoint like http://x.x.x.x/Applicationname/refreshproperties, the Domain Service will call that if there is an update on the specific properties. operationId: update parameters: - name: webhookurl in: query description: WebHook Info. Needed for e.g. MQ Infos. style: simple schema: type: string - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of the app, to be registered. required: true style: simple schema: type: string responses: "204": description: Accepted the application, value updated. security: - APIKEY: [] post: tags: - Register API summary: Registers an application at the Domainservice. description: The Application should have a webhook if necessary. Endpoint like http://x.x.x.x/Applicationname/refreshproperties, the Domain Service will call that if there is an update on the specific properties. operationId: createObject parameters: - name: webhookurl in: query description: WebHook Info. Needed for e.g. MQ Infos. style: simple schema: type: string - name: domain in: path description: Name of your domain (space). allowEmptyValue: true style: simple schema: type: string default: core example: core - name: scheme in: path description: Name of the app, to be registered. required: true style: simple schema: type: string responses: "204": description: Accepted the application, value updated. security: - APIKEY: [] /api/testdata/generate: get: tags: - Test Data Generator API summary: Generates Test Data based on the spezific Metadata. description: Generates a number of Test Data records based on the spezific Metadata for the classname and stores them to the given domain and sheme. operationId: generate parameters: - name: domain in: query description: Domainname to store the generated data. required: true style: simple schema: type: string - name: scheme in: query description: Schemename to store the generated data. required: true style: simple schema: type: string - name: classname in: query description: Classname. required: true style: simple schema: type: string - name: amount in: query description: Number of records to be generated. required: true style: simple schema: type: integer responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/trigger: get: tags: - Trigger API summary: Get all available triggers. description: Get all available triggers. operationId: getTriggers responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] put: tags: - Trigger API summary: Updates an Trigger in the DomainService. description: Updates an Trigger in the DomainService. operationId: updateTrigger requestBody: description: TriggerInfo object. content: application/json: schema: $ref: '#/components/schemas/TriggerInfo' required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] post: tags: - Trigger API summary: Creates and stores a Trigger in the DomainService. description: Creates and stores a Trigger in the DomainService. operationId: createTrigger requestBody: description: TriggerInfo object. content: application/json: schema: $ref: '#/components/schemas/TriggerInfo' required: true responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/trigger/by/{name}: delete: tags: - Trigger API summary: Deletes a Trigger by name. description: Deletes a Trigger by name. operationId: deleteTriggerByName parameters: - name: name in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/trigger/domain/{domain}: get: tags: - Trigger API summary: Get all available triggers for a domain. description: Get all available triggers for a domain. operationId: getTriggersByDomain parameters: - name: domain in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/trigger/id/{id}: get: tags: - Trigger API summary: Query for a Trigger by its ID. description: Query for a Trigger by its ID. operationId: getTriggerInfoById parameters: - name: id in: path description: ID of the Trigger. required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/trigger/name/{name}: get: tags: - Trigger API summary: Query for a Trigger by its name. description: Query for a Trigger by its name. operationId: getTriggerInfoByName parameters: - name: name in: path description: Name of the Trigger. required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/trigger/{id}: delete: tags: - Trigger API summary: Deletes a Trigger by ID. description: Deletes a Trigger by ID. operationId: deleteTriggerById parameters: - name: id in: path required: true style: simple schema: type: string responses: "2xx": description: Success, .. request understood and accepted. See RFC or Wikipedia. "4xx": description: Client errors, .. situations in which the error seems to have been caused by the client. See RFC or Wikipedia. "5xx": description: Server errors, .. the server failed to fulfill a request. See RFC or Wikipedia. "920": description: Big Data Exception. security: - token: [] /api/user: get: tags: - Admin User API summary: Returns all users who are in the same OrgUnits as the loggedInUser. operationId: getAllUsers responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] put: tags: - Admin User API summary: Updates an user with domain rights. operationId: updateUser requestBody: content: application/json: schema: $ref: '#/components/schemas/User' responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/user/add/{userId}/{domain}: put: tags: - Admin User API summary: Authorizes the user for the domain. operationId: addDomainToUser parameters: - name: userId in: path required: true style: simple schema: type: string - name: domain in: path required: true style: simple schema: type: string responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/user/byname/{userId}: get: tags: - Admin User API summary: "." operationId: getUserByUserId parameters: - name: userId in: path required: true style: simple schema: type: string responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/user/myself: get: tags: - Admin User API summary: Get user object for own jwt(prefered name). operationId: getMyself responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/user/remove/{userId}/{domain}: put: tags: - Admin User API summary: Removes the authorization of the user for the domain. operationId: removeDomainFromUser parameters: - name: userId in: path required: true style: simple schema: type: string - name: domain in: path required: true style: simple schema: type: string responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/user/withdomains/{userId}: get: tags: - Admin User API summary: Get a user for the userid. Delivers a list of domains, the user has rights for. operationId: getUserWithDomains parameters: - name: userId in: path required: true style: simple schema: type: string responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] /api/user/{userId}: delete: tags: - Admin User API summary: Removes the User object from the BigData System. operationId: removeOrgUnit parameters: - name: userId in: path required: true style: simple schema: type: string responses: default: description: Default Response. content: application/json: schema: type: object security: - token: [] components: schemas: BigDataFile: properties: file: type: string format: binary ColumnEntityMapping: properties: field: type: string columnNumber: type: integer id: type: string columnName: type: string Content: type: object properties: transactionId: type: string contentId: type: string customposttypeId: type: string domain: type: string userId: type: string domainStatus: type: string fallbacklanguage: type: string foreignKeys: type: object countedItems: type: number countedPrice: type: number matchedresults: type: number NOCHANGE: type: integer INSERT: type: integer UPDATE: type: integer modifyFlag: type: integer foreignlastupdate: type: object transactiontime: type: object creatordatetime: type: object languages: type: object className: type: string appName: type: string message: $ref: '#/components/schemas/Message' CsvFileInfo: properties: name: type: string sizeInByte: type: number CsvImportInfo: properties: ftpConnectionId: type: string fileName: type: string updatecreate: type: boolean entityName: type: string delimiter: type: string name: type: string columnEntityMapping: type: array ftpConnection: type: object header: type: boolean id: type: string CsvImportResult: properties: inserted: type: integer scheme: type: string refused: type: integer domainName: type: string csvImportName: type: string durationMillis: type: number id: type: string message: type: string entity: type: string timestamp: type: number CsvInfo: properties: delimiter: type: string header: type: boolean Data: type: object properties: id: type: string description: Id, will be generated and filled on save by the DS.) diagramId: type: string className: type: string simpleClassName: type: string fields: type: array items: type: object properties: diagramId: type: string sortOrder: type: integer name: type: string className: type: string id: type: string description: Id, will be generated and filled on save by the DS.) type: type: string uniqueId: type: boolean DbConnection: type: object properties: dbUrl: type: string dbUser: type: string dbPassword: type: string driverClass: type: string DbImportInfo: type: object properties: id: type: string name: type: string sqlStatement: type: string entityName: type: string updatecreate: type: boolean driverclass: type: string dburl: type: string batchSize: type: integer maxRows: type: integer dbuser: type: string dbpassword: type: string tableEntityMapping: type: array Domain: type: object properties: id: type: string description: Id, will be generated and filled on save by the DS.) domainName: type: string description: Name of the solr domain space (UniqueId).) description: type: string description: Description of domain, e.g. Productive/Test data.) uri: type: string description: Not used in this version. Just a placeholder) apiKey: type: string description: Domain specific ApiKey to access the API on a technical way. deletable: type: boolean description: Protects the domain from deletion. shards: type: array items: type: object properties: name: type: string description: Name. id: type: string description: Id, will be generated and filled on save by the DS.) admins: type: array items: type: string defaultSchema: type: string description: The selected default scheme name. schemes: type: array items: type: string domainClientConnections: type: array items: type: object properties: apiKey: type: string description: APIKEY.) name: type: string description: Name of the DomainClient connection.) id: type: string description: Id, will be generated and filled on save by the DS.) DomainClientConnection: type: object properties: id: type: string description: Id, will be generated and filled on save by the DS.) name: type: string description: Name of the DomainClient connection.) apiKey: type: string description: APIKEY.) DomainDiagram: type: object properties: id: type: string description: Id, will be generated and filled on save by the DS.) diagramId: type: string domain: type: string scheme: type: string edges: type: array items: type: object properties: sourceHandle: type: string diagramId: type: string data: type: object animated: type: boolean style: type: object id: type: string description: Id, will be generated and filled on save by the DS.) source: type: string targetHandle: type: string target: type: string nodes: type: array items: type: object properties: diagramId: type: string data: type: object id: type: string description: Id, will be generated and filled on save by the DS.) position: type: object type: type: string DomainMetaData: type: object properties: id: type: string domain: type: string application: type: string simpleClassName: type: string fullClassName: type: string documentFieldList: type: object childFieldList: type: object nodeFieldList: type: object primitiveFieldList: type: object objectFieldList: type: object historyContext: type: boolean excludeEmpty: type: boolean isIntegrity: type: boolean Edge: type: object properties: id: type: string description: Id, will be generated and filled on save by the DS.) diagramId: type: string source: type: string sourceHandle: type: string target: type: string targetHandle: type: string animated: type: boolean style: type: object data: type: object EdgeData: type: object properties: relationType: type: string aggregationType: type: string Facet: type: object properties: fieldValue: type: string label: type: string count: type: number FacetList: type: object properties: fieldName: type: string values: type: array items: $ref: '#/components/schemas/Facet' Field: type: object properties: id: type: string description: Id, will be generated and filled on save by the DS.) diagramId: type: string type: type: string name: type: string uniqueId: type: boolean sortOrder: type: integer className: type: string FtpConnection: properties: password: type: string remoteHost: type: string remoteDir: type: string name: type: string sftp: type: boolean id: type: string username: type: string FtpFileInfo: properties: permissions: type: string name: type: string sizeInByte: type: number Hint: type: object properties: id: type: string description: Id, will be generated and filled on save by the DS.) elementId: type: string description: FrontendId lang: type: string description: 2 digit language code tooltip: type: string description: text shown as tooltip in FE keywords: type: array description: keywords field for query funtion title: type: string description: title of hint text: type: string description: hint plainText: type: string description: hint comments: type: string description: additional comments, can be added by user Message: type: object properties: INFO: type: string WARNING: type: string ERROR: type: string error_code: type: string status: type: string message: type: string statusCode: type: integer Node: type: object properties: id: type: string description: Id, will be generated and filled on save by the DS.) diagramId: type: string type: type: string position: type: object data: type: object OrgUnit: type: object properties: id: type: string name: type: string description: type: string Periodicity: enum: - NONE - MONTHLY - WEEKLY - DAILY - HOURLY - EVERY_MINUTE - EVERY_SECOND Position: type: object properties: x: type: integer y: type: integer PublishInfo: properties: publishedBy: type: string scheme: type: string publishedAt: type: string domain: type: string id: type: string description: Id, will be generated and filled on save by the DS.) Query: type: object properties: language: type: string facets: type: array filters: type: array relations: type: array customposttypeid: type: string domain: type: string start: type: integer rows: type: integer grouprows: type: integer query: type: string facetquery: type: string joinField: type: string facetLimit: type: integer sort: type: string direction: type: string fields: type: array rawterms: type: array additionalparams: type: array shards: type: array fieldMappings: type: object highlightFieldList: type: array items: type: string highlight: type: boolean Result: type: object properties: contents: type: array items: $ref: '#/components/schemas/Content' facets: type: array items: $ref: '#/components/schemas/FacetList' matchedresults: type: number message: $ref: '#/components/schemas/Message' hash_contents_by_id: type: object Shard: type: object properties: id: type: string description: Id, will be generated and filled on save by the DS.) name: type: string description: Name. Style: type: object properties: stroke: type: string TableEntityMapping: properties: field: type: string column: type: string TaskType: enum: - NONE - SQLDBImport - CSVFileImport TriggerInfo: type: object properties: id: type: string name: type: string taskDomain: type: string taskScheme: type: string taskName: type: string periodicity: type: string timeValue: type: integer startTime: type: string lastTime: type: string active: type: boolean taskType: type: string User: type: object properties: id: type: string username: type: string email: type: string groups: type: array items: type: string orgUnits: type: array items: type: string securitySchemes: APIKEY: type: apiKey description: Backend apiKey security schema name: APIKEY in: header scheme: APIKEY flows: {} token: type: http in: header scheme: bearer bearerFormat: JWT flows: {}