# Automatisch erzeugt aus https://wiki.fakturbox.de/de/tutorials/api-doku # Generator: build_openapi.py openapi: "3.0.3" info: title: "docuvita Server – JSON-API" version: "26.1.2257.9526" description: "OpenAPI-Beschreibung der docuvita-Server-JSON-API (faktur:box-Archiv), automatisch erzeugt aus der Wiki-Seite https://wiki.fakturbox.de/de/tutorials/api-doku (Stand der Quelle: 2026-09-02; diese Quelle wiederum stammt aus `/archive/services/json/metadata`).\n\n**Aufrufkonvention:** Alle Operationen werden als POST mit JSON-Body an die jeweilige Route gesendet (`Content-Type: application/json`). Die in der Quelle als „query“ gekennzeichneten Felder des Request-DTOs können alternativ auch als Query-Parameter übergeben werden.\n\n**Authentifizierung:** Es gibt keinen Header-Token. Nach `UserLogin` wird die erhaltene `Sessionguid` bei allen weiteren Aufrufen als Feld `SessionGuid` im Request-Body mitgeschickt.\n\n**Hinweise:** Die Quelle nennt keine Pflichtfelder und keine Enumerationswerte; nicht dokumentierte Typen sind als Stubs mit entsprechendem Beschreibungstext angelegt. Platzhalter in den Beispielen (`\"String\"`, `0`, `false`, Null-GUID) sind durch echte Werte zu ersetzen." servers: - url: "https://{tenant}.fakturbox.io" description: "faktur:box-Mandant" variables: tenant: default: "tenant" description: "Mandantenkennung (Subdomain)" tags: - name: "Allgemein" description: "Abschnitt „Allgemeine Operationen“ der Quelle" - name: "Admin" description: "Abschnitt „Admin_*“ der Quelle" - name: "BatchDeletionAdmin" description: "Abschnitt „BatchDeletionAdmin_*“ der Quelle" - name: "ImportAPI" description: "Abschnitt „ImportAPI_*“ der Quelle" - name: "ImportAdmin" description: "Abschnitt „ImportAdmin_*“ der Quelle" - name: "LocalAdmin" description: "Abschnitt „LocalAdmin_*“ der Quelle" - name: "SecuredContent" description: "Abschnitt „SecuredContent_*“ der Quelle" - name: "Web" description: "Abschnitt „Web_*“ der Quelle" - name: "WorkflowAdmin" description: "Abschnitt „WorkflowAdmin_*“ der Quelle" paths: "/archive/services/addexternalobjectstomyworkspace": post: tags: - "Allgemein" summary: "Adds external objects to personal workspace" description: "Operation **AddExternalObjectsToMyWorkspace**.\n\nAdds external objects to personal workspace\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#addexternalobjectstomyworkspace" operationId: "AddExternalObjectsToMyWorkspace" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/AddExternalObjectsToMyWorkspace" example: SessionGuid: "00000000000000000000000000000000" Context: SystemReference: 0 ImpersonatedUser: 0 ObjectExternalReferences: - "String" ObjectTypeId: 0 UserId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/AddExternalObjectsToMyWorkspaceResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" AddedObjectsList: - AccessRight: 0 Parentobject: 0 Objecttype: 0 IsLink: false Fulltext: "String" Objectid: 0 Name: "String" Description: "String" Usercreated: 0 Dateedited: "0001-01-01T00:00:00" Useredited: 0 Status: 0 Checkoutuser: 0 Checkoutlocation: "String" Deleteflag: 0 Documentdate: "0001-01-01T00:00:00" Abspath: "String" Otpath: "String" Fileextension: "String" Versioncount: 0 Createdusername: "String" Editedusername: "String" Notecount: 0 Systemreference: 0 Barcode: "String" Documenttype: "String" Voucherdate: "0001-01-01T00:00:00" Vouchertype: "String" Vouchernumber: "String" Externalvouchernumber: "String" Transactionkey: "String" Transactiontype: "String" Validfrom: "0001-01-01T00:00:00" Validuntil: "0001-01-01T00:00:00" Deleteflagsetby: 0 Deleteflagsetdate: "0001-01-01T00:00:00" Hiddenflagsetdate: "0001-01-01T00:00:00" Deletereason: 0 Approvalstatuscode: 0 Approvedby: 0 Approvedversion: 0 Latestversion: 0 Filesize: 0 Filehash: "String" Extmetadata: "String" Mailfrom: "String" Mailto: "String" Mailcc: "String" Mailbcc: "String" Mailsubject: "String" Mailmessageid: "String" Mailsenddate: "0001-01-01T00:00:00" Mailparentmailid: 0 Activeworkflowcount: 0 Relatedobjectscount: 0 Deletereasontext: "String" Updateabspath: 0 Lvl: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/addobjectstomyworkspace": post: tags: - "Allgemein" summary: "Adds external objects to personal workspace" description: "Operation **AddObjectsToMyWorkspace**.\n\nAdds external objects to personal workspace\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#addobjectstomyworkspace" operationId: "AddObjectsToMyWorkspace" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/AddObjectsToMyWorkspace" example: SessionGuid: "00000000000000000000000000000000" ObjectReferences: - Objecttype: 0 Objectid: 0 Objectextmetadata: "String" UserId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/AddObjectsToMyWorkspaceResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" AddedObjectsList: - AccessRight: 0 Parentobject: 0 Objecttype: 0 IsLink: false Fulltext: "String" Objectid: 0 Name: "String" Description: "String" Usercreated: 0 Dateedited: "0001-01-01T00:00:00" Useredited: 0 Status: 0 Checkoutuser: 0 Checkoutlocation: "String" Deleteflag: 0 Documentdate: "0001-01-01T00:00:00" Abspath: "String" Otpath: "String" Fileextension: "String" Versioncount: 0 Createdusername: "String" Editedusername: "String" Notecount: 0 Systemreference: 0 Barcode: "String" Documenttype: "String" Voucherdate: "0001-01-01T00:00:00" Vouchertype: "String" Vouchernumber: "String" Externalvouchernumber: "String" Transactionkey: "String" Transactiontype: "String" Validfrom: "0001-01-01T00:00:00" Validuntil: "0001-01-01T00:00:00" Deleteflagsetby: 0 Deleteflagsetdate: "0001-01-01T00:00:00" Hiddenflagsetdate: "0001-01-01T00:00:00" Deletereason: 0 Approvalstatuscode: 0 Approvedby: 0 Approvedversion: 0 Latestversion: 0 Filesize: 0 Filehash: "String" Extmetadata: "String" Mailfrom: "String" Mailto: "String" Mailcc: "String" Mailbcc: "String" Mailsubject: "String" Mailmessageid: "String" Mailsenddate: "0001-01-01T00:00:00" Mailparentmailid: 0 Activeworkflowcount: 0 Relatedobjectscount: 0 Deletereasontext: "String" Updateabspath: 0 Lvl: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/addtofavorites": post: tags: - "Allgemein" summary: "Adds objects to personal favorites" description: "Operation **AddToFavorites**.\n\nAdds objects to personal favorites\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#addtofavorites" operationId: "AddToFavorites" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/AddToFavorites" example: SessionGuid: "00000000000000000000000000000000" ObjectIds: - 0 UserId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/AddToFavoritesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/addtomyworkspace": post: tags: - "Allgemein" summary: "Adds objects to personal workspace" description: "Operation **AddToMyWorkspace**.\n\nAdds objects to personal workspace\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#addtomyworkspace" operationId: "AddToMyWorkspace" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/AddToMyWorkspace" example: SessionGuid: "00000000000000000000000000000000" ObjectIds: - 0 UserId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/AddToMyWorkspaceResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" AddedObjectsList: - AccessRight: 0 Parentobject: 0 Objecttype: 0 IsLink: false Fulltext: "String" Objectid: 0 Name: "String" Description: "String" Usercreated: 0 Dateedited: "0001-01-01T00:00:00" Useredited: 0 Status: 0 Checkoutuser: 0 Checkoutlocation: "String" Deleteflag: 0 Documentdate: "0001-01-01T00:00:00" Abspath: "String" Otpath: "String" Fileextension: "String" Versioncount: 0 Createdusername: "String" Editedusername: "String" Notecount: 0 Systemreference: 0 Barcode: "String" Documenttype: "String" Voucherdate: "0001-01-01T00:00:00" Vouchertype: "String" Vouchernumber: "String" Externalvouchernumber: "String" Transactionkey: "String" Transactiontype: "String" Validfrom: "0001-01-01T00:00:00" Validuntil: "0001-01-01T00:00:00" Deleteflagsetby: 0 Deleteflagsetdate: "0001-01-01T00:00:00" Hiddenflagsetdate: "0001-01-01T00:00:00" Deletereason: 0 Approvalstatuscode: 0 Approvedby: 0 Approvedversion: 0 Latestversion: 0 Filesize: 0 Filehash: "String" Extmetadata: "String" Mailfrom: "String" Mailto: "String" Mailcc: "String" Mailbcc: "String" Mailsubject: "String" Mailmessageid: "String" Mailsenddate: "0001-01-01T00:00:00" Mailparentmailid: 0 Activeworkflowcount: 0 Relatedobjectscount: 0 Deletereasontext: "String" Updateabspath: 0 Lvl: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/changepassword": post: tags: - "Allgemein" summary: "Changes the password of an internal user. After a successful change, a new session is established." description: "Operation **ChangePassword**.\n\nChanges the password of an internal user. After a successful change, a new session is established.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#changepassword" operationId: "ChangePassword" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ChangePassword" example: SystemReferenceId: 0 UserName: "String" OldUserPassword: "String" NewUserPassword: "String" SessionType: 0 AuthenticationModuleConfigurationId: 0 UiCulture: "String" DownloadDocumentIdentifier: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ChangePasswordResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" Usersession: Sessionid: 0 Systemreference: 0 Sessionguid: "String" Sessiontype: 0 UiCulture: "String" User: 0 Userloginname: "String" Useremail: "String" Usergroup: 0 Usergroupname: "String" Hostip: "String" IsAdmin: 0 IsImportAdmin: 0 IsBatchDeletionAdmin: 0 IsWorkflowAdmin: 0 ReactivationToken: "String" DisconnectionInterval: 0 Workflowuserstatus: 0 AuthenticationModuleConfigurationId: 0 IsRightsAdmin: 0 IsConstraintsAdmin: 0 IsWorkflowRolesAdmin: 0 IsWorkflowMonitor: 0 Sessionstate: 0 DownloadDocumentIdentifier: "String" DownloadDocumentToken: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/changetype": post: tags: - "Allgemein" summary: "Changes the type of a single object, a list of objects or all objects of the specified type" description: "Operation **ChangeType**.\n\nChanges the type of a single object, a list of objects or all objects of the specified type\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#changetype" operationId: "ChangeType" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ChangeType" example: SessionGuid: "00000000000000000000000000000000" TypeChangeComment: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ChangeTypeResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ObjectsElement: AccessRight: 0 Parentobject: 0 Objecttype: 0 IsLink: false Fulltext: "String" Objectid: 0 Name: "String" Description: "String" Usercreated: 0 Dateedited: "0001-01-01T00:00:00" Useredited: 0 Status: 0 Checkoutuser: 0 Checkoutlocation: "String" Deleteflag: 0 Documentdate: "0001-01-01T00:00:00" Abspath: "String" Otpath: "String" Fileextension: "String" Versioncount: 0 Createdusername: "String" Editedusername: "String" Notecount: 0 Systemreference: 0 Barcode: "String" Documenttype: "String" Voucherdate: "0001-01-01T00:00:00" Vouchertype: "String" Vouchernumber: "String" Externalvouchernumber: "String" Transactionkey: "String" Transactiontype: "String" Validfrom: "0001-01-01T00:00:00" Validuntil: "0001-01-01T00:00:00" Deleteflagsetby: 0 Deleteflagsetdate: "0001-01-01T00:00:00" Hiddenflagsetdate: "0001-01-01T00:00:00" Deletereason: 0 Approvalstatuscode: 0 Approvedby: 0 Approvedversion: 0 Latestversion: 0 Filesize: 0 Filehash: "String" Extmetadata: "String" Mailfrom: "String" Mailto: "String" Mailcc: "String" Mailbcc: "String" Mailsubject: "String" Mailmessageid: "String" Mailsenddate: "0001-01-01T00:00:00" Mailparentmailid: 0 Activeworkflowcount: 0 Relatedobjectscount: 0 Deletereasontext: "String" Updateabspath: 0 Lvl: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/chat": post: tags: - "Allgemein" summary: "Sends a chat message" description: "Operation **Chat**.\n\nSends a chat message\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#chat" operationId: "Chat" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Chat" example: SessionGuid: "00000000000000000000000000000000" ChatMessage: "String" ChatRecipientUser: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ChatResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/commenttask": post: tags: - "Allgemein" summary: "Comments a workflow task" description: "Operation **CommentTask**.\n\nComments a workflow task\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#commenttask" operationId: "CommentTask" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/CommentTask" example: SessionGuid: "00000000000000000000000000000000" Taskid: 0 Taskcomment: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/CommentTaskResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/completetask": post: tags: - "Allgemein" summary: "Completes a workflow task" description: "Operation **CompleteTask**.\n\nCompletes a workflow task\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#completetask" operationId: "CompleteTask" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/CompleteTask" example: SessionGuid: "00000000000000000000000000000000" Taskid: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/CompleteTaskResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/deleteacls": post: tags: - "Allgemein" summary: "Deletes the specified ACL entries" description: "Operation **DeleteAcls**.\n\nDeletes the specified ACL entries\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#deleteacls" operationId: "DeleteAcls" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/DeleteAcls" example: SessionGuid: "00000000000000000000000000000000" SecurityIdList: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/DeleteAclsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/deletedownloads": post: tags: - "Allgemein" summary: "Deletes existing external downloads." description: "Operation **DeleteDownloads**.\n\nDeletes existing external downloads.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#deletedownloads" operationId: "DeleteDownloads" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/DeleteDownloads" example: SessionGuid: "00000000000000000000000000000000" DownloadIds: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/DeleteDownloadsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/deletenote": post: tags: - "Allgemein" summary: "Deletes a note. Requires read permission to the base object." description: "Operation **DeleteNote**.\n\nDeletes a note. Requires read permission to the base object.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#deletenote" operationId: "DeleteNote" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/DeleteNote" example: SessionGuid: "00000000000000000000000000000000" NoteId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/DeleteNoteResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/deleteobjectrelations": post: tags: - "Allgemein" summary: "Deletes existing links (relations) between objects" description: "Operation **DeleteObjectRelations**.\n\nDeletes existing links (relations) between objects\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#deleteobjectrelations" operationId: "DeleteObjectRelations" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/DeleteObjectRelations" example: SessionGuid: "00000000000000000000000000000000" SourceObjectId: 0 RelatedObjectIds: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/DeleteObjectRelationsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/deletesavedqueries": post: tags: - "Allgemein" summary: "Deletes saved queries" description: "Operation **DeleteSavedQueries**.\n\nDeletes saved queries\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#deletesavedqueries" operationId: "DeleteSavedQueries" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/DeleteSavedQueries" example: SessionGuid: "00000000000000000000000000000000" UsersAndQueriesIds: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/DeleteSavedQueriesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/deletestamp": post: tags: - "Allgemein" summary: "Deletes a stamp. Requires local administrator rights." description: "Operation **DeleteStamp**.\n\nDeletes a stamp. Requires local administrator rights.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#deletestamp" operationId: "DeleteStamp" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/DeleteStamp" example: SessionGuid: "00000000000000000000000000000000" StampId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/DeleteStampResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/downloaddoc/{DownloadDocIdentifier}": post: tags: - "Allgemein" summary: "Retrieves a document published for an external downloader" description: "Operation **DownloadDoc**.\n\nRetrieves a document published for an external downloader\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#downloaddoc" operationId: "DownloadDoc" parameters: - name: "DownloadDocIdentifier" in: "path" required: true schema: type: "string" description: "Identifier for external download (guid or named)" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/DownloadDoc" example: DownloadDocIdentifier: "String" DownloadDocToken: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/DownloadDocResponse" example: {} default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/downloaddoc/{DownloadDocIdentifier}/{DownloadDocToken}": post: tags: - "Allgemein" summary: "Retrieves a document published for an external downloader" description: "Operation **DownloadDoc**.\n\nRetrieves a document published for an external downloader\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#downloaddoc" operationId: "DownloadDoc_route2" parameters: - name: "DownloadDocIdentifier" in: "path" required: true schema: type: "string" description: "Identifier for external download (guid or named)" - name: "DownloadDocToken" in: "path" required: true schema: type: "string" description: "Onetime token for verifying external download (guid or named)" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/DownloadDoc" example: DownloadDocIdentifier: "String" DownloadDocToken: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/DownloadDocResponse" example: {} default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/fileupload": post: tags: - "Allgemein" summary: "Perform file uploads (use /fileupload?guid=uploadguid)" description: "Operation **FileUpload**.\n\nPerform file uploads (use /fileupload?guid=uploadguid)\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#fileupload" operationId: "FileUpload" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/FileUpload" example: Guid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/FileUploadResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/generatestamp": post: tags: - "Allgemein" summary: "Generates a stamp for a specific object. Returns the stamp with template processing." description: "Operation **GenerateStamp**.\n\nGenerates a stamp for a specific object. Returns the stamp with template processing.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#generatestamp" operationId: "GenerateStamp" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GenerateStamp" example: SessionGuid: "00000000000000000000000000000000" StampId: 0 ObjectId: 0 InputStamp: Stampid: 0 Name: "String" Template: "String" Thumbnail: "String" Systemreference: 0 Isactive: 0 Position: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GenerateStampResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ResultStamp: Stampid: 0 Name: "String" Template: "String" Thumbnail: "String" Systemreference: 0 Isactive: 0 Position: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/get2fainformation": post: tags: - "Allgemein" summary: "Validates a request for which an extra authentication is needed" description: "Operation **Get2FAInformation**.\n\nValidates a request for which an extra authentication is needed\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#get2fainformation" operationId: "Get2FAInformation" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Get2FAInformation" example: TwoFactorToken: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Get2FAInformationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" Information: - FieldId: 0 FieldName: "String" FieldPrompt: "String" FieldFormat: "String" FieldDescription: "String" FieldType: "String" MultiLine: false Position: 0 Category: "String" Required: false LookupValuesOnly: false LookupValues: - "String" ReadOnly: false Visible: false IsListType: false ClearBeforeShow: false FieldDocumentation: "String" FieldLookupType: "None" FieldLookupFilter: - "String" FieldLookupPluginName: "String" FieldLookupValueMapping: "String" FieldLookupPluginFilter: "String" FieldLookupPluginListener: "String" Masked: false FieldValueString: "String" FieldValueDateTime: "0001-01-01T00:00:00" FieldValueNumeric: 0 FieldValueBool: false FieldValueCurrency: 0 ListValuesString: - "String" ListValuesDateTime: - "0001-01-01T00:00:00" ListValuesNumeric: - 0 ListValuesBool: - false ListValuesCurrency: - 0 CustomFunctions: - "String" CustomRenderer: "String" Dirty: false default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/get2faresponse": post: tags: - "Allgemein" summary: "Gets a by a two factor authentication validated request from the server" description: "Operation **Get2FAResponseRequest**.\n\nGets a by a two factor authentication validated request from the server\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#get2faresponserequest" operationId: "Get2FAResponseRequest" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Get2FAResponseRequest" example: TwoFactorToken: "String" RequestToken: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Get2FAResponseRequestResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getacls": post: tags: - "Allgemein" summary: "Retrieves the access control lists for the supplied objects" description: "Operation **GetAcls**.\n\nRetrieves the access control lists for the supplied objects\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getacls" operationId: "GetAcls" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetAcls" example: SessionGuid: "00000000000000000000000000000000" ObjectIdList: - 0 IncludeSystemAcls: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetAclsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getactiveusersessions": post: tags: - "Allgemein" summary: "Retrieves all active user sessions" description: "Operation **GetActiveUsersessions**.\n\nRetrieves all active user sessions\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getactiveusersessions" operationId: "GetActiveUsersessions" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetActiveUsersessions" example: SessionGuid: "00000000000000000000000000000000" IncludeAllSystems: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetActiveUsersessionsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" Usersessions: - Sessionid: 0 Systemreference: 0 Sessionguid: "String" Sessiontype: 0 UiCulture: "String" User: 0 Userloginname: "String" Useremail: "String" Usergroup: 0 Usergroupname: "String" Hostip: "String" IsAdmin: 0 IsImportAdmin: 0 IsBatchDeletionAdmin: 0 IsWorkflowAdmin: 0 ReactivationToken: "String" DisconnectionInterval: 0 Workflowuserstatus: 0 AuthenticationModuleConfigurationId: 0 IsRightsAdmin: 0 IsConstraintsAdmin: 0 IsWorkflowRolesAdmin: 0 IsWorkflowMonitor: 0 Sessionstate: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getallowedobjecttypeidsforcreation": post: tags: - "Allgemein" summary: "Returns a dictionary with key:object type id, value: list of object type ids the current user can create as sub object" description: "Operation **GetAllowedObjectTypeIdsForCreation**.\n\nReturns a dictionary with key:object type id, value: list of object type ids the current user can create as sub object\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getallowedobjecttypeidsforcreation" operationId: "GetAllowedObjectTypeIdsForCreation" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetAllowedObjectTypeIdsForCreation" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetAllowedObjectTypeIdsForCreationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" AllowedTypesDictionary: "0": - 0 AllowedLocationTypesDictionary: "0": - 0 AllowedWorkflowsDictionary: "0": - Workflowmodelid: 0 Workflowmodelguid: "00000000000000000000000000000000" Systemreference: 0 Workflowmodelversion: 0 Enabled: false Name: "String" Displayname: "String" Description: "String" Category: "String" Dateedited: "0001-01-01T00:00:00" Usercreated: 0 Useredited: 0 Createdusername: "String" Editedusername: "String" Workflowmodeltype: 0 AllowedWorkflowsToMonitor: - Workflowmodelid: 0 Workflowmodelguid: "00000000000000000000000000000000" Systemreference: 0 Workflowmodelversion: 0 Enabled: false Name: "String" Displayname: "String" Description: "String" Category: "String" Dateedited: "0001-01-01T00:00:00" Usercreated: 0 Useredited: 0 Createdusername: "String" Editedusername: "String" Workflowmodeltype: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getauthenticationinformation": post: tags: - "Allgemein" summary: "Retrieves all fields needed for a logon for the authenticationmodul defined by its configurationid" description: "Operation **GetAuthenticationInformation**.\n\nRetrieves all fields needed for a logon for the authenticationmodul defined by its configurationid\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getauthenticationinformation" operationId: "GetAuthenticationInformation" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetAuthenticationInformation" example: AuthenticationModuleConfigurationId: 0 ClientType: 0 ExternalLoginPhase: 0 ExternalLoginContext: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetAuthenticationInformationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" AuthenticationInformation: Values: - FieldId: 0 FieldName: "String" FieldPrompt: "String" FieldFormat: "String" FieldDescription: "String" FieldType: "String" MultiLine: false Position: 0 Category: "String" Required: false LookupValuesOnly: false LookupValues: - "String" ReadOnly: false Visible: false IsListType: false ClearBeforeShow: false FieldDocumentation: "String" FieldLookupType: "None" FieldLookupFilter: - "String" FieldLookupPluginName: "String" FieldLookupValueMapping: "String" FieldLookupPluginFilter: "String" FieldLookupPluginListener: "String" FieldValueString: "String" FieldValueDateTime: "0001-01-01T00:00:00" FieldValueNumeric: 0 FieldValueBool: false FieldValueCurrency: 0 ListValuesString: - "String" ListValuesDateTime: - "0001-01-01T00:00:00" ListValuesNumeric: - 0 ListValuesBool: - false ListValuesCurrency: - 0 CustomFunctions: - "String" CustomRenderer: "String" Masked: false IsReactivationToken: false IsReactivationTokenIndicator: false Dirty: false SessionType: 0 UiCulture: "String" SessionGuid: "00000000000000000000000000000000" LogoutExistingSession: false CallingIpAddress: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getauthenticationmodules": post: tags: - "Allgemein" summary: "Retrieves all possible authenticationmodules for given systemreferenceguid and clientype" description: "Operation **GetAuthenticationModules**.\n\nRetrieves all possible authenticationmodules for given systemreferenceguid and clientype\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getauthenticationmodules" operationId: "GetAuthenticationModules" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetAuthenticationModules" example: RegisteredSystem: 0 ClientType: 0 AuthenticationConfigurationFilter: Values: - FieldId: 0 FieldName: "String" FieldPrompt: "String" FieldFormat: "String" FieldDescription: "String" FieldType: "String" MultiLine: false Position: 0 Category: "String" Required: false LookupValuesOnly: false LookupValues: - "String" ReadOnly: false Visible: false IsListType: false ClearBeforeShow: false FieldDocumentation: "String" FieldLookupType: "None" FieldLookupFilter: - "String" FieldLookupPluginName: "String" FieldLookupValueMapping: "String" FieldLookupPluginFilter: "String" FieldLookupPluginListener: "String" FieldValueString: "String" FieldValueDateTime: "0001-01-01T00:00:00" FieldValueNumeric: 0 FieldValueBool: false FieldValueCurrency: 0 ListValuesString: - "String" ListValuesDateTime: - "0001-01-01T00:00:00" ListValuesNumeric: - 0 ListValuesBool: - false ListValuesCurrency: - 0 CustomFunctions: - "String" CustomRenderer: "String" Masked: false IsReactivationToken: false IsReactivationTokenIndicator: false Dirty: false AuthenticationModuleClassName: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetAuthenticationModulesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getautocompletesuggestions": post: tags: - "Allgemein" summary: "Retrieves autocomplete values for a given term" description: "Operation **GetAutocompleteSuggestions**.\n\nRetrieves autocomplete values for a given term\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getautocompletesuggestions" operationId: "GetAutocompleteSuggestions" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetAutocompleteSuggestions" example: SessionGuid: "00000000000000000000000000000000" SearchTerm: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetAutocompleteSuggestionsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getbackupinformation": post: tags: - "Allgemein" summary: "Returns information about the current state of backup (running or not)" description: "Operation **GetBackupInformation**.\n\nReturns information about the current state of backup (running or not)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getbackupinformation" operationId: "GetBackupInformation" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetBackupInformation" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetBackupInformationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" BackupManagerState: "Ready" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getclientconfiguration": post: tags: - "Allgemein" summary: "Retrieves all configuration values relevant for the client." description: "Operation **GetClientConfiguration**.\n\nRetrieves all configuration values relevant for the client.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getclientconfiguration" operationId: "GetClientConfiguration" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetClientConfiguration" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetClientConfigurationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getconfiguration": post: tags: - "Allgemein" summary: "Retrieves all configuration values (all rows from dwadmin.configuration)" description: "Operation **GetConfiguration**.\n\nRetrieves all configuration values (all rows from dwadmin.configuration)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getconfiguration" operationId: "GetConfiguration" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetConfiguration" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetConfigurationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getdashboard": post: tags: - "Allgemein" summary: "Retrieves dashboard content, a list of current user's recently viewed/edited documents, task and import counters and a newsfeed. Replaces getdashboardcontent." description: "Operation **GetDashboard**.\n\nRetrieves dashboard content, a list of current user's recently viewed/edited documents, task and import counters and a newsfeed. Replaces getdashboardcontent.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getdashboard" operationId: "GetDashboard" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetDashboard" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetDashboardResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" Counters: String: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getdashboardcontent": post: tags: - "Allgemein" summary: "Retrieves dashboard content, e.g. list of recently edited documents. DEPRECATED / not called by docuvita clients anymore. Will be removed 2024." description: "Operation **GetDashboardContent**.\n\nRetrieves dashboard content, e.g. list of recently edited documents. DEPRECATED / not called by docuvita clients anymore. Will be removed 2024.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getdashboardcontent" operationId: "GetDashboardContent" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetDashboardContent" example: SessionGuid: "00000000000000000000000000000000" DashboardContentType: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetDashboardContentResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getdatabaseinformation": post: tags: - "Allgemein" summary: "Returns information about the current database" description: "Operation **GetDatabaseInformation**.\n\nReturns information about the current database\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getdatabaseinformation" operationId: "GetDatabaseInformation" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetDatabaseInformation" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetDatabaseInformationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" DatabaseInformation: Databaseexists: false Isdocuvitadatabase: false Isemptydatabase: false Cancreatedatabase: false Version: Major: 0 Minor: 0 Build: 0 Revision: 0 Engine: "None" Name: "String" Connectionstring: "String" Administrationconnectionstring: "String" UpdateOrCreatePossible: false IndexDirectory: "String" DatabaseManagerState: "Initializing" DatabaseLanguages: - "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getdocument": post: tags: - "Allgemein" summary: "Retrieves the specified version of a document (by version id)" description: "Operation **GetDocument**.\n\nRetrieves the specified version of a document (by version id)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getdocument" operationId: "GetDocument" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetDocument" example: VersionId: 0 ObjectId: 0 CheckOut: false DownloadAsAttachment: false DownloadPreviewDocument: false Comment: "String" DownloadPurpose: "Default" SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetDocumentResponse" example: {} default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getdownloadoperations": post: tags: - "Allgemein" summary: "Retrieves download operations for a specific downloadrecipient set" description: "Operation **GetDownloadOperations**.\n\nRetrieves download operations for a specific downloadrecipient set\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getdownloadoperations" operationId: "GetDownloadOperations" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetDownloadOperations" example: SessionGuid: "00000000000000000000000000000000" Downloadrecipientid: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetDownloadOperationsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getdownloadrecipients": post: tags: - "Allgemein" summary: "Retrieves download recipients for a specific download set" description: "Operation **GetDownloadRecipients**.\n\nRetrieves download recipients for a specific download set\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getdownloadrecipients" operationId: "GetDownloadRecipients" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetDownloadRecipients" example: SessionGuid: "00000000000000000000000000000000" Downloadid: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetDownloadRecipientsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getdownloads": post: tags: - "Allgemein" summary: "Retrieves the list of downloads by various filter criteria" description: "Operation **GetDownloads**.\n\nRetrieves the list of downloads by various filter criteria\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getdownloads" operationId: "GetDownloads" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetDownloads" example: FilterByDownloadId: 0 SessionGuid: "00000000000000000000000000000000" FilterByObjectId: 0 FilterByUserId: 0 FilterByRecipientMailAddress: "String" FilterByDownloadStatus: 0 ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" PageNumber: 0 PageSize: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetDownloadsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getexportset": post: tags: - "Allgemein" summary: "Exports documents and/or objects into a ZIP file" description: "Operation **GetExportSet**.\n\nExports documents and/or objects into a ZIP file\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getexportset" operationId: "GetExportSet" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetExportSet" example: SessionGuid: "00000000000000000000000000000000" SelectedItemsExportSource: "String" ListExportSource: "String" QueryExportSource: "String" ExportDocumentFiles: false ExportPreviewFiles: false MetadataFormat: "None" Recursive: false PrintToPdf: false ZipProtectionPassword: "String" SkipObjectId: false UseOriginalFilename: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetExportSetResponse" example: {} default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getfavorites": post: tags: - "Allgemein" summary: "Retrieves the list of personal favorites" description: "Operation **GetFavorites**.\n\nRetrieves the list of personal favorites\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getfavorites" operationId: "GetFavorites" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetFavorites" example: SessionGuid: "00000000000000000000000000000000" ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetFavoritesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getfieldtypes": post: tags: - "Allgemein" summary: "Retrieves the different field types (maps to Fieldtype in dtoObjecttypedefinition)" description: "Operation **GetFieldTypes**.\n\nRetrieves the different field types (maps to Fieldtype in dtoObjecttypedefinition)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getfieldtypes" operationId: "GetFieldTypes" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetFieldTypes" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetFieldTypesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/gethistory": post: tags: - "Allgemein" summary: "Retrieves the history (dwadmin.logging) entries for the given object" description: "Operation **GetHistory**.\n\nRetrieves the history (dwadmin.logging) entries for the given object\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#gethistory" operationId: "GetHistory" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetHistory" example: SessionGuid: "00000000000000000000000000000000" ObjectId: 0 FilterByUser: "String" FilterEvents: - 0 DocumentsOnly: false PageNumber: 0 PageSize: 0 IncludeReadAccessItems: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetHistoryResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/gethistorymetadata": post: tags: - "Allgemein" summary: "Retrieves the metadata of history entries for the given history entry id (loggingid)" description: "Operation **GetHistoryMetadata**.\n\nRetrieves the metadata of history entries for the given history entry id (loggingid)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#gethistorymetadata" operationId: "GetHistoryMetadata" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetHistoryMetadata" example: SessionGuid: "00000000000000000000000000000000" LoggingId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetHistoryMetadataResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/gethistoryobjectlist": post: tags: - "Allgemein" summary: "Retrieves the last edited or seen objects and or documents" description: "Operation **GetHistoryObjectList**.\n\nRetrieves the last edited or seen objects and or documents\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#gethistoryobjectlist" operationId: "GetHistoryObjectList" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetHistoryObjectList" example: SessionGuid: "00000000000000000000000000000000" ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" HistoryType: 0 ObjectTypeClasses: "String" PageNumber: 0 PageSize: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetHistoryObjectListResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getlist": post: tags: - "Allgemein" summary: "Retrieves one level of the list view (similar to tree view, but all object types)" description: "Operation **GetList**.\n\nRetrieves one level of the list view (similar to tree view, but all object types)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getlist" operationId: "GetList" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetList" example: SessionGuid: "00000000000000000000000000000000" SystemReference: 0 ImpersonationUser: 0 Root: 0 ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" BrowseMode: 0 FilterByObjectTypeIds: - 0 PageNumber: 0 PageSize: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetListResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getlookuppluginresultset": post: tags: - "Allgemein" summary: "Retrieves the result set for a query from a lookup plugin" description: "Operation **GetLookupPluginResultSet**.\n\nRetrieves the result set for a query from a lookup plugin\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getlookuppluginresultset" operationId: "GetLookupPluginResultSet" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetLookupPluginResultSet" example: SessionGuid: "00000000000000000000000000000000" LookupName: "String" QueryDetails: RuleElementType: "OR" Field: "String" Operator: "String" Values: - "String" ResultSortConditions: - FieldId: 0 SortOrder: "NoOrder" PageNumber: 0 PageSize: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetLookupPluginResultSetResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getmailattachment": post: tags: - "Allgemein" summary: "Retrieves an attachment of an archived mail, identified by its version id and the attachment name" description: "Operation **GetMailAttachment**.\n\nRetrieves an attachment of an archived mail, identified by its version id and the attachment name\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getmailattachment" operationId: "GetMailAttachment" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetMailAttachment" example: VersionId: 0 AttachmentName: "String" SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetMailAttachmentResponse" example: {} default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getmailpreview": post: tags: - "Allgemein" summary: "Retrieves details for an archived e-mail document (EML or MSG file format)" description: "Operation **GetMailPreview**.\n\nRetrieves details for an archived e-mail document (EML or MSG file format)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getmailpreview" operationId: "GetMailPreview" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetMailPreview" example: SessionGuid: "00000000000000000000000000000000" VersionId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetMailPreviewResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ObjectId: 0 VersionId: 0 MailFrom: "String" MailTo: "String" MailCc: "String" MailBcc: "String" MailSubject: "String" MailBody: "String" MailBodyIsHtml: false MailAttachments: - "String" MailMessageId: "String" FileFormat: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getmyworkspace": post: tags: - "Allgemein" summary: "Retrieves the list of personal workspace items (e.g. customer records, project files etc.)" description: "Operation **GetMyWorkspace**.\n\nRetrieves the list of personal workspace items (e.g. customer records, project files etc.)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getmyworkspace" operationId: "GetMyWorkspace" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetMyWorkspace" example: SessionGuid: "00000000000000000000000000000000" ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetMyWorkspaceResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getmyworkspacequicksearchresults": post: tags: - "Allgemein" summary: "Retrieves the list of personal workspace items (e.g. customer records, project files etc.)" description: "Operation **GetMyWorkspaceQuicksearchResults**.\n\nRetrieves the list of personal workspace items (e.g. customer records, project files etc.)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getmyworkspacequicksearchresults" operationId: "GetMyWorkspaceQuicksearchResults" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetMyWorkspaceQuicksearchResults" example: SessionGuid: "00000000000000000000000000000000" SearchTerm: "String" ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" PageNumber: 0 PageSize: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetMyWorkspaceQuicksearchResultsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getnotes": post: tags: - "Allgemein" summary: "Retrieves notes by note id or by object id. Requires read permission to the base object" description: "Operation **GetNotes**.\n\nRetrieves notes by note id or by object id. Requires read permission to the base object\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getnotes" operationId: "GetNotes" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetNotes" example: SessionGuid: "00000000000000000000000000000000" FilterByNoteId: 0 FilterByObjectId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetNotesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getobject": post: tags: - "Allgemein" summary: "Retrieves a single object by id" description: "Operation **GetObject**.\n\nRetrieves a single object by id\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getobject" operationId: "GetObject" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetObject" example: SessionGuid: "00000000000000000000000000000000" ObjectId: 0 SubselectPath: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetObjectResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ResultObject: ExBA: "0": Object: 0 Objecttypedefinition: 0 Value: false ExCA: "0": Object: 0 Objecttypedefinition: 0 Value: 0 ExDA: "0": Object: 0 Objecttypedefinition: 0 Value: "0001-01-01T00:00:00" ExNA: "0": Object: 0 Objecttypedefinition: 0 Value: 0 ExSA: "0": Object: 0 Objecttypedefinition: 0 Value: "String" AccessRight: 0 ExTA: "0": Object: 0 Objecttypedefinition: 0 Value: "String" Parentobject: 0 Objecttype: 0 IsLink: false Fulltext: "String" Objectid: 0 Name: "String" Description: "String" Usercreated: 0 Dateedited: "0001-01-01T00:00:00" Useredited: 0 Status: 0 Checkoutuser: 0 Checkoutlocation: "String" Deleteflag: 0 Documentdate: "0001-01-01T00:00:00" Abspath: "String" Otpath: "String" Fileextension: "String" Versioncount: 0 Createdusername: "String" Editedusername: "String" Notecount: 0 Systemreference: 0 Barcode: "String" Documenttype: "String" Voucherdate: "0001-01-01T00:00:00" Vouchertype: "String" Vouchernumber: "String" Externalvouchernumber: "String" Transactionkey: "String" Transactiontype: "String" Validfrom: "0001-01-01T00:00:00" Validuntil: "0001-01-01T00:00:00" Deleteflagsetby: 0 Deleteflagsetdate: "0001-01-01T00:00:00" Hiddenflagsetdate: "0001-01-01T00:00:00" Deletereason: 0 Approvalstatuscode: 0 Approvedby: 0 Approvedversion: 0 Latestversion: 0 Filesize: 0 Filehash: "String" Extmetadata: "String" Mailfrom: "String" Mailto: "String" Mailcc: "String" Mailbcc: "String" Mailsubject: "String" Mailmessageid: "String" Mailsenddate: "0001-01-01T00:00:00" Mailparentmailid: 0 Activeworkflowcount: 0 Relatedobjectscount: 0 Deletereasontext: "String" Updateabspath: 0 Lvl: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getobjectproperties": post: tags: - "Allgemein" summary: "Retrieves all properties of a single object by id, in an easily displayable list" description: "Operation **GetObjectProperties**.\n\nRetrieves all properties of a single object by id, in an easily displayable list\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getobjectproperties" operationId: "GetObjectProperties" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetObjectProperties" example: SessionGuid: "00000000000000000000000000000000" ObjectId: 0 ObjectTypeId: 0 Purpose: "DisplayObject" ParentObject: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetObjectPropertiesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" IsFavorite: false IsWorkspace: false default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getobjectrelations": post: tags: - "Allgemein" summary: "Retrieves related objects" description: "Operation **GetObjectRelations**.\n\nRetrieves related objects\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getobjectrelations" operationId: "GetObjectRelations" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetObjectRelations" example: SessionGuid: "00000000000000000000000000000000" ObjectId: 0 ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" IncludeLinksToObject: false IncludeLinksFromObject: false IncludeRealParentObject: false PageNumber: 0 PageSize: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetObjectRelationsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getobjecttypedefinition": post: tags: - "Allgemein" summary: "Retrieves object type-level defined fields (custom properties)" description: "Operation **GetObjecttypeDefinition**.\n\nRetrieves object type-level defined fields (custom properties)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getobjecttypedefinition" operationId: "GetObjecttypeDefinition" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetObjecttypeDefinition" example: SessionGuid: "00000000000000000000000000000000" FilterById: 0 FilterByObjectTypeId: 0 IncludeHiddenFields: false FilterByName: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetObjecttypeDefinitionResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getobjecttypes": post: tags: - "Allgemein" summary: "Retrieves object types" description: "Operation **GetObjecttypes**.\n\nRetrieves object types\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getobjecttypes" operationId: "GetObjecttypes" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetObjecttypes" example: SessionGuid: "00000000000000000000000000000000" FilterById: 0 FilterByName: "String" FilterByInternalName: "String" MyWorkspaceTypesOnly: false FilterByAccessibilityByCurrentUser: false IncludeHiddenTypes: false RemoveImageData: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetObjecttypesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getqueryresultset": post: tags: - "Allgemein" summary: "Retrieves the result set for a query" description: "Operation **GetQueryResultSet**.\n\nRetrieves the result set for a query\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getqueryresultset" operationId: "GetQueryResultSet" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetQueryResultSet" example: SessionGuid: "00000000000000000000000000000000" Context: SystemReference: 0 ImpersonatedUser: 0 QueryDetails: Constrid: 0 Constraintname: "String" Objecttype: 0 Constrainttype: "String" Systemreference: 0 Extendedconstr: RuleElementType: "OR" Field: "String" Operator: "String" Values: - "String" Constrstatus: 0 IsHierarchic: false ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" BrowseMode: 0 PageNumber: 0 PageSize: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetQueryResultSetResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getsavedqueries": post: tags: - "Allgemein" summary: "Retrieves the list of saved queries (or single items) for the currently logged in user." description: "Operation **GetSavedQueries**.\n\nRetrieves the list of saved queries (or single items) for the currently logged in user.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getsavedqueries" operationId: "GetSavedQueries" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetSavedQueries" example: SessionGuid: "00000000000000000000000000000000" FilterByQueryType: "String" FilterByUsersAndQueriesId: 0 IncludeQueryDetails: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetSavedQueriesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getserviceextensionuploadroutes": post: tags: - "Allgemein" summary: "Retrieves all possible upload endpoints in serviceextensions for the current user session" description: "Operation **GetServiceExtensionUploadRoutes**.\n\nRetrieves all possible upload endpoints in serviceextensions for the current user session\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getserviceextensionuploadroutes" operationId: "GetServiceExtensionUploadRoutes" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetServiceExtensionUploadRoutes" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetServiceExtensionUploadRoutesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getstamps": post: tags: - "Allgemein" summary: "Retrieves stamps for the current user's tenant. Requires local administrator rights." description: "Operation **GetStamps**.\n\nRetrieves stamps for the current user's tenant. Requires local administrator rights.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getstamps" operationId: "GetStamps" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetStamps" example: SessionGuid: "00000000000000000000000000000000" FilterByStampId: 0 FilterByIsActive: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetStampsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/webclient/packages/docuvita/build/resources/docuvita-all-debug": post: tags: - "Allgemein" summary: "Removes an active session from the server" description: "Operation **GetStylesheet**.\n\nRemoves an active session from the server\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getstylesheet" operationId: "GetStylesheet" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetStylesheet" example: Color1: "String" Color2: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetStylesheetResponse" example: {} default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/webclient/docuvita/resources/style": post: tags: - "Allgemein" summary: "Removes an active session from the server" description: "Operation **GetStylesheet**.\n\nRemoves an active session from the server\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getstylesheet" operationId: "GetStylesheet_route2" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetStylesheet" example: Color1: "String" Color2: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetStylesheetResponse" example: {} default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/webclient/docuvita/resources/stylesheet": post: tags: - "Allgemein" summary: "Removes an active session from the server" description: "Operation **GetStylesheet**.\n\nRemoves an active session from the server\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getstylesheet" operationId: "GetStylesheet_route3" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetStylesheet" example: Color1: "String" Color2: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetStylesheetResponse" example: {} default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/webclient/docuvita/resources/getstylesheet": post: tags: - "Allgemein" summary: "Removes an active session from the server" description: "Operation **GetStylesheet**.\n\nRemoves an active session from the server\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getstylesheet" operationId: "GetStylesheet_route4" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetStylesheet" example: Color1: "String" Color2: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetStylesheetResponse" example: {} default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/gettask": post: tags: - "Allgemein" summary: "Retrieves a task, usually to allow a user to complete it" description: "Operation **GetTask**.\n\nRetrieves a task, usually to allow a user to complete it\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#gettask" operationId: "GetTask" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetTask" example: SessionGuid: "00000000000000000000000000000000" Taskid: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetTaskResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TaskElement: Taskid: 0 Workflow: 0 Tasktemplate: "String" Tasktemplatetype: 0 Taskformtype: 0 Taskformdefinition: "String" Tasksystemstate: 0 Taskcomment: "String" Taskdisplayname: "String" Taskdescription: "String" Userlastactivity: 0 Lastactivityusername: "String" Taskresult: "String" Taskdisplayoptions: 0 Lastactivityuseremail: "String" Taskformhtml: "String" Duedate: "0001-01-01T00:00:00" Reminddate: "0001-01-01T00:00:00" Timeoutdate: "0001-01-01T00:00:00" Datesentreminder: "0001-01-01T00:00:00" Datecompleted: "0001-01-01T00:00:00" Workflow_Workflowname: "String" Workflow_Workflowdisplayname: "String" Workflow_Workflowdescription: "String" Workflow_Workflowmodelid: 0 Workflow_Workflowmodeltype: 0 Workflow_Workflowmodelguid: "00000000000000000000000000000000" Workflow_Firstobjectid: 0 Workflow_Firstobjecttypeid: 0 Workflow_Firstobjectelement: AccessRight: 0 Parentobject: 0 Objecttype: 0 IsLink: false Fulltext: "String" Objectid: 0 Name: "String" Description: "String" Usercreated: 0 Dateedited: "0001-01-01T00:00:00" Useredited: 0 Status: 0 Checkoutuser: 0 Checkoutlocation: "String" Deleteflag: 0 Documentdate: "0001-01-01T00:00:00" Abspath: "String" Otpath: "String" Fileextension: "String" Versioncount: 0 Createdusername: "String" Editedusername: "String" Notecount: 0 Systemreference: 0 Barcode: "String" Documenttype: "String" Voucherdate: "0001-01-01T00:00:00" Vouchertype: "String" Vouchernumber: "String" Externalvouchernumber: "String" Transactionkey: "String" Transactiontype: "String" Validfrom: "0001-01-01T00:00:00" Validuntil: "0001-01-01T00:00:00" Deleteflagsetby: 0 Deleteflagsetdate: "0001-01-01T00:00:00" Hiddenflagsetdate: "0001-01-01T00:00:00" Deletereason: 0 Approvalstatuscode: 0 Approvedby: 0 Approvedversion: 0 Latestversion: 0 Filesize: 0 Filehash: "String" Extmetadata: "String" Mailfrom: "String" Mailto: "String" Mailcc: "String" Mailbcc: "String" Mailsubject: "String" Mailmessageid: "String" Mailsenddate: "0001-01-01T00:00:00" Mailparentmailid: 0 Activeworkflowcount: 0 Relatedobjectscount: 0 Deletereasontext: "String" Updateabspath: 0 Lvl: 0 Workflow_Usercreated: 0 Workflow_Createdusername: "String" Workflow_Userlastactivity: 0 Workflow_Lastactivityusername: "String" PreviousTaskCheckout: TaskId: 0 UserId: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/gettasks": post: tags: - "Allgemein" summary: "Retrieves tasks, either to list a user's upcoming tasks or a specific workflow's details" description: "Operation **GetTasks**.\n\nRetrieves tasks, either to list a user's upcoming tasks or a specific workflow's details\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#gettasks" operationId: "GetTasks" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetTasks" example: SessionGuid: "00000000000000000000000000000000" UserId: 0 ObjectId: 0 FilterString: "String" TaskDateCreatedFrom: "0001-01-01T00:00:00" TaskDateCreatedTo: "0001-01-01T00:00:00" PageNumber: 0 PageSize: 0 ResultSortConditions: - SortProperty: "Empty" SortPropertyObject: "Empty" SortOrder: "NoOrder" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetTasksResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getthumbnail": post: tags: - "Allgemein" summary: "Retrieves a thumbnail preview for the requested document, if available" description: "Operation **GetThumbnail**.\n\nRetrieves a thumbnail preview for the requested document, if available\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getthumbnail" operationId: "GetThumbnail" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetThumbnail" example: SessionGuid: "00000000000000000000000000000000" ObjectId: 0 responses: "200": description: "Erfolgreiche Antwort (Antwortstruktur in der Quelle nicht dokumentiert, z.B. Binärinhalt oder leerer Body)" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/gettree": post: tags: - "Allgemein" summary: "Retrieves one level of the tree view" description: "Operation **GetTree**.\n\nRetrieves one level of the tree view\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#gettree" operationId: "GetTree" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetTree" example: SessionGuid: "00000000000000000000000000000000" Context: SystemReference: 0 ImpersonatedUser: 0 Root: 0 ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" BrowseMode: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetTreeResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getusersandgroupslist": post: tags: - "Allgemein" summary: "Retrieves all users and/or groups of the system (e.g. to assign follow-ups)" description: "Operation **GetUsersAndGroupsList**.\n\nRetrieves all users and/or groups of the system (e.g. to assign follow-ups)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getusersandgroupslist" operationId: "GetUsersAndGroupsList" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetUsersAndGroupsList" example: SessionGuid: "00000000000000000000000000000000" IncludeUsers: false IncludeGroups: false IncludeOwnUserAndGroupsOnly: false FilterBySystemReferenceId: 0 IncludeEmptyValue: false FilterByWorkflowRole: - "String" ExcludeInactiveUserAndGroups: false AlwaysIncludeOwnUserAndGroups: false FilterByWorkflowCreator: false FilterByWorkflowLastActiveUser: false FilterByWorkflowAssignee: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetUsersAndGroupsListResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getusersettings": post: tags: - "Allgemein" summary: "Retrieves user settings for the logged in user" description: "Operation **GetUserSettings**.\n\nRetrieves user settings for the logged in user\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getusersettings" operationId: "GetUserSettings" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetUserSettings" example: SessionGuid: "00000000000000000000000000000000" FilterBySettingKey: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetUserSettingsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" RestrictionList: String: RestrictionType: "Client" RestrictionValue: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getvalidationscripts": post: tags: - "Allgemein" summary: "Removes an active session from the server" description: "Operation **GetValidationScripts**.\n\nRemoves an active session from the server\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getvalidationscripts" operationId: "GetValidationScripts" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetValidationScripts" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetValidationScriptsResponse" example: {} default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getversionfulltext": post: tags: - "Allgemein" summary: "Retrieves extracted full text of a document version" description: "Operation **GetVersionFulltext**.\n\nRetrieves extracted full text of a document version\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getversionfulltext" operationId: "GetVersionFulltext" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetVersionFulltext" example: SessionGuid: "00000000000000000000000000000000" VersionId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetVersionFulltextResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" Fulltext: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getversionlist": post: tags: - "Allgemein" summary: "Retrieves a list of document versions for a single document, or retrieves a single version by id" description: "Operation **GetVersionList**.\n\nRetrieves a list of document versions for a single document, or retrieves a single version by id\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getversionlist" operationId: "GetVersionList" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetVersionList" example: SessionGuid: "00000000000000000000000000000000" FilterByObjectId: 0 FilterByVersionId: 0 LatestOnly: false PageNumber: 0 PageSize: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetVersionListResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getworkflowdiagram": post: tags: - "Allgemein" summary: "Retrieves a workflow diagram by ID from the current workflow template, selected from list of dtoWorkflowModel entries" description: "Operation **GetWorkflowDiagram**.\n\nRetrieves a workflow diagram by ID from the current workflow template, selected from list of dtoWorkflowModel entries\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getworkflowdiagram" operationId: "GetWorkflowDiagram" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetWorkflowDiagram" example: SessionGuid: "00000000000000000000000000000000" WorkflowModelId: 0 WorkflowId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetWorkflowDiagramResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" WorkflowTemplate: TaskTemplates: - TaskTemplateName: "String" TaskTemplateDisplayName: "String" TaskTemplateDescription: "String" TaskTemplateType: "End" TaskFormType: "PropertyGrid" TaskFormDefinition: "String" TaskAssignedToRoles: "String" TaskAssignedToUsersAndGroups: "String" TaskTransitions: - IsDefaultTransition: false TaskResult: "String" DestinationTask: "String" TaskActions: - TaskState: "Stopped" Enabled: false ActionClass: "String" StartConditionType: "NoCondition" StartCondition: "String" ActionDescription: "String" TaskDelay: 0 TaskDue: 0 TaskReminder: 0 TaskTimeout: 0 DisplayOptions: 0 TemporaryAccessRights: 0 TaskFormValidationScript: "String" PermanentAccessRights: 0 TaskLayout: Top: 0 Left: 0 LogTaskAssignmentToRoles: false LogTaskAssignmentToUsersAndGroups: false TaskFormHtml: "String" MultiUserTaskAbortResults: - "String" IsAutoTaskWaitForCompleteTask: false ImageSmall: "AA==" ImageMedium: "AA==" ImageLarge: "AA==" TaskDelayWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false TaskDueWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false TaskReminderWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false TaskTimeoutWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false WorkflowValueFormValidationScript: "String" WorkflowWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false GlobalWorkflowActions: - TaskState: "Stopped" Enabled: false ActionClass: "String" StartConditionType: "NoCondition" StartCondition: "String" ActionDescription: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getworkflowlog": post: tags: - "Allgemein" summary: "Gets workflow log entries for a specific workflow" description: "Operation **GetWorkflowLog**.\n\nGets workflow log entries for a specific workflow\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getworkflowlog" operationId: "GetWorkflowLog" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetWorkflowLog" example: SessionGuid: "00000000000000000000000000000000" WorkflowId: 0 FilterEvents: - 0 PageNumber: 0 PageSize: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetWorkflowLogResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getworkflowmodelentries": post: tags: - "Allgemein" summary: "Retrieves stored WorkflowModel objects (will not return workflow definition, entry only)" description: "Operation **GetWorkflowModelEntries**.\n\nRetrieves stored WorkflowModel objects (will not return workflow definition, entry only)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getworkflowmodelentries" operationId: "GetWorkflowModelEntries" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetWorkflowModelEntries" example: SessionGuid: "00000000000000000000000000000000" FilterByWorkflowModelGuid: "String" FilterByWorkflowModelName: "String" FilterByWorkflowModelId: 0 EnabledRecordsOnly: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetWorkflowModelEntriesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getworkflows": post: tags: - "Allgemein" summary: "Retrieves records for existing workflows, stopped or running" description: "Operation **GetWorkflows**.\n\nRetrieves records for existing workflows, stopped or running\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getworkflows" operationId: "GetWorkflows" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetWorkflows" example: SessionGuid: "00000000000000000000000000000000" FilterByWorkflowId: 0 FilterByObjectId: 0 OnlyRunningWorkflows: false FilterByWorkflowModelId: - 0 FilterByAssignedUser: - 0 ResolveGroupsAndRolesForAssignedUser: false FilterByAssignedWorkflowRole: - "String" FilterByResolvingUser: - 0 FilterByErrorEntryExists: false OnlyCompletedWorkflows: false FilterByWarnEntryExists: false OnlyCompletedTasks: false OnlyOpenTasks: false FilterByLastActivityUser: - 0 FilterByCreatedUser: - 0 FilterByCurrentTask: "String" TaskDueDateFrom: "0001-01-01T00:00:00" TaskDueDateTo: "0001-01-01T00:00:00" LastActivityDateFrom: "0001-01-01T00:00:00" LastActivityDateTo: "0001-01-01T00:00:00" PageNumber: 0 PageSize: 0 ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetWorkflowsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getworkflowstartproperties": post: tags: - "Allgemein" summary: "Retrieves all initial properties of a workflow model that need to be set when an instance of this workflow model is started" description: "Operation **GetWorkflowStartProperties**.\n\nRetrieves all initial properties of a workflow model that need to be set when an instance of this workflow model is started\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getworkflowstartproperties" operationId: "GetWorkflowStartProperties" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetWorkflowStartProperties" example: SessionGuid: "00000000000000000000000000000000" WorkflowModelId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetWorkflowStartPropertiesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/getworkflowvalues": post: tags: - "Allgemein" summary: "Retrieves workflow value records for existing workflows, stopped or running" description: "Operation **GetWorkflowValues**.\n\nRetrieves workflow value records for existing workflows, stopped or running\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#getworkflowvalues" operationId: "GetWorkflowValues" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/GetWorkflowValues" example: SessionGuid: "00000000000000000000000000000000" FilterByWorkflowId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/GetWorkflowValuesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/info": post: tags: - "Allgemein" summary: "Shows system and licensing information" description: "Operation **Info**.\n\nShows system and licensing information\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#info" operationId: "Info" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/InfoResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ProductName: "String" ProductVersion: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/maintenancelogin": post: tags: - "Allgemein" summary: "Executes database maintenance login" description: "Operation **MaintenanceLogin**.\n\nExecutes database maintenance login\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#maintenancelogin" operationId: "MaintenanceLogin" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/MaintenanceLogin" example: Username: "String" Password: "String" Language: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/MaintenanceLoginResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" MaintenanceSession: SessionGuid: "00000000000000000000000000000000" UiCulture: "String" DatabaseManagerStatus: "Initializing" ServerIsInMaintenanceMode: false default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/maintenancelogout": post: tags: - "Allgemein" summary: "Executes database maintenance logout" description: "Operation **MaintenanceLogout**.\n\nExecutes database maintenance logout\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#maintenancelogout" operationId: "MaintenanceLogout" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/MaintenanceLogout" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/MaintenanceLogoutResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/migrateoldworkflows": post: tags: - "Allgemein" summary: "Transfers old recall workflows" description: "Operation **MigrateOldWorkflows**.\n\nTransfers old recall workflows\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#migrateoldworkflows" operationId: "MigrateOldWorkflows" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/MigrateOldWorkflows" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/MigrateOldWorkflowsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" MigratedWorkflows: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/prepareserviceextensionupload": post: tags: - "Allgemein" summary: "Prepares an service extension upload and caches its information.Returns a UploadGuid" description: "Operation **PrepareServiceExtensionUpload**.\n\nPrepares an service extension upload and caches its information.Returns a UploadGuid\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#prepareserviceextensionupload" operationId: "PrepareServiceExtensionUpload" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/PrepareServiceExtensionUpload" example: SessionGuid: "00000000000000000000000000000000" Route: ServiceExtensionName: "String" UploadRoute: "String" CommandText: "String" CommandTitle: "String" CommandDescription: "String" ScanFileTypes: 0 BarcodeSettings: ScanInterval: 0 ExpectedBarcodes: 0 AutomaticRecognition: false RenderPdfPages: false ConvertToPdf: false BarcodeParserList: - Name: "String" Description: "String" Enabled: false RecognitionBarcodeType: 0 BarcodeFieldName: "String" Pattern: "String" BarcodeScanDirection: 0 MarginTop: 0 MarginLeft: 0 MarginRight: 0 MarginBottom: 0 ConvertToBitonal: false AppendMultipleMatchedBarcodes: false SkipBlankPages: false SkipPagesWithoutMatchingBarcodes: false GatherTestResults: false MarkDocAsPdfA: false RenderPdfAndImport: false BarcodeObjecttype: 0 BarcodeObjecttypeDefintion: 0 BarcodeDisplayPathSelector: "String" BarcodeFieldName: "String" UploadInformation: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/PrepareServiceExtensionUploadResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" UploadGuid: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/readbackupfile": post: tags: - "Allgemein" summary: "Returns information about an backup" description: "Operation **ReadBackupFile**.\n\nReturns information about an backup\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#readbackupfile" operationId: "ReadBackupFile" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ReadBackupFile" example: SessionGuid: "00000000000000000000000000000000" BackupFile: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ReadBackupFileResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" BackupInstruction: Guid: "String" Name: "String" JobId: 0 Id: 0 TempFolder: "String" TempSpaceNeeded: "String" BackupStoreFolder: "String" BackupFolder: "String" BinaryFolder: "String" PartSize: 0 Timeout: 0 IncludeFilesytem: false IncludeIndex: false RegisteredSystemsInformation: - Systemreferenceid: 0 Systemname: "String" Systemguid: "String" IsRemote: 0 Remotehost: "String" Remoteport: 0 Systemstatus: 0 Admingroup: 0 Filestoreaddress: "String" Importstoreaddress: "String" Importgroup: 0 Systemalias: "String" Deleteadmingroup: 0 Deletemode: 0 Workflowadmingroup: 0 Mailconfiguration: "String" Defaultpassword: "String" Mailnewuserpassword: 0 Defaultculture: "String" Signatureconfig: "String" Crypttype: 0 Constraintsadmingroup: 0 Rightsadmingroup: 0 Workflowrolesadmingroup: 0 Externalusergroup: 0 Systemurl: "String" Objectlogdbaddress: "String" Importlogdbaddress: "String" Primarycolor: "String" Secondarycolor: "String" Logosmall: "AA==" Logomedium: "AA==" Logolarge: "AA==" Logoxlarge: "AA==" DocumentCount: 0 ObjectCount: 0 DocumentSpace: "String" ImportSpace: "String" DatabaseConfiguration: String: "String" DatabaseEngine: "None" Successful: false default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/refreshsession": post: tags: - "Allgemein" summary: "Refreshes an active session on the server (resets timeout for session expiry)" description: "Operation **RefreshSession**.\n\nRefreshes an active session on the server (resets timeout for session expiry)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#refreshsession" operationId: "RefreshSession" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/RefreshSession" example: SessionGuid: "00000000000000000000000000000000" UiCulture: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/RefreshSessionResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" Usersession: Sessionid: 0 Systemreference: 0 Sessionguid: "String" Sessiontype: 0 UiCulture: "String" User: 0 Userloginname: "String" Useremail: "String" Usergroup: 0 Usergroupname: "String" Hostip: "String" IsAdmin: 0 IsImportAdmin: 0 IsBatchDeletionAdmin: 0 IsWorkflowAdmin: 0 ReactivationToken: "String" DisconnectionInterval: 0 Workflowuserstatus: 0 AuthenticationModuleConfigurationId: 0 IsRightsAdmin: 0 IsConstraintsAdmin: 0 IsWorkflowRolesAdmin: 0 IsWorkflowMonitor: 0 Sessionstate: 0 License: ProductType: "String" NeedsReactivationInDays: 0 LicenseHolderName: "String" ProductName: "String" LicenseHolderCity: "String" LicenseHolderZipCode: "String" LicenseHolderStreet: "String" VendorName: "String" VendorSite: "https://string/" VendorContactMail: "String" ContractNumber: "String" VendorContactPhone: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/registeredsystems": post: tags: - "Allgemein" summary: "Retrieves all registered systems on this server (=tenants/clients)" description: "Operation **RegisteredSystems**.\n\nRetrieves all registered systems on this server (=tenants/clients)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#registeredsystems" operationId: "RegisteredSystems" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/RegisteredSystems" example: SessionGuid: "00000000000000000000000000000000" FilterByRegisteredSystemGuid: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/RegisteredSystemsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/removedeleteflag": post: tags: - "Allgemein" summary: "Removes the delete flag on the specified objects" description: "Operation **RemoveDeleteFlag**.\n\nRemoves the delete flag on the specified objects\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#removedeleteflag" operationId: "RemoveDeleteFlag" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/RemoveDeleteFlag" example: SessionGuid: "00000000000000000000000000000000" DeleteFlagElements: - DeleteReason: "Other" ObjectId: 0 IncludeSubItems: false DeleteReasonText: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/RemoveDeleteFlagResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/removefromfavorites": post: tags: - "Allgemein" summary: "Removes objects from personal favorites" description: "Operation **RemoveFromFavorites**.\n\nRemoves objects from personal favorites\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#removefromfavorites" operationId: "RemoveFromFavorites" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/RemoveFromFavorites" example: SessionGuid: "00000000000000000000000000000000" ObjectIds: - 0 UserId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/RemoveFromFavoritesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/removefrommyworkspace": post: tags: - "Allgemein" summary: "Removes objects from the personal workspace" description: "Operation **RemoveFromMyWorkspace**.\n\nRemoves objects from the personal workspace\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#removefrommyworkspace" operationId: "RemoveFromMyWorkspace" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/RemoveFromMyWorkspace" example: SessionGuid: "00000000000000000000000000000000" ObjectIds: - 0 UserId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/RemoveFromMyWorkspaceResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/removeversiondeleteflag": post: tags: - "Allgemein" summary: "Removes a delete flag from a single document version" description: "Operation **RemoveVersionDeleteFlag**.\n\nRemoves a delete flag from a single document version\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#removeversiondeleteflag" operationId: "RemoveVersionDeleteFlag" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/RemoveVersionDeleteFlag" example: SessionGuid: "00000000000000000000000000000000" VersionId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/RemoveVersionDeleteFlagResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/resetuserpassword": post: tags: - "Allgemein" summary: "Resets a user's password to the default value" description: "Operation **ResetUserPassword**.\n\nResets a user's password to the default value\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#resetuserpassword" operationId: "ResetUserPassword" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ResetUserPassword" example: SessionGuid: "00000000000000000000000000000000" UserId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ResetUserPasswordResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/saveadvancedquery": post: tags: - "Allgemein" summary: "Stores an advanced or profile query to allow for later re-issuing the query by current user or other group members" description: "Operation **SaveAdvancedQuery**.\n\nStores an advanced or profile query to allow for later re-issuing the query by current user or other group members\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#saveadvancedquery" operationId: "SaveAdvancedQuery" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SaveAdvancedQuery" example: SessionGuid: "00000000000000000000000000000000" UsersandqueriesObject: Usersandqueriesid: 0 Userid: 0 Queryid: 0 Querytype: "String" Querydescription: "String" Simplequerytext: "String" QueryDefinition: Constrid: 0 Constraintname: "String" Objecttype: 0 Constrainttype: "String" Systemreference: 0 Extendedconstr: RuleElementType: "OR" Field: "String" Operator: "String" Values: - "String" Constrstatus: 0 IsHierarchic: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SaveAdvancedQueryResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" SavedQuery: Usersandqueriesid: 0 Userid: 0 Queryid: 0 Querytype: "String" Querydescription: "String" Simplequerytext: "String" SavedQueryDefinition: Constrid: 0 Constraintname: "String" Objecttype: 0 Constrainttype: "String" Systemreference: 0 Extendedconstr: RuleElementType: "OR" Field: "String" Operator: "String" Values: - "String" Constrstatus: 0 IsHierarchic: false default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/savesimplequery": post: tags: - "Allgemein" summary: "Stores a query string to allow for re-entering the search term by current user or other group members" description: "Operation **SaveSimpleQuery**.\n\nStores a query string to allow for re-entering the search term by current user or other group members\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#savesimplequery" operationId: "SaveSimpleQuery" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SaveSimpleQuery" example: SessionGuid: "00000000000000000000000000000000" UsersandqueriesObject: Usersandqueriesid: 0 Userid: 0 Queryid: 0 Querytype: "String" Querydescription: "String" Simplequerytext: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SaveSimpleQueryResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" SavedQuery: Usersandqueriesid: 0 Userid: 0 Queryid: 0 Querytype: "String" Querydescription: "String" Simplequerytext: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setacls": post: tags: - "Allgemein" summary: "Saves the submitted ACL entries" description: "Operation **SetAcls**.\n\nSaves the submitted ACL entries\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setacls" operationId: "SetAcls" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetAcls" example: SessionGuid: "00000000000000000000000000000000" AclList: - SecuserObject: AccessRight: 0 Parentobject: 0 Objecttype: 0 IsLink: false Fulltext: "String" Objectid: 0 Name: "String" Description: "String" Usercreated: 0 Dateedited: "0001-01-01T00:00:00" Useredited: 0 Status: 0 Checkoutuser: 0 Checkoutlocation: "String" Deleteflag: 0 Documentdate: "0001-01-01T00:00:00" Abspath: "String" Otpath: "String" Fileextension: "String" Versioncount: 0 Createdusername: "String" Editedusername: "String" Notecount: 0 Systemreference: 0 Barcode: "String" Documenttype: "String" Voucherdate: "0001-01-01T00:00:00" Vouchertype: "String" Vouchernumber: "String" Externalvouchernumber: "String" Transactionkey: "String" Transactiontype: "String" Validfrom: "0001-01-01T00:00:00" Validuntil: "0001-01-01T00:00:00" Deleteflagsetby: 0 Deleteflagsetdate: "0001-01-01T00:00:00" Hiddenflagsetdate: "0001-01-01T00:00:00" Deletereason: 0 Approvalstatuscode: 0 Approvedby: 0 Approvedversion: 0 Latestversion: 0 Filesize: 0 Filehash: "String" Extmetadata: "String" Mailfrom: "String" Mailto: "String" Mailcc: "String" Mailbcc: "String" Mailsubject: "String" Mailmessageid: "String" Mailsenddate: "0001-01-01T00:00:00" Mailparentmailid: 0 Activeworkflowcount: 0 Relatedobjectscount: 0 Deletereasontext: "String" Updateabspath: 0 Lvl: 0 SecruleObject: Constrid: 0 Constraintname: "String" Objecttype: 0 Constrainttype: "String" Systemreference: 0 Extendedconstr: RuleElementType: "OR" Field: "String" Operator: "String" Values: - "String" Constrstatus: 0 IsHierarchic: false Securityid: 0 Secobject: 0 Secuser: 0 Secrule: 0 Sectype: 0 Secright: 0 Usercreated: 0 Createdusername: "String" Dateedited: "0001-01-01T00:00:00" Useredited: 0 Editedusername: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetAclsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setdeleteflag": post: tags: - "Allgemein" summary: "Sets the delete flag on the specified objects" description: "Operation **SetDeleteFlag**.\n\nSets the delete flag on the specified objects\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setdeleteflag" operationId: "SetDeleteFlag" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetDeleteFlag" example: SessionGuid: "00000000000000000000000000000000" DeleteFlagElements: - DeleteReason: "Other" ObjectId: 0 IncludeSubItems: false DeleteReasonText: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetDeleteFlagResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setdownload": post: tags: - "Allgemein" summary: "Creates a new external download for a document" description: "Operation **SetDownload**.\n\nCreates a new external download for a document\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setdownload" operationId: "SetDownload" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetDownload" example: SessionGuid: "00000000000000000000000000000000" Download: Downloadid: 0 Object: 0 Version: 0 Usercreated: 0 Createdusername: "String" Dltype: 0 Name: "String" Description: "String" Mailsubject: "String" Mailbody: "String" Alloweddlqty: 0 Downloadstatus: 0 DownloadRecipients: - Downloadrecipientid: 0 Download: 0 Recipientuser: 0 Url: "String" Recipientuserstatus: 0 Downloadquantity: 0 DownloadRecipients: - Downloadrecipientid: 0 Download: 0 Recipientuser: 0 Url: "String" Recipientuserstatus: 0 Downloadquantity: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetDownloadResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" Download: Downloadid: 0 Object: 0 Version: 0 Usercreated: 0 Createdusername: "String" Dltype: 0 Name: "String" Description: "String" Mailsubject: "String" Mailbody: "String" Alloweddlqty: 0 Downloadstatus: 0 DownloadRecipients: - Downloadrecipientid: 0 Download: 0 Recipientuser: 0 Url: "String" Recipientuserstatus: 0 Downloadquantity: 0 DownloadRecipients: - Downloadrecipientid: 0 Download: 0 Recipientuser: 0 Url: "String" Recipientuserstatus: 0 Downloadquantity: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setfirstregisteredsystem": post: tags: - "Allgemein" summary: "Sets the first registered system" description: "Operation **SetFirstRegisteredSystem**.\n\nSets the first registered system\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setfirstregisteredsystem" operationId: "SetFirstRegisteredSystem" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetFirstRegisteredSystem" example: SessionGuid: "00000000000000000000000000000000" FileStoreAddress: "String" ImportStoreAddress: "String" Systemname: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetFirstRegisteredSystemResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setindexdirectory": post: tags: - "Allgemein" summary: "Sets the location where the index is created" description: "Operation **SetIndexDirectory**.\n\nSets the location where the index is created\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setindexdirectory" operationId: "SetIndexDirectory" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetIndexDirectory" example: SessionGuid: "00000000000000000000000000000000" IndexDirectory: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetIndexDirectoryResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setnote": post: tags: - "Allgemein" summary: "Saves a new/edited note. Requires read permission to the base object" description: "Operation **SetNote**.\n\nSaves a new/edited note. Requires read permission to the base object\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setnote" operationId: "SetNote" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetNote" example: SessionGuid: "00000000000000000000000000000000" NoteToSave: Noteid: 0 Object: 0 Notetext: "String" Importance: 0 Dateedited: "0001-01-01T00:00:00" Usercreated: 0 Createdusername: "String" Useredited: 0 Editedusername: "String" Notestate: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetNoteResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ResultNote: Noteid: 0 Object: 0 Notetext: "String" Importance: 0 Dateedited: "0001-01-01T00:00:00" Usercreated: 0 Createdusername: "String" Useredited: 0 Editedusername: "String" Notestate: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setnotestate": post: tags: - "Allgemein" summary: "Locks or unlocks a note (deletion not possible except for creator). Requires read permission to the base object." description: "Operation **SetNoteState**.\n\nLocks or unlocks a note (deletion not possible except for creator). Requires read permission to the base object.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setnotestate" operationId: "SetNoteState" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetNoteState" example: SessionGuid: "00000000000000000000000000000000" NewNoteState: 0 NoteId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetNoteStateResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setobject": post: tags: - "Allgemein" summary: "Creates or edits an object" description: "Operation **SetObject**.\n\nCreates or edits an object\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setobject" operationId: "SetObject" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetObject" example: SessionGuid: "00000000000000000000000000000000" ObjectToSave: ExBA: "0": Object: 0 Objecttypedefinition: 0 Value: false ExCA: "0": Object: 0 Objecttypedefinition: 0 Value: 0 ExDA: "0": Object: 0 Objecttypedefinition: 0 Value: "0001-01-01T00:00:00" ExNA: "0": Object: 0 Objecttypedefinition: 0 Value: 0 ExSA: "0": Object: 0 Objecttypedefinition: 0 Value: "String" AccessRight: 0 ExTA: "0": Object: 0 Objecttypedefinition: 0 Value: "String" Parentobject: 0 Objecttype: 0 IsLink: false Fulltext: "String" Objectid: 0 Name: "String" Description: "String" Usercreated: 0 Dateedited: "0001-01-01T00:00:00" Useredited: 0 Status: 0 Checkoutuser: 0 Checkoutlocation: "String" Deleteflag: 0 Documentdate: "0001-01-01T00:00:00" Abspath: "String" Otpath: "String" Fileextension: "String" Versioncount: 0 Createdusername: "String" Editedusername: "String" Notecount: 0 Systemreference: 0 Barcode: "String" Documenttype: "String" Voucherdate: "0001-01-01T00:00:00" Vouchertype: "String" Vouchernumber: "String" Externalvouchernumber: "String" Transactionkey: "String" Transactiontype: "String" Validfrom: "0001-01-01T00:00:00" Validuntil: "0001-01-01T00:00:00" Deleteflagsetby: 0 Deleteflagsetdate: "0001-01-01T00:00:00" Hiddenflagsetdate: "0001-01-01T00:00:00" Deletereason: 0 Approvalstatuscode: 0 Approvedby: 0 Approvedversion: 0 Latestversion: 0 Filesize: 0 Filehash: "String" Extmetadata: "String" Mailfrom: "String" Mailto: "String" Mailcc: "String" Mailbcc: "String" Mailsubject: "String" Mailmessageid: "String" Mailsenddate: "0001-01-01T00:00:00" Mailparentmailid: 0 Activeworkflowcount: 0 Relatedobjectscount: 0 Deletereasontext: "String" Updateabspath: 0 Lvl: 0 VersionOriginalFilename: "String" VersionComment: "String" VersionExternalMetadata: "String" VersionNumber: VersionIncrementStyle: "NoVersionIncrement" VersionMajor: 0 VersionMinor: 0 VersionRevision: 0 VersionLabel: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetObjectResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" SavedObject: ExBA: "0": Object: 0 Objecttypedefinition: 0 Value: false ExCA: "0": Object: 0 Objecttypedefinition: 0 Value: 0 ExDA: "0": Object: 0 Objecttypedefinition: 0 Value: "0001-01-01T00:00:00" ExNA: "0": Object: 0 Objecttypedefinition: 0 Value: 0 ExSA: "0": Object: 0 Objecttypedefinition: 0 Value: "String" AccessRight: 0 ExTA: "0": Object: 0 Objecttypedefinition: 0 Value: "String" Parentobject: 0 Objecttype: 0 IsLink: false Fulltext: "String" Objectid: 0 Name: "String" Description: "String" Usercreated: 0 Dateedited: "0001-01-01T00:00:00" Useredited: 0 Status: 0 Checkoutuser: 0 Checkoutlocation: "String" Deleteflag: 0 Documentdate: "0001-01-01T00:00:00" Abspath: "String" Otpath: "String" Fileextension: "String" Versioncount: 0 Createdusername: "String" Editedusername: "String" Notecount: 0 Systemreference: 0 Barcode: "String" Documenttype: "String" Voucherdate: "0001-01-01T00:00:00" Vouchertype: "String" Vouchernumber: "String" Externalvouchernumber: "String" Transactionkey: "String" Transactiontype: "String" Validfrom: "0001-01-01T00:00:00" Validuntil: "0001-01-01T00:00:00" Deleteflagsetby: 0 Deleteflagsetdate: "0001-01-01T00:00:00" Hiddenflagsetdate: "0001-01-01T00:00:00" Deletereason: 0 Approvalstatuscode: 0 Approvedby: 0 Approvedversion: 0 Latestversion: 0 Filesize: 0 Filehash: "String" Extmetadata: "String" Mailfrom: "String" Mailto: "String" Mailcc: "String" Mailbcc: "String" Mailsubject: "String" Mailmessageid: "String" Mailsenddate: "0001-01-01T00:00:00" Mailparentmailid: 0 Activeworkflowcount: 0 Relatedobjectscount: 0 Deletereasontext: "String" Updateabspath: 0 Lvl: 0 DocUploadGuid: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setobjectproperties": post: tags: - "Allgemein" summary: "Creates or edits an object using a list of object properties, as received via GetObjectProperties" description: "Operation **SetObjectProperties**.\n\nCreates or edits an object using a list of object properties, as received via GetObjectProperties\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setobjectproperties" operationId: "SetObjectProperties" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetObjectProperties" example: SessionGuid: "00000000000000000000000000000000" Context: SystemReference: 0 ImpersonatedUser: 0 VersionOriginalFilename: "String" VersionComment: "String" VersionExternalMetadata: "String" VersionNumber: VersionIncrementStyle: "NoVersionIncrement" VersionMajor: 0 VersionMinor: 0 VersionRevision: 0 VersionLabel: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetObjectPropertiesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" DocUploadGuid: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setobjectrelations": post: tags: - "Allgemein" summary: "Creates or updates links (relations) between objects" description: "Operation **SetObjectRelations**.\n\nCreates or updates links (relations) between objects\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setobjectrelations" operationId: "SetObjectRelations" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetObjectRelations" example: SessionGuid: "00000000000000000000000000000000" Context: SystemReference: 0 ImpersonatedUser: 0 SourceObjectId: 0 RelatedObjectIds: - 0 LinkComment: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetObjectRelationsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setparent": post: tags: - "Allgemein" summary: "Relocates objects to a new parent id" description: "Operation **SetParent**.\n\nRelocates objects to a new parent id\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setparent" operationId: "SetParent" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetParent" example: SessionGuid: "00000000000000000000000000000000" ObjectIds: - 0 NewParentObject: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetParentResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setstamp": post: tags: - "Allgemein" summary: "Saves a new/edited stamp. Requires local administrator rights." description: "Operation **SetStamp**.\n\nSaves a new/edited stamp. Requires local administrator rights.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setstamp" operationId: "SetStamp" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetStamp" example: SessionGuid: "00000000000000000000000000000000" StampToSave: Stampid: 0 Name: "String" Template: "String" Thumbnail: "String" Systemreference: 0 Isactive: 0 Position: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetStampResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ResultStamp: Stampid: 0 Name: "String" Template: "String" Thumbnail: "String" Systemreference: 0 Isactive: 0 Position: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setusersetting": post: tags: - "Allgemein" summary: "Stores a user setting for the logged in user" description: "Operation **SetUserSetting**.\n\nStores a user setting for the logged in user\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setusersetting" operationId: "SetUserSetting" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetUserSetting" example: SessionGuid: "00000000000000000000000000000000" UserSetting: Settingkey: "String" Settingtext: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetUserSettingResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setversion": post: tags: - "Allgemein" summary: "Stores a new document version record to an existing object" description: "Operation **SetVersion**.\n\nStores a new document version record to an existing object\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setversion" operationId: "SetVersion" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetVersion" example: SessionGuid: "00000000000000000000000000000000" ObjectId: 0 CheckIn: false VersionOriginalFilename: "String" VersionComment: "String" VersionExternalMetadata: "String" VersionNumber: VersionIncrementStyle: "NoVersionIncrement" VersionMajor: 0 VersionMinor: 0 VersionRevision: 0 VersionLabel: "String" AppendToPrevious: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetVersionResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" DocUploadGuid: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setversiondeleteflag": post: tags: - "Allgemein" summary: "Flags a single document version to be deleted. Can only be used if at least one version remains un-deleted." description: "Operation **SetVersionDeleteFlag**.\n\nFlags a single document version to be deleted. Can only be used if at least one version remains un-deleted.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setversiondeleteflag" operationId: "SetVersionDeleteFlag" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetVersionDeleteFlag" example: SessionGuid: "00000000000000000000000000000000" VersionId: 0 ForceLastVersionDelete: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetVersionDeleteFlagResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setversionfulltext": post: tags: - "Allgemein" summary: "Writes full text data back to a document version for indexing. This allows e.g. OCR'ed fulltext to be corrected." description: "Operation **SetVersionFulltext**.\n\nWrites full text data back to a document version for indexing. This allows e.g. OCR'ed fulltext to be corrected.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setversionfulltext" operationId: "SetVersionFulltext" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetVersionFulltext" example: SessionGuid: "00000000000000000000000000000000" VersionId: 0 Fulltext: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetVersionFulltextResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/setversionnumber": post: tags: - "Allgemein" summary: "Sets version number for existing a document version" description: "Operation **SetVersionNumber**.\n\nSets version number for existing a document version\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#setversionnumber" operationId: "SetVersionNumber" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SetVersionNumber" example: SessionGuid: "00000000000000000000000000000000" VersionId: 0 VersionNumber: VersionIncrementStyle: "NoVersionIncrement" VersionMajor: 0 VersionMinor: 0 VersionRevision: 0 VersionLabel: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SetVersionNumberResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/startbackup": post: tags: - "Allgemein" summary: "Starts backup" description: "Operation **StartBackup**.\n\nStarts backup\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#startbackup" operationId: "StartBackup" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/StartBackup" example: SessionGuid: "00000000000000000000000000000000" BackupInstruction: Guid: "String" Name: "String" JobId: 0 Id: 0 TempFolder: "String" TempSpaceNeeded: "String" BackupStoreFolder: "String" BackupFolder: "String" BinaryFolder: "String" PartSize: 0 Timeout: 0 IncludeFilesytem: false IncludeIndex: false RegisteredSystemsInformation: - Systemreferenceid: 0 Systemname: "String" Systemguid: "String" IsRemote: 0 Remotehost: "String" Remoteport: 0 Systemstatus: 0 Admingroup: 0 Filestoreaddress: "String" Importstoreaddress: "String" Importgroup: 0 Systemalias: "String" Deleteadmingroup: 0 Deletemode: 0 Workflowadmingroup: 0 Mailconfiguration: "String" Defaultpassword: "String" Mailnewuserpassword: 0 Defaultculture: "String" Signatureconfig: "String" Crypttype: 0 Constraintsadmingroup: 0 Rightsadmingroup: 0 Workflowrolesadmingroup: 0 Externalusergroup: 0 Systemurl: "String" Objectlogdbaddress: "String" Importlogdbaddress: "String" Primarycolor: "String" Secondarycolor: "String" Logosmall: "AA==" Logomedium: "AA==" Logolarge: "AA==" Logoxlarge: "AA==" DocumentCount: 0 ObjectCount: 0 DocumentSpace: "String" ImportSpace: "String" DatabaseConfiguration: String: "String" DatabaseEngine: "None" Successful: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/StartBackupResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/startrestore": post: tags: - "Allgemein" summary: "Starts the restoring of a choosen backupfile" description: "Operation **StartRestore**.\n\nStarts the restoring of a choosen backupfile\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#startrestore" operationId: "StartRestore" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/StartRestore" example: SessionGuid: "00000000000000000000000000000000" BackupInstruction: Guid: "String" Name: "String" JobId: 0 Id: 0 TempFolder: "String" TempSpaceNeeded: "String" BackupStoreFolder: "String" BackupFolder: "String" BinaryFolder: "String" PartSize: 0 Timeout: 0 IncludeFilesytem: false IncludeIndex: false RegisteredSystemsInformation: - Systemreferenceid: 0 Systemname: "String" Systemguid: "String" IsRemote: 0 Remotehost: "String" Remoteport: 0 Systemstatus: 0 Admingroup: 0 Filestoreaddress: "String" Importstoreaddress: "String" Importgroup: 0 Systemalias: "String" Deleteadmingroup: 0 Deletemode: 0 Workflowadmingroup: 0 Mailconfiguration: "String" Defaultpassword: "String" Mailnewuserpassword: 0 Defaultculture: "String" Signatureconfig: "String" Crypttype: 0 Constraintsadmingroup: 0 Rightsadmingroup: 0 Workflowrolesadmingroup: 0 Externalusergroup: 0 Systemurl: "String" Objectlogdbaddress: "String" Importlogdbaddress: "String" Primarycolor: "String" Secondarycolor: "String" Logosmall: "AA==" Logomedium: "AA==" Logolarge: "AA==" Logoxlarge: "AA==" DocumentCount: 0 ObjectCount: 0 DocumentSpace: "String" ImportSpace: "String" DatabaseConfiguration: String: "String" DatabaseEngine: "None" Successful: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/StartRestoreResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/startworkflow": post: tags: - "Allgemein" summary: "Starts a new workflow" description: "Operation **StartWorkflow**.\n\nStarts a new workflow\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#startworkflow" operationId: "StartWorkflow" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/StartWorkflow" example: SessionGuid: "00000000000000000000000000000000" WorkflowModelId: 0 SkipStartingWhenRunningWorkflowExists: false OneWorkflowPerObject: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/StartWorkflowResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" Workflow: Workflowid: 0 Systemreference: 0 Workflowmodel: 0 IsRunning: 0 Currenttask: 0 Currenttaskdisplayname: "String" Currenttasktemplate: "String" Usercreated: 0 Createdusername: "String" Createduseremail: "String" Workflowname: "String" Workflowdisplayname: "String" Workflowdescription: "String" Userlastactivity: 0 Lastactivityusername: "String" Lastactivityuseremail: "String" Firstobjectid: 0 Firstobjecttypeid: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/stopworkflow": post: tags: - "Allgemein" summary: "Stops a running workflow immediately" description: "Operation **StopWorkflow**.\n\nStops a running workflow immediately\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#stopworkflow" operationId: "StopWorkflow" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/StopWorkflow" example: SessionGuid: "00000000000000000000000000000000" WorkflowId: 0 TerminationComment: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/StopWorkflowResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/toggletaskcheckoutstate": post: tags: - "Allgemein" summary: "Informs the server that a user has taken or closed (but not completed) a specific task. It remains open for this and/or other users." description: "Operation **ToggleTaskCheckoutState**.\n\nInforms the server that a user has taken or closed (but not completed) a specific task. It remains open for this and/or other users.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#toggletaskcheckoutstate" operationId: "ToggleTaskCheckoutState" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ToggleTaskCheckoutState" example: SessionGuid: "00000000000000000000000000000000" Taskid: 0 NewCheckoutState: "Nothing" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ToggleTaskCheckoutStateResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/transferoldindex": post: tags: - "Allgemein" summary: "Updates the current database" description: "Operation **TransferOldIndex**.\n\nUpdates the current database\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#transferoldindex" operationId: "TransferOldIndex" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/TransferOldIndex" example: SessionGuid: "00000000000000000000000000000000" IndexRepositoryPath: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/TransferOldIndexResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/unlock": post: tags: - "Allgemein" summary: "Unlocks a document when it has been checked out without the need to check in a new document version" description: "Operation **Unlock**.\n\nUnlocks a document when it has been checked out without the need to check in a new document version\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#unlock" operationId: "Unlock" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Unlock" example: SessionGuid: "00000000000000000000000000000000" ObjectId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/UnlockResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/updatedatabase": post: tags: - "Allgemein" summary: "Updates the current database" description: "Operation **UpdateDatabase**.\n\nUpdates the current database\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#updatedatabase" operationId: "UpdateDatabase" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/UpdateDatabase" example: SessionGuid: "00000000000000000000000000000000" Language: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/UpdateDatabaseResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ApiConnectionKey: "String" SystemPassword: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/userlogin": post: tags: - "Allgemein" summary: "Creates a new user session" description: "Operation **UserLogin**.\n\nCreates a new user session\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#userlogin" operationId: "UserLogin" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/UserLogin" example: SystemReferenceId: 0 UserName: "String" UserPassword: "String" UserDomain: "String" PerformIntegratedUserLogin: false AuthenticationModuleConfigurationId: 0 LogoutExistingSession: false SessionType: 0 UiCulture: "String" SessionGuid: "00000000000000000000000000000000" DownloadDocumentIdentifier: "String" WaitForExternalLogin: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/UserLoginResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" Usersession: Sessionid: 0 Systemreference: 0 Sessionguid: "String" Sessiontype: 0 UiCulture: "String" User: 0 Userloginname: "String" Useremail: "String" Usergroup: 0 Usergroupname: "String" Hostip: "String" IsAdmin: 0 IsImportAdmin: 0 IsBatchDeletionAdmin: 0 IsWorkflowAdmin: 0 ReactivationToken: "String" DisconnectionInterval: 0 Workflowuserstatus: 0 AuthenticationModuleConfigurationId: 0 IsRightsAdmin: 0 IsConstraintsAdmin: 0 IsWorkflowRolesAdmin: 0 IsWorkflowMonitor: 0 Sessionstate: 0 DownloadDocumentIdentifier: "String" DownloadDocumentToken: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/userlogout": post: tags: - "Allgemein" summary: "Removes an active session from the server" description: "Operation **UserLogout**.\n\nRemoves an active session from the server\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#userlogout" operationId: "UserLogout" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/UserLogout" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/UserLogoutResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" Success: false default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/validate2farequest": post: tags: - "Allgemein" summary: "Validates a request for which an extra authentication is needed" description: "Operation **Validate2FARequest**.\n\nValidates a request for which an extra authentication is needed\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#validate2farequest" operationId: "Validate2FARequest" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Validate2FARequest" example: TwoFactorToken: "String" ValidationInformation: - FieldId: 0 FieldName: "String" FieldPrompt: "String" FieldFormat: "String" FieldDescription: "String" FieldType: "String" MultiLine: false Position: 0 Category: "String" Required: false LookupValuesOnly: false LookupValues: - "String" ReadOnly: false Visible: false IsListType: false ClearBeforeShow: false FieldDocumentation: "String" FieldLookupType: "None" FieldLookupFilter: - "String" FieldLookupPluginName: "String" FieldLookupValueMapping: "String" FieldLookupPluginFilter: "String" FieldLookupPluginListener: "String" Masked: false FieldValueString: "String" FieldValueDateTime: "0001-01-01T00:00:00" FieldValueNumeric: 0 FieldValueBool: false FieldValueCurrency: 0 ListValuesString: - "String" ListValuesDateTime: - "0001-01-01T00:00:00" ListValuesNumeric: - 0 ListValuesBool: - false ListValuesCurrency: - 0 CustomFunctions: - "String" CustomRenderer: "String" Dirty: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Validate2FARequestResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_copyimageresourcecontent": post: tags: - "Admin" summary: "Copies image resource content from one field to another" description: "Operation **Admin_CopyImageResourceContent**.\n\nCopies image resource content from one field to another\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_copyimageresourcecontent" operationId: "Admin_CopyImageResourceContent" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_CopyImageResourceContent" example: SessionGuid: "00000000000000000000000000000000" Name: "String" CopyFrom: "NoContent" CopyTo: "NoContent" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_CopyImageResourceContentResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_createdocumentation": post: tags: - "Admin" summary: "Creates or modifies a system/tenant on the server" description: "Operation **Admin_CreateDocumentation**.\n\nCreates or modifies a system/tenant on the server\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_createdocumentation" operationId: "Admin_CreateDocumentation" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_CreateDocumentation" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_CreateDocumentationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" DocumentationObject: AccessRight: 0 Parentobject: 0 Objecttype: 0 IsLink: false Fulltext: "String" Objectid: 0 Name: "String" Description: "String" Usercreated: 0 Dateedited: "0001-01-01T00:00:00" Useredited: 0 Status: 0 Checkoutuser: 0 Checkoutlocation: "String" Deleteflag: 0 Documentdate: "0001-01-01T00:00:00" Abspath: "String" Otpath: "String" Fileextension: "String" Versioncount: 0 Createdusername: "String" Editedusername: "String" Notecount: 0 Systemreference: 0 Barcode: "String" Documenttype: "String" Voucherdate: "0001-01-01T00:00:00" Vouchertype: "String" Vouchernumber: "String" Externalvouchernumber: "String" Transactionkey: "String" Transactiontype: "String" Validfrom: "0001-01-01T00:00:00" Validuntil: "0001-01-01T00:00:00" Deleteflagsetby: 0 Deleteflagsetdate: "0001-01-01T00:00:00" Hiddenflagsetdate: "0001-01-01T00:00:00" Deletereason: 0 Approvalstatuscode: 0 Approvedby: 0 Approvedversion: 0 Latestversion: 0 Filesize: 0 Filehash: "String" Extmetadata: "String" Mailfrom: "String" Mailto: "String" Mailcc: "String" Mailbcc: "String" Mailsubject: "String" Mailmessageid: "String" Mailsenddate: "0001-01-01T00:00:00" Mailparentmailid: 0 Activeworkflowcount: 0 Relatedobjectscount: 0 Deletereasontext: "String" Updateabspath: 0 Lvl: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_deleteauthenticationmodule": post: tags: - "Admin" summary: "Deletes an instance of an authentication module with the given AuthenticationModuleConfigurationId and unloads it" description: "Operation **Admin_DeleteAuthenticationModule**.\n\nDeletes an instance of an authentication module with the given AuthenticationModuleConfigurationId and unloads it\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_deleteauthenticationmodule" operationId: "Admin_DeleteAuthenticationModule" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteAuthenticationModule" example: SessionGuid: "00000000000000000000000000000000" AuthenticationModuleConfigurationId: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteAuthenticationModuleResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_deletecloudservicegatewaypluginconfiguration": post: tags: - "Admin" summary: "Deletes an instance of an cloud service gateway plugin with the given CloudServiceGatewayPluginConfigurationId and unloads it" description: "Operation **Admin_DeleteCloudServiceGatewayPluginConfiguration**.\n\nDeletes an instance of an cloud service gateway plugin with the given CloudServiceGatewayPluginConfigurationId and unloads it\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_deletecloudservicegatewaypluginconfiguration" operationId: "Admin_DeleteCloudServiceGatewayPluginConfiguration" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteCloudServiceGatewayPluginConfiguration" example: SessionGuid: "00000000000000000000000000000000" CloudServiceGatewayPluginConfigurationIds: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteCloudServiceGatewayPluginConfigurationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_deleteimageresourceentry": post: tags: - "Admin" summary: "Deletes an image resource entry" description: "Operation **Admin_DeleteImageResourceEntry**.\n\nDeletes an image resource entry\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_deleteimageresourceentry" operationId: "Admin_DeleteImageResourceEntry" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteImageResourceEntry" example: SessionGuid: "00000000000000000000000000000000" Name: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteImageResourceEntryResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_deletelookuppluginconfiguration": post: tags: - "Admin" summary: "Deletes an instance of an lookup plugin with the given LookupPluginConfigurationId and unloads it" description: "Operation **Admin_DeleteLookupPluginConfiguration**.\n\nDeletes an instance of an lookup plugin with the given LookupPluginConfigurationId and unloads it\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_deletelookuppluginconfiguration" operationId: "Admin_DeleteLookupPluginConfiguration" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteLookupPluginConfiguration" example: SessionGuid: "00000000000000000000000000000000" LookupPluginConfigurationId: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteLookupPluginConfigurationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_deleteobjecttype": post: tags: - "Admin" summary: "Deletes an object type" description: "Operation **Admin_DeleteObjecttype**.\n\nDeletes an object type\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_deleteobjecttype" operationId: "Admin_DeleteObjecttype" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteObjecttype" example: SessionGuid: "00000000000000000000000000000000" ObjectTypeId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteObjecttypeResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_deleteobjecttypedefinition": post: tags: - "Admin" summary: "Deletes a user defined field" description: "Operation **Admin_DeleteObjecttypedefinition**.\n\nDeletes a user defined field\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_deleteobjecttypedefinition" operationId: "Admin_DeleteObjecttypedefinition" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteObjecttypedefinition" example: SessionGuid: "00000000000000000000000000000000" ObjectTypeDefinitionId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteObjecttypedefinitionResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_deleteoperationpluginconfiguration": post: tags: - "Admin" summary: "Deletes an instance of an operation plugin with the given OperationPluginCOnfigurationId and unloads it" description: "Operation **Admin_DeleteOperationPluginConfiguration**.\n\nDeletes an instance of an operation plugin with the given OperationPluginCOnfigurationId and unloads it\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_deleteoperationpluginconfiguration" operationId: "Admin_DeleteOperationPluginConfiguration" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteOperationPluginConfiguration" example: SessionGuid: "00000000000000000000000000000000" OperationPluginConfigurationId: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteOperationPluginConfigurationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_deletetwofactorauthenticationpluginconfiguration": post: tags: - "Admin" summary: "Deletes an instance of an TwoFactorAuthentication plugin with the given TwoFactorAuthenticationPluginConfigurationId and unloads it" description: "Operation **Admin_DeleteTwoFactorAuthenticationPluginConfiguration**.\n\nDeletes an instance of an TwoFactorAuthentication plugin with the given TwoFactorAuthenticationPluginConfigurationId and unloads it\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_deletetwofactorauthenticationpluginconfiguration" operationId: "Admin_DeleteTwoFactorAuthenticationPluginConfiguration" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteTwoFactorAuthenticationPluginConfiguration" example: SessionGuid: "00000000000000000000000000000000" TwoFactorAuthenticationPluginConfigurationId: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_DeleteTwoFactorAuthenticationPluginConfigurationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getauthenticationmoduleconfigurationproperties": post: tags: - "Admin" summary: "Gets an configuration of an authentication module instance" description: "Operation **Admin_GetAuthenticationModuleConfigurationProperties**.\n\nGets an configuration of an authentication module instance\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getauthenticationmoduleconfigurationproperties" operationId: "Admin_GetAuthenticationModuleConfigurationProperties" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetAuthenticationModuleConfigurationProperties" example: SessionGuid: "00000000000000000000000000000000" AuthenticationModuleConfigurationId: 0 AuthenticationModuleClass: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetAuthenticationModuleConfigurationPropertiesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" SupportsUsermanagement: false default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getauthenticationmoduleplugins": post: tags: - "Admin" summary: "Gets a list of all avaiable authentication modules" description: "Operation **Admin_GetAuthenticationModulePlugins**.\n\nGets a list of all avaiable authentication modules\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getauthenticationmoduleplugins" operationId: "Admin_GetAuthenticationModulePlugins" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetAuthenticationModulePlugins" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetAuthenticationModulePluginsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ResultList: - AuthenticationModuleClass: "String" AuthenticationModuleName: "String" AuthenticationModuleDescription: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getauthenticationmodules": post: tags: - "Admin" summary: "Retrieves all possible authenticationmodules for given systemreferenceguid and clientype" description: "Operation **Admin_GetAuthenticationModules**.\n\nRetrieves all possible authenticationmodules for given systemreferenceguid and clientype\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getauthenticationmodules" operationId: "Admin_GetAuthenticationModules" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetAuthenticationModules" example: SessionGuid: "00000000000000000000000000000000" RegisteredSystem: 0 ClientType: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetAuthenticationModulesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getauthenticationusermanagementlist": post: tags: - "Admin" summary: "Retrieves all possible authenticationmodules for given systemreferenceguid and clientype" description: "Operation **Admin_GetAuthenticationUsermanagementList**.\n\nRetrieves all possible authenticationmodules for given systemreferenceguid and clientype\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getauthenticationusermanagementlist" operationId: "Admin_GetAuthenticationUsermanagementList" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetAuthenticationUsermanagementList" example: SessionGuid: "00000000000000000000000000000000" AuthenticationConfigurationId: 0 Path: "String" QueryTerm: "String" ItemType: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetAuthenticationUsermanagementListResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getauthenticationusermanagementpath": post: tags: - "Admin" summary: "Retrieves all path regarding the given authentication configuration" description: "Operation **Admin_GetAuthenticationUsermanagementPath**.\n\nRetrieves all path regarding the given authentication configuration\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getauthenticationusermanagementpath" operationId: "Admin_GetAuthenticationUsermanagementPath" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetAuthenticationUsermanagementPath" example: SessionGuid: "00000000000000000000000000000000" AuthenticationConfigurationId: 0 Path: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetAuthenticationUsermanagementPathResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getauthenticationusermanagementtree": post: tags: - "Admin" summary: "Retrieves all groups and users which are assigned to the given authentication configurationid" description: "Operation **Admin_GetAuthenticationUsermanagementTree**.\n\nRetrieves all groups and users which are assigned to the given authentication configurationid\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getauthenticationusermanagementtree" operationId: "Admin_GetAuthenticationUsermanagementTree" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetAuthenticationUsermanagementTree" example: SessionGuid: "00000000000000000000000000000000" AuthenticationConfigurationId: 0 Root: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetAuthenticationUsermanagementTreeResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getcloudservicegatewaypluginconfigurationproperties": post: tags: - "Admin" summary: "Gets an configuration of an Cloud Service Gateway plugin instance" description: "Operation **Admin_GetCloudServiceGatewayPluginConfigurationProperties**.\n\nGets an configuration of an Cloud Service Gateway plugin instance\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getcloudservicegatewaypluginconfigurationproperties" operationId: "Admin_GetCloudServiceGatewayPluginConfigurationProperties" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetCloudServiceGatewayPluginConfigurationProperties" example: SessionGuid: "00000000000000000000000000000000" CloudServiceGatewayPluginName: "String" Systemreference: 0 CloudServiceGatewayPluginClass: "String" CloudServiceGatewayAttachZugferdToPdf: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetCloudServiceGatewayPluginConfigurationPropertiesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getcloudservicegatewaypluginconfigurations": post: tags: - "Admin" summary: "Retrieves all possible Cloud Service Gateway plugin configurations for given systemreferenceguid" description: "Operation **Admin_GetCloudServiceGatewayPluginConfigurations**.\n\nRetrieves all possible Cloud Service Gateway plugin configurations for given systemreferenceguid\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getcloudservicegatewaypluginconfigurations" operationId: "Admin_GetCloudServiceGatewayPluginConfigurations" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetCloudServiceGatewayPluginConfigurations" example: SessionGuid: "00000000000000000000000000000000" RegisteredSystem: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetCloudServiceGatewayPluginConfigurationsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getcloudservicegatewayplugins": post: tags: - "Admin" summary: "Gets a list of all avaiable cloud service gateway plugins" description: "Operation **Admin_GetCloudServiceGatewayPlugins**.\n\nGets a list of all avaiable cloud service gateway plugins\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getcloudservicegatewayplugins" operationId: "Admin_GetCloudServiceGatewayPlugins" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetCloudServiceGatewayPlugins" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetCloudServiceGatewayPluginsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ResultList: - CloudServiceGatewayPluginClass: "String" CloudServiceGatewayPluginName: "String" CloudServiceGatewayPluginDescription: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getimageresources": post: tags: - "Admin" summary: "Retrieves image resource entries" description: "Operation **Admin_GetImageResources**.\n\nRetrieves image resource entries\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getimageresources" operationId: "Admin_GetImageResources" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetImageResources" example: SessionGuid: "00000000000000000000000000000000" FilterByName: "String" FilterByImagetype: 0 IncludeContentInResponse: false IncludeSmallImageInResponse: false ImageToStream: "NoContent" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetImageResourcesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getlookupplugins": post: tags: - "Admin" summary: "Gets a list of all avaiable lookup plugins" description: "Operation **Admin_GetLookupPlugins**.\n\nGets a list of all avaiable lookup plugins\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getlookupplugins" operationId: "Admin_GetLookupPlugins" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetLookupPlugins" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetLookupPluginsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ResultList: - LookupPluginClass: "String" LookupPluginName: "String" LookupPluginDescription: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getoperationpluginconfigurations": post: tags: - "Admin" summary: "Retrieves all possible operation plugin configurations for given systemreferenceguid" description: "Operation **Admin_GetOperationPluginConfigurations**.\n\nRetrieves all possible operation plugin configurations for given systemreferenceguid\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getoperationpluginconfigurations" operationId: "Admin_GetOperationPluginConfigurations" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetOperationPluginConfigurations" example: SessionGuid: "00000000000000000000000000000000" RegisteredSystem: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetOperationPluginConfigurationsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getoperationplugins": post: tags: - "Admin" summary: "Gets a list of all avaiable operation plugins" description: "Operation **Admin_GetOperationPlugins**.\n\nGets a list of all avaiable operation plugins\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getoperationplugins" operationId: "Admin_GetOperationPlugins" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetOperationPlugins" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetOperationPluginsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ResultList: - OperationPluginClass: "String" OperationPluginName: "String" OperationPluginDescription: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getstatistics": post: tags: - "Admin" summary: "Gets statistics about system usage and health" description: "Operation **Admin_GetStatistics**.\n\nGets statistics about system usage and health\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getstatistics" operationId: "Admin_GetStatistics" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetStatistics" example: SessionGuid: "00000000000000000000000000000000" RegisteredSystem: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetStatisticsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalObjectsCount: 0 TotalDocsCount: 0 ActiveUserSessionsCount: 0 ObjectMaintenanceQueueCount: 0 SecurityMaintenanceQueueCount: 0 IndexMaintenanceQueueCount: 0 NeedsFulltextIndexingQueueCount: 0 CurrentlyActiveUploads: 0 TotalVersionsCount: 0 TotalDocumentSpace: "String" MaxConcurrentUsersCount: 0 MaxConcurrentWorkflowUsersCount: 0 ActiveWorkflowUserSessionsCount: 0 MaxSystems: 0 BackgroundTaskInfo: - BackgroundTaskName: "String" WriteLockedObjectsCount: 0 MaxLicenses: 0 UsedLicenses: 0 TotalRunningWorkflows: 0 TotalWorkflowsWaitingForUserCompletion: 0 TotalWorkflowsInProcessingQueue: 0 TotalWorkflowsInProcessingState: 0 FulltextPropertyWriterQueueCount: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_getsystemcustomization": post: tags: - "Admin" summary: "Gets customization data for a system to transfer to another" description: "Operation **Admin_GetSystemCustomization**.\n\nGets customization data for a system to transfer to another\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_getsystemcustomization" operationId: "Admin_GetSystemCustomization" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetSystemCustomization" example: SessionGuid: "00000000000000000000000000000000" FilterByObjectTypeIds: - 0 FilterByWorkflowIds: - 0 FilterByRegisteredSystemIds: - 0 FilterAuthenticationModuleIds: - 0 FilterTwoFactorAuthenticationPluginIds: - 0 FilterLookupPluginIds: - 0 FilterCloudServiceGatewayIds: - 0 IncludeStandardAccessRules: false IncludeExtendedAccessRules: false IncludeRegisteredSystems: false IncludeWorkflowRoles: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetSystemCustomizationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ServerCustomization: ProductName: "String" ProductVersion: "String" StructureXMLTemplate: "String" ServerSettings: - Settingkey: "String" Settingtext: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_gettwofactorauthenticationpluginconfigurationproperties": post: tags: - "Admin" summary: "Gets an configuration of an two factor authentication plugin instance" description: "Operation **Admin_GetTwoFactorAuthenticationPluginConfigurationProperties**.\n\nGets an configuration of an two factor authentication plugin instance\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_gettwofactorauthenticationpluginconfigurationproperties" operationId: "Admin_GetTwoFactorAuthenticationPluginConfigurationProperties" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetTwoFactorAuthenticationPluginConfigurationProperties" example: SessionGuid: "00000000000000000000000000000000" TwoFactorAuthenticationPluginName: "String" Systemreference: 0 TwoFactorAuthenticationPluginClass: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetTwoFactorAuthenticationPluginConfigurationPropertiesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_gettwofactorauthenticationpluginconfigurations": post: tags: - "Admin" summary: "Retrieves all possible two factor authentication plugin configurations for given systemreferenceguid" description: "Operation **Admin_GetTwoFactorAuthenticationPluginConfigurations**.\n\nRetrieves all possible two factor authentication plugin configurations for given systemreferenceguid\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_gettwofactorauthenticationpluginconfigurations" operationId: "Admin_GetTwoFactorAuthenticationPluginConfigurations" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetTwoFactorAuthenticationPluginConfigurations" example: SessionGuid: "00000000000000000000000000000000" RegisteredSystem: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetTwoFactorAuthenticationPluginConfigurationsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_gettwofactorauthenticationpluginconfigurationusers": post: tags: - "Admin" summary: "Gets a list of all users registered to the specific plugin configuration" description: "Operation **Admin_GetTwoFactorAuthenticationPluginConfigurationUsers**.\n\nGets a list of all users registered to the specific plugin configuration\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_gettwofactorauthenticationpluginconfigurationusers" operationId: "Admin_GetTwoFactorAuthenticationPluginConfigurationUsers" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetTwoFactorAuthenticationPluginConfigurationUsers" example: SessionGuid: "00000000000000000000000000000000" TwoFactorAuthenticationPluginConfigurationId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetTwoFactorAuthenticationPluginConfigurationUsersResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ResultList: - AccessRight: 0 Parentobject: 0 Objecttype: 0 IsLink: false Fulltext: "String" Objectid: 0 Name: "String" Description: "String" Usercreated: 0 Dateedited: "0001-01-01T00:00:00" Useredited: 0 Status: 0 Checkoutuser: 0 Checkoutlocation: "String" Deleteflag: 0 Documentdate: "0001-01-01T00:00:00" Abspath: "String" Otpath: "String" Fileextension: "String" Versioncount: 0 Createdusername: "String" Editedusername: "String" Notecount: 0 Systemreference: 0 Barcode: "String" Documenttype: "String" Voucherdate: "0001-01-01T00:00:00" Vouchertype: "String" Vouchernumber: "String" Externalvouchernumber: "String" Transactionkey: "String" Transactiontype: "String" Validfrom: "0001-01-01T00:00:00" Validuntil: "0001-01-01T00:00:00" Deleteflagsetby: 0 Deleteflagsetdate: "0001-01-01T00:00:00" Hiddenflagsetdate: "0001-01-01T00:00:00" Deletereason: 0 Approvalstatuscode: 0 Approvedby: 0 Approvedversion: 0 Latestversion: 0 Filesize: 0 Filehash: "String" Extmetadata: "String" Mailfrom: "String" Mailto: "String" Mailcc: "String" Mailbcc: "String" Mailsubject: "String" Mailmessageid: "String" Mailsenddate: "0001-01-01T00:00:00" Mailparentmailid: 0 Activeworkflowcount: 0 Relatedobjectscount: 0 Deletereasontext: "String" Updateabspath: 0 Lvl: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_gettwofactorauthenticationplugins": post: tags: - "Admin" summary: "Gets a list of all avaiable teo factor authentication plugins" description: "Operation **Admin_GetTwoFactorAuthenticationPlugins**.\n\nGets a list of all avaiable teo factor authentication plugins\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_gettwofactorauthenticationplugins" operationId: "Admin_GetTwoFactorAuthenticationPlugins" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetTwoFactorAuthenticationPlugins" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_GetTwoFactorAuthenticationPluginsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ResultList: - TwoFactorAuthenticationPluginClass: "String" TwoFactorAuthenticationPluginName: "String" TwoFactorAuthenticationPluginDescription: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_resettwofactorauthenticationpluginconfiguration": post: tags: - "Admin" summary: "Resets two factor initialisations for user or the whole plugin instance" description: "Operation **Admin_ResetTwoFactorAuthenticationPluginConfiguration**.\n\nResets two factor initialisations for user or the whole plugin instance\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_resettwofactorauthenticationpluginconfiguration" operationId: "Admin_ResetTwoFactorAuthenticationPluginConfiguration" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_ResetTwoFactorAuthenticationPluginConfiguration" example: SessionGuid: "00000000000000000000000000000000" ConfigurationId: 0 ResetUserObjectIds: - 0 ResetAllUsers: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_ResetTwoFactorAuthenticationPluginConfigurationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_sendtestemail": post: tags: - "Admin" summary: "Tests a dvMailConfiguration by sending a sample e-mail" description: "Operation **Admin_SendTestEMail**.\n\nTests a dvMailConfiguration by sending a sample e-mail\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_sendtestemail" operationId: "Admin_SendTestEMail" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SendTestEMail" example: SessionGuid: "00000000000000000000000000000000" MailConfigurationForTest: FromAddress: "String" ReplyToAddress: "String" FixedCcAddress: "String" FixedBccAddress: "String" MailProvider: "None" SmtpHost: "String" SmtpPort: 0 SmtpSecure: false SmtpAuthUsername: "String" SmtpAuthPassword: "String" SmtpIgnoreInvalidCertificate: false SmtpSecurity: "NotSelected" OAuthTenantId: "String" OAuthClientId: "String" OAuthClientSecret: "String" SmtpAuthentication: "Default" UseStoredMailConfiguration: false ToAddress: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SendTestEMailResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_setauthenticationmodule": post: tags: - "Admin" summary: "Sets or creates a new instance of an authentication module with the given configuration" description: "Operation **Admin_SetAuthenticationModule**.\n\nSets or creates a new instance of an authentication module with the given configuration\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_setauthenticationmodule" operationId: "Admin_SetAuthenticationModule" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetAuthenticationModule" example: SessionGuid: "00000000000000000000000000000000" AuthenticationModuleConfiguration: Configurationid: 0 Systemreference: 0 Systemalias: "String" Systemname: "String" Authenticationmoduleclass: "String" Authenticationmodulename: "String" Authenticationmoduledescription: "String" Configuration: "String" Isactive: 0 Position: 0 ShowInLoginScreen: false CanChangePassword: false Allowednetworks: "String" Blockednetworks: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetAuthenticationModuleResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" SavedConfiguration: Configurationid: 0 Systemreference: 0 Systemalias: "String" Systemname: "String" Authenticationmoduleclass: "String" Authenticationmodulename: "String" Authenticationmoduledescription: "String" Configuration: "String" Isactive: 0 Position: 0 ShowInLoginScreen: false CanChangePassword: false Allowednetworks: "String" Blockednetworks: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_setauthenticationusermanagementuser": post: tags: - "Admin" summary: "Creates users using the given usermanagementitems and adds them to docuvita group defined by GroupObjectId" description: "Operation **Admin_SetAuthenticationUsermanagementUser**.\n\nCreates users using the given usermanagementitems and adds them to docuvita group defined by GroupObjectId\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_setauthenticationusermanagementuser" operationId: "Admin_SetAuthenticationUsermanagementUser" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetAuthenticationUsermanagementUser" example: SessionGuid: "00000000000000000000000000000000" AuthenticationConfigurationId: 0 GroupObjectId: 0 UserInformation: - Name: "String" Id: "String" Description: "String" Objectid: 0 Type: 0 Properties: - FieldId: 0 FieldName: "String" FieldPrompt: "String" FieldFormat: "String" FieldDescription: "String" FieldType: "String" MultiLine: false Position: 0 Category: "String" Required: false LookupValuesOnly: false LookupValues: - "String" ReadOnly: false Visible: false IsListType: false ClearBeforeShow: false FieldDocumentation: "String" FieldLookupType: "None" FieldLookupFilter: - "String" FieldLookupPluginName: "String" FieldLookupValueMapping: "String" FieldLookupPluginFilter: "String" FieldLookupPluginListener: "String" Masked: false FieldValueString: "String" FieldValueDateTime: "0001-01-01T00:00:00" FieldValueNumeric: 0 FieldValueBool: false FieldValueCurrency: 0 ListValuesString: - "String" ListValuesDateTime: - "0001-01-01T00:00:00" ListValuesNumeric: - 0 ListValuesBool: - false ListValuesCurrency: - 0 CustomFunctions: - "String" CustomRenderer: "String" Dirty: false IsLeaf: false Path: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetAuthenticationUsermanagementUserResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_setcloudservicegatewaypluginconfiguration": post: tags: - "Admin" summary: "Sets or creates a new instance of an cloud service gateway plugin with the given configuration" description: "Operation **Admin_SetCloudServiceGatewayPluginConfiguration**.\n\nSets or creates a new instance of an cloud service gateway plugin with the given configuration\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_setcloudservicegatewaypluginconfiguration" operationId: "Admin_SetCloudServiceGatewayPluginConfiguration" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetCloudServiceGatewayPluginConfiguration" example: SessionGuid: "00000000000000000000000000000000" CloudServiceGatewayPluginConfiguration: Configurationid: 0 Systemreference: 0 Systemalias: "String" Systemname: "String" Cloudservicegatewaypluginclass: "String" Cloudservicegatewaypluginname: "String" Cloudservicegatewayplugindescription: "String" Configuration: "String" Isactive: 0 Position: 0 Displayname: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetCloudServiceGatewayPluginConfigurationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_setcustomizedstandardfields": post: tags: - "Admin" summary: "Creates or modifies object type definition entries for standard fields" description: "Operation **Admin_SetCustomizedStandardFields**.\n\nCreates or modifies object type definition entries for standard fields\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_setcustomizedstandardfields" operationId: "Admin_SetCustomizedStandardFields" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetCustomizedStandardFields" example: SessionGuid: "00000000000000000000000000000000" ObjectTypeId: 0 ObjectTypeDefinitionIdsToMerge: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetCustomizedStandardFieldsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_setimageresourcecontent": post: tags: - "Admin" summary: "Sets the content of an existing image resource entry. Content should be included as http file upload" description: "Operation **Admin_SetImageResourceContent**.\n\nSets the content of an existing image resource entry. Content should be included as http file upload\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_setimageresourcecontent" operationId: "Admin_SetImageResourceContent" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetImageResourceContent" example: SessionGuid: "00000000000000000000000000000000" Name: "String" ResourceToSet: "NoContent" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetImageResourceContentResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_setimageresourceentry": post: tags: - "Admin" summary: "Creates or modifies image resource entries (name/description, not image content)" description: "Operation **Admin_SetImageResourceEntry**.\n\nCreates or modifies image resource entries (name/description, not image content)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_setimageresourceentry" operationId: "Admin_SetImageResourceEntry" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetImageResourceEntry" example: SessionGuid: "00000000000000000000000000000000" Name: "String" Imagetype: 0 Mimetype: "String" Description: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetImageResourceEntryResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ImageResource: Imageresourceid: 0 Imagetype: 0 Mimetype: "String" Name: "String" Description: "String" Imgsmall: "AA==" Imgsmallselected: "AA==" Imgmedium: "AA==" Imglarge: "AA==" Imgxlarge: "AA==" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_setlookuppluginconfiguration": post: tags: - "Admin" summary: "Sets or creates a new instance of an lookup plugin with the given configuration" description: "Operation **Admin_SetLookupPluginConfiguration**.\n\nSets or creates a new instance of an lookup plugin with the given configuration\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_setlookuppluginconfiguration" operationId: "Admin_SetLookupPluginConfiguration" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetLookupPluginConfiguration" example: SessionGuid: "00000000000000000000000000000000" LookupPluginConfiguration: Configurationid: 0 Systemreference: 0 Systemalias: "String" Systemname: "String" Lookuppluginclass: "String" Lookuppluginname: "String" Lookupplugindescription: "String" Configuration: "String" Isactive: 0 Position: 0 Displayname: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetLookupPluginConfigurationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_setobjecttype": post: tags: - "Admin" summary: "Modifies an object type or creates a new one" description: "Operation **Admin_SetObjecttype**.\n\nModifies an object type or creates a new one\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_setobjecttype" operationId: "Admin_SetObjecttype" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetObjecttype" example: SessionGuid: "00000000000000000000000000000000" Objecttype: Objecttypeid: 0 Name: "String" Internalname: "String" Description: "String" Icon: "AA==" Iconselected: "AA==" Allowedparenttypes: "String" Typeidentifier: "String" View: 0 Defaultparent: 0 Fulltextindexed: false Predefineddescription: "String" Defaultdescription: "String" Descriptionlookup: false Xmltemplate: "String" Typehidden: 0 Retentionclass: "String" Preimportscriptfile: "String" Preimportscriptcode: "String" Postimportscriptfile: "String" Postimportscriptcode: "String" Mediumicon: "AA==" Largeicon: "AA==" Updatekeyfields: "String" Updateloctype: 0 Versionincrementstyle: 0 Submaintenanceonobjectchange: 0 Displayname: "String" ImageResourceName: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetObjecttypeResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" Objecttype: Objecttypeid: 0 Name: "String" Internalname: "String" Description: "String" Icon: "AA==" Iconselected: "AA==" Allowedparenttypes: "String" Typeidentifier: "String" View: 0 Defaultparent: 0 Fulltextindexed: false Predefineddescription: "String" Defaultdescription: "String" Descriptionlookup: false Xmltemplate: "String" Typehidden: 0 Retentionclass: "String" Preimportscriptfile: "String" Preimportscriptcode: "String" Postimportscriptfile: "String" Postimportscriptcode: "String" Mediumicon: "AA==" Largeicon: "AA==" Updatekeyfields: "String" Updateloctype: 0 Versionincrementstyle: 0 Submaintenanceonobjectchange: 0 Displayname: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_setobjecttypedefinition": post: tags: - "Admin" summary: "Creates or modifies object type-level defined fields (custom properties)" description: "Operation **Admin_SetObjecttypeDefinition**.\n\nCreates or modifies object type-level defined fields (custom properties)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_setobjecttypedefinition" operationId: "Admin_SetObjecttypeDefinition" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetObjecttypeDefinition" example: SessionGuid: "00000000000000000000000000000000" ObjecttypedefinitionList: - Objecttypedefinitionid: 0 Objecttype: 0 Fieldtype: 0 Fieldname: "String" Prompt: "String" Description: "String" Category: "String" Required: false Valuelookup: false Predefinedvalues: "String" System: false Public: false Position: 0 Defaultvalue: "String" Lockstate: 0 Fieldhidden: 0 Fieldformat: "String" Autocalc: 0 Autocalcexpression: "String" Multiline: 0 Fieldlookuptype: 0 Fieldlookupfilter: "String" Fieldlookuppluginname: "String" Fieldlookupvaluemapping: "String" Fieldlookuppluginlistener: "String" Fieldlookuppluginfilter: "String" Customfunctions: "String" Customrenderer: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetObjecttypeDefinitionResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_setoperationpluginconfiguration": post: tags: - "Admin" summary: "Sets or creates a new instance of an authentication module with the given configuration" description: "Operation **Admin_SetOperationPluginConfiguration**.\n\nSets or creates a new instance of an authentication module with the given configuration\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_setoperationpluginconfiguration" operationId: "Admin_SetOperationPluginConfiguration" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetOperationPluginConfiguration" example: SessionGuid: "00000000000000000000000000000000" OperationPluginConfiguration: Configurationid: 0 Systemreference: 0 Systemalias: "String" Systemname: "String" Operationpluginclass: "String" Operationpluginname: "String" Operationplugindescription: "String" Configuration: "String" Isactive: 0 Position: 0 Displayname: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetOperationPluginConfigurationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_setregisteredsystem": post: tags: - "Admin" summary: "Creates or modifies a system/tenant on the server" description: "Operation **Admin_SetRegisteredSystem**.\n\nCreates or modifies a system/tenant on the server\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_setregisteredsystem" operationId: "Admin_SetRegisteredSystem" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetRegisteredSystem" example: SessionGuid: "00000000000000000000000000000000" RegisteredSystem: Systemreferenceid: 0 Systemname: "String" Systemguid: "String" IsRemote: 0 Remotehost: "String" Remoteport: 0 Systemstatus: 0 Admingroup: 0 Filestoreaddress: "String" Importstoreaddress: "String" Importgroup: 0 Systemalias: "String" Deleteadmingroup: 0 Deletemode: 0 Workflowadmingroup: 0 Mailconfiguration: "String" Defaultpassword: "String" Mailnewuserpassword: 0 Defaultculture: "String" Signatureconfig: "String" Crypttype: 0 Constraintsadmingroup: 0 Rightsadmingroup: 0 Workflowrolesadmingroup: 0 Externalusergroup: 0 Systemurl: "String" Objectlogdbaddress: "String" Importlogdbaddress: "String" Primarycolor: "String" Secondarycolor: "String" Logosmall: "AA==" Logomedium: "AA==" Logolarge: "AA==" Logoxlarge: "AA==" AdministratorGroupName: "String" AdministratorUserName: "String" RetrieveGuidForTemplateUpload: false CreateAccessRules: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetRegisteredSystemResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" RegisteredSystem: Systemreferenceid: 0 Systemname: "String" Systemguid: "String" IsRemote: 0 Remotehost: "String" Remoteport: 0 Systemstatus: 0 Admingroup: 0 Filestoreaddress: "String" Importstoreaddress: "String" Importgroup: 0 Systemalias: "String" Deleteadmingroup: 0 Deletemode: 0 Workflowadmingroup: 0 Mailconfiguration: "String" Defaultpassword: "String" Mailnewuserpassword: 0 Defaultculture: "String" Signatureconfig: "String" Crypttype: 0 Constraintsadmingroup: 0 Rightsadmingroup: 0 Workflowrolesadmingroup: 0 Externalusergroup: 0 Systemurl: "String" Objectlogdbaddress: "String" Importlogdbaddress: "String" Primarycolor: "String" Secondarycolor: "String" Logosmall: "AA==" Logomedium: "AA==" Logolarge: "AA==" Logoxlarge: "AA==" AdminGroup: ExBA: "0": Object: 0 Objecttypedefinition: 0 Value: false ExCA: "0": Object: 0 Objecttypedefinition: 0 Value: 0 ExDA: "0": Object: 0 Objecttypedefinition: 0 Value: "0001-01-01T00:00:00" ExNA: "0": Object: 0 Objecttypedefinition: 0 Value: 0 ExSA: "0": Object: 0 Objecttypedefinition: 0 Value: "String" AccessRight: 0 ExTA: "0": Object: 0 Objecttypedefinition: 0 Value: "String" Parentobject: 0 Objecttype: 0 IsLink: false Fulltext: "String" Objectid: 0 Name: "String" Description: "String" Usercreated: 0 Dateedited: "0001-01-01T00:00:00" Useredited: 0 Status: 0 Checkoutuser: 0 Checkoutlocation: "String" Deleteflag: 0 Documentdate: "0001-01-01T00:00:00" Abspath: "String" Otpath: "String" Fileextension: "String" Versioncount: 0 Createdusername: "String" Editedusername: "String" Notecount: 0 Systemreference: 0 Barcode: "String" Documenttype: "String" Voucherdate: "0001-01-01T00:00:00" Vouchertype: "String" Vouchernumber: "String" Externalvouchernumber: "String" Transactionkey: "String" Transactiontype: "String" Validfrom: "0001-01-01T00:00:00" Validuntil: "0001-01-01T00:00:00" Deleteflagsetby: 0 Deleteflagsetdate: "0001-01-01T00:00:00" Hiddenflagsetdate: "0001-01-01T00:00:00" Deletereason: 0 Approvalstatuscode: 0 Approvedby: 0 Approvedversion: 0 Latestversion: 0 Filesize: 0 Filehash: "String" Extmetadata: "String" Mailfrom: "String" Mailto: "String" Mailcc: "String" Mailbcc: "String" Mailsubject: "String" Mailmessageid: "String" Mailsenddate: "0001-01-01T00:00:00" Mailparentmailid: 0 Activeworkflowcount: 0 Relatedobjectscount: 0 Deletereasontext: "String" Updateabspath: 0 Lvl: 0 AdminUser: ExBA: "0": Object: 0 Objecttypedefinition: 0 Value: false ExCA: "0": Object: 0 Objecttypedefinition: 0 Value: 0 ExDA: "0": Object: 0 Objecttypedefinition: 0 Value: "0001-01-01T00:00:00" ExNA: "0": Object: 0 Objecttypedefinition: 0 Value: 0 ExSA: "0": Object: 0 Objecttypedefinition: 0 Value: "String" AccessRight: 0 ExTA: "0": Object: 0 Objecttypedefinition: 0 Value: "String" Parentobject: 0 Objecttype: 0 IsLink: false Fulltext: "String" Objectid: 0 Name: "String" Description: "String" Usercreated: 0 Dateedited: "0001-01-01T00:00:00" Useredited: 0 Status: 0 Checkoutuser: 0 Checkoutlocation: "String" Deleteflag: 0 Documentdate: "0001-01-01T00:00:00" Abspath: "String" Otpath: "String" Fileextension: "String" Versioncount: 0 Createdusername: "String" Editedusername: "String" Notecount: 0 Systemreference: 0 Barcode: "String" Documenttype: "String" Voucherdate: "0001-01-01T00:00:00" Vouchertype: "String" Vouchernumber: "String" Externalvouchernumber: "String" Transactionkey: "String" Transactiontype: "String" Validfrom: "0001-01-01T00:00:00" Validuntil: "0001-01-01T00:00:00" Deleteflagsetby: 0 Deleteflagsetdate: "0001-01-01T00:00:00" Hiddenflagsetdate: "0001-01-01T00:00:00" Deletereason: 0 Approvalstatuscode: 0 Approvedby: 0 Approvedversion: 0 Latestversion: 0 Filesize: 0 Filehash: "String" Extmetadata: "String" Mailfrom: "String" Mailto: "String" Mailcc: "String" Mailbcc: "String" Mailsubject: "String" Mailmessageid: "String" Mailsenddate: "0001-01-01T00:00:00" Mailparentmailid: 0 Activeworkflowcount: 0 Relatedobjectscount: 0 Deletereasontext: "String" Updateabspath: 0 Lvl: 0 UploadGuid: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_setsystemcustomization": post: tags: - "Admin" summary: "Allows to import system customizations from another system" description: "Operation **Admin_SetSystemCustomization**.\n\nAllows to import system customizations from another system\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_setsystemcustomization" operationId: "Admin_SetSystemCustomization" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetSystemCustomization" example: ServerCustomization: ProductName: "String" ProductVersion: "String" StructureXMLTemplate: "String" ServerSettings: - Settingkey: "String" Settingtext: "String" SystemReferenceId: 0 SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetSystemCustomizationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_settwofactorauthenticationpluginconfiguration": post: tags: - "Admin" summary: "Sets or creates a new instance of an two factor authentication plugin with the given configuration" description: "Operation **Admin_SetTwoFactorAuthenticationPluginConfiguration**.\n\nSets or creates a new instance of an two factor authentication plugin with the given configuration\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_settwofactorauthenticationpluginconfiguration" operationId: "Admin_SetTwoFactorAuthenticationPluginConfiguration" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetTwoFactorAuthenticationPluginConfiguration" example: SessionGuid: "00000000000000000000000000000000" TwoFactorAuthenticationPluginConfiguration: Configurationid: 0 Systemreference: 0 Systemalias: "String" Systemname: "String" Twofactorauthenticationpluginclass: "String" Twofactorauthenticationpluginname: "String" Twofactorauthenticationplugindescription: "String" Configuration: "String" Isactive: 0 Position: 0 Displayname: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetTwoFactorAuthenticationPluginConfigurationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_setupdateabspath": post: tags: - "Admin" summary: "Set updateabspath=1 for all objects in the system" description: "Operation **Admin_SetUpdateabspath**.\n\nSet updateabspath=1 for all objects in the system\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_setupdateabspath" operationId: "Admin_SetUpdateabspath" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetUpdateabspath" example: SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SetUpdateabspathResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ObjectCount: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_syncauthenticationusermanagementuser": post: tags: - "Admin" summary: "Creates users using the given usermanagementitems and adds them to docuvita group defined by GroupObjectId" description: "Operation **Admin_SyncAuthenticationUsermanagementUser**.\n\nCreates users using the given usermanagementitems and adds them to docuvita group defined by GroupObjectId\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#admin_syncauthenticationusermanagementuser" operationId: "Admin_SyncAuthenticationUsermanagementUser" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Admin_SyncAuthenticationUsermanagementUser" example: SessionGuid: "00000000000000000000000000000000" AuthenticationConfigurationId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Admin_SyncAuthenticationUsermanagementUserResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" SyncStartedCount: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/batchdeletionadmin_getdeletelist": post: tags: - "BatchDeletionAdmin" summary: "Retrieves the list objects with a delete flag" description: "Operation **BatchDeletionAdmin_GetDeleteList**.\n\nRetrieves the list objects with a delete flag\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#batchdeletionadmin_getdeletelist" operationId: "BatchDeletionAdmin_GetDeleteList" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/BatchDeletionAdmin_GetDeleteList" example: SessionGuid: "00000000000000000000000000000000" ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" PageNumber: 0 PageSize: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/BatchDeletionAdmin_GetDeleteListResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/batchdeletionadmin_runbatchdelete": post: tags: - "BatchDeletionAdmin" summary: "Runs the server-side batch deletion process" description: "Operation **BatchDeletionAdmin_RunBatchDelete**.\n\nRuns the server-side batch deletion process\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#batchdeletionadmin_runbatchdelete" operationId: "BatchDeletionAdmin_RunBatchDelete" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/BatchDeletionAdmin_RunBatchDelete" example: SessionGuid: "00000000000000000000000000000000" SkipFilesystemErrors: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/BatchDeletionAdmin_RunBatchDeleteResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/importapi_startimport": post: tags: - "ImportAPI" summary: "Starts import process for existing/uploaded importsets" description: "Operation **ImportAPI_StartImport**.\n\nStarts import process for existing/uploaded importsets\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#importapi_startimport" operationId: "ImportAPI_StartImport" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ImportAPI_StartImport" example: UserName: "String" Password: "String" SystemReference: 0 BatchImportIds: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ImportAPI_StartImportResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/importapi_storedocumentationconfiguration": post: tags: - "ImportAPI" summary: "ImportAPI_StoreDocumentationConfiguration" description: "Operation **ImportAPI_StoreDocumentationConfiguration**.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#importapi_storedocumentationconfiguration" operationId: "ImportAPI_StoreDocumentationConfiguration" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ImportAPI_StoreDocumentationConfiguration" example: UserName: "String" Password: "String" SystemReference: 0 ApConfiguration: Activated: false ConfigurationFileDescription: "String" ConfigurationFileVersion: "String" LastEditedBy: "String" Editable: false PartnerId: 0 RequiredProductLicense: "String" AutoProfilerVersion: "String" UserName: "String" UserPassword: "String" SystemReference: 0 IsNtlmUserAccount: false ConfigurationValues: - CfgKey: "String" CfgValue: "String" CfgDescription: "String" AutoProfilers: - Name: "String" Description: "String" Enabled: false SourceFolder: "String" TargetFolder: "String" LogFolder: "String" ErrorBackupFolder: "String" FieldPattern: "String" FilePattern: "String" NewDocIndicator: "String" SplitAllPages: false StartNewDocWhenSameFieldValueAppears: false ProfilerMode: "ParseContent" DocContentParser: "None" Recursive: false MinAgeOfFile: 0 KeepErrorBackupLocal: false TargetFilename: "String" Simulation: false AllowEmptyFiles: false IgnoreDocReferences: false RetryFailedUploads: false Templates: - Name: "String" Description: "String" Enabled: false Condition: "String" XmlContent: "String" DataLookups: - Name: "String" Description: "String" Enabled: false Condition: "String" ConnectionString: "String" DataFetchStatement: "String" DataUpdateStatement: "String" LogWarningForNoResults: false DataLookupType: "PerPage" Scripts: - Name: "String" Description: "String" Enabled: false Condition: "String" ScriptCode: "String" ScriptFile: "String" ScriptType: "PerDocument" Runtime_IterationWithLastSuccessfulValidation: 0 IsCurrentlyEdited: false Runtime_CycleCount: 0 Runtime_LoadedFromFile: "String" Runtime_IsInConfiguratorTestMode: false ConfigurationName: "String" HostName: "String" responses: "200": description: "Erfolgreiche Antwort (Antwortstruktur in der Quelle nicht dokumentiert, z.B. Binärinhalt oder leerer Body)" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/importapi_uploadimportset": post: tags: - "ImportAPI" summary: "Uploads an importset for bulk imports" description: "Operation **ImportAPI_UploadImportSet**.\n\nUploads an importset for bulk imports\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#importapi_uploadimportset" operationId: "ImportAPI_UploadImportSet" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ImportAPI_UploadImportSet" example: UserName: "String" Password: "String" SystemReference: 0 ImportName: "String" ImportTagName: "String" BatchImportGuid: "String" StartImportAfterUpload: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ImportAPI_UploadImportSetResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" BatchImport: Batchimportid: 0 Batchimportguid: "00000000000000000000000000000000" Systemreference: 0 Name: "String" Tagname: "String" Owner: 0 Ownername: "String" Status: 0 Comment: "String" Usercommented: 0 Commentedusername: "String" Datecommented: "0001-01-01T00:00:00" Userresolved: 0 Resolvedusername: "String" Dateresolved: "0001-01-01T00:00:00" UploadGuid: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/importadmin_getimportlist": post: tags: - "ImportAdmin" summary: "Gets all defined imports users for the specified filters" description: "Operation **ImportAdmin_GetImportList**.\n\nGets all defined imports users for the specified filters\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#importadmin_getimportlist" operationId: "ImportAdmin_GetImportList" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_GetImportList" example: SessionGuid: "00000000000000000000000000000000" UserId: 0 ImportStatusMask: 0 ExcludedImportStatusMask: 0 TextFilter: "String" ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" PageNumber: 0 PageSize: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_GetImportListResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/importadmin_getimportlog": post: tags: - "ImportAdmin" summary: "Gets all defined imports users for the specified filters" description: "Operation **ImportAdmin_GetImportLog**.\n\nGets all defined imports users for the specified filters\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#importadmin_getimportlog" operationId: "ImportAdmin_GetImportLog" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_GetImportLog" example: SessionGuid: "00000000000000000000000000000000" BatchImportId: 0 BatchImportSessionId: 0 ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" PageNumber: 0 PageSize: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_GetImportLogResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TotalItemCount: 0 TotalPageCount: 0 PageSize: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/importadmin_getimportsessions": post: tags: - "ImportAdmin" summary: "Gets all defined imports users for the specified filters" description: "Operation **ImportAdmin_GetImportSessions**.\n\nGets all defined imports users for the specified filters\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#importadmin_getimportsessions" operationId: "ImportAdmin_GetImportSessions" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_GetImportSessions" example: SessionGuid: "00000000000000000000000000000000" BatchImportId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_GetImportSessionsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/importadmin_getimportset": post: tags: - "ImportAdmin" summary: "Retrieves the specified batchimportset (by batchimport id)" description: "Operation **ImportAdmin_GetImportSet**.\n\nRetrieves the specified batchimportset (by batchimport id)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#importadmin_getimportset" operationId: "ImportAdmin_GetImportSet" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_GetImportSet" example: Batchimportids: - 0 BatchimportSetType: "Original" IncludeLog: false SessionGuid: "00000000000000000000000000000000" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_GetImportSetResponse" example: {} default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/importadmin_getimportusers": post: tags: - "ImportAdmin" summary: "Gets all defined import users for the given system/tenant" description: "Operation **ImportAdmin_GetImportUsers**.\n\nGets all defined import users for the given system/tenant\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#importadmin_getimportusers" operationId: "ImportAdmin_GetImportUsers" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_GetImportUsers" example: SessionGuid: "00000000000000000000000000000000" FilterByImportuserid: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_GetImportUsersResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/importadmin_getimportuserstree": post: tags: - "ImportAdmin" summary: "Gets all defined import users for the given system/tenant" description: "Operation **ImportAdmin_GetImportUsersTree**.\n\nGets all defined import users for the given system/tenant\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#importadmin_getimportuserstree" operationId: "ImportAdmin_GetImportUsersTree" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_GetImportUsersTree" example: SessionGuid: "00000000000000000000000000000000" UserId: 0 ImportStatusMask: 0 TextFilter: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_GetImportUsersTreeResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/importadmin_setimportcomment": post: tags: - "ImportAdmin" summary: "Sets a comment for all defined batchimports" description: "Operation **ImportAdmin_SetImportComment**.\n\nSets a comment for all defined batchimports\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#importadmin_setimportcomment" operationId: "ImportAdmin_SetImportComment" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_SetImportComment" example: SessionGuid: "00000000000000000000000000000000" BatchImportIds: - 0 Comment: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_SetImportCommentResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/importadmin_setimportresolvedflag": post: tags: - "ImportAdmin" summary: "Sets or deletes reolved flag on all defined batchimports" description: "Operation **ImportAdmin_SetImportResolvedFlag**.\n\nSets or deletes reolved flag on all defined batchimports\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#importadmin_setimportresolvedflag" operationId: "ImportAdmin_SetImportResolvedFlag" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_SetImportResolvedFlag" example: SessionGuid: "00000000000000000000000000000000" BatchImportIds: - 0 Resolved: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_SetImportResolvedFlagResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/importadmin_setimportuser": post: tags: - "ImportAdmin" summary: "Creates or updates (e.g. renames/disables) an import user" description: "Operation **ImportAdmin_SetImportUser**.\n\nCreates or updates (e.g. renames/disables) an import user\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#importadmin_setimportuser" operationId: "ImportAdmin_SetImportUser" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_SetImportUser" example: SessionGuid: "00000000000000000000000000000000" ImportUser: Batchimportuserid: 0 Systemreference: 0 Username: "String" NewPassword: "String" Allowlogin: false Batchimportuseremail: "String" Batchimportusertype: 0 Allowednetworks: "String" Blockednetworks: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/ImportAdmin_SetImportUserResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ImportUser: Batchimportuserid: 0 Systemreference: 0 Username: "String" NewPassword: "String" Allowlogin: false Batchimportuseremail: "String" Batchimportusertype: 0 Allowednetworks: "String" Blockednetworks: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_batchobjectchanger": post: tags: - "LocalAdmin" summary: "Performs batch changes of fields and object types" description: "Operation **LocalAdmin_BatchObjectChanger**.\n\nPerforms batch changes of fields and object types\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_batchobjectchanger" operationId: "LocalAdmin_BatchObjectChanger" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_BatchObjectChanger" example: SessionGuid: "00000000000000000000000000000000" Simulation: false BatchObjectChangeOperations: - SourceObjectTypeId: 0 DestinationObjectTypeId: 0 ObjectTypeDefinitionChangeOperations: - SourceObjectTypeDefinitionId: 0 DestinationObjectTypeDefinitionId: 0 SourceSystemReferenceId: 0 DestinationSystemReferenceId: 0 OnlyProcessSubElementsOf: 0 RestrictToObjectIds: - 0 LoggerName: "String" LogComment: "String" Limit: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_BatchObjectChangerResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_cleanduplicates": post: tags: - "LocalAdmin" summary: "Searches for key field duplicates and repairs data structures" description: "Operation **LocalAdmin_CleanDuplicates**.\n\nSearches for key field duplicates and repairs data structures\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_cleanduplicates" operationId: "LocalAdmin_CleanDuplicates" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_CleanDuplicates" example: SessionGuid: "00000000000000000000000000000000" Simulation: false ObjectTypeIds: - 0 LoggerName: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_CleanDuplicatesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_deleteaccessruleassignments": post: tags: - "LocalAdmin" summary: "Deletes assignments of access rules to users/groups" description: "Operation **LocalAdmin_DeleteAccessRuleAssignments**.\n\nDeletes assignments of access rules to users/groups\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_deleteaccessruleassignments" operationId: "LocalAdmin_DeleteAccessRuleAssignments" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_DeleteAccessRuleAssignments" example: SessionGuid: "00000000000000000000000000000000" DeletionList: - Group: 0 Rule: 0 Right: 0 Objecttype: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_DeleteAccessRuleAssignmentsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_deleteaccessrules": post: tags: - "LocalAdmin" summary: "Deletes access rules and their details" description: "Operation **LocalAdmin_DeleteAccessRules**.\n\nDeletes access rules and their details\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_deleteaccessrules" operationId: "LocalAdmin_DeleteAccessRules" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_DeleteAccessRules" example: SessionGuid: "00000000000000000000000000000000" ConstrIds: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_DeleteAccessRulesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_deleteextendedaccessrules": post: tags: - "LocalAdmin" summary: "Deletes extended access rules" description: "Operation **LocalAdmin_DeleteExtendedAccessRules**.\n\nDeletes extended access rules\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_deleteextendedaccessrules" operationId: "LocalAdmin_DeleteExtendedAccessRules" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_DeleteExtendedAccessRules" example: SessionGuid: "00000000000000000000000000000000" ConstrIds: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_DeleteExtendedAccessRulesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_getaccessruleassignments": post: tags: - "LocalAdmin" summary: "Retrieves assignments of access rules to users and groups" description: "Operation **LocalAdmin_GetAccessRuleAssignments**.\n\nRetrieves assignments of access rules to users and groups\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_getaccessruleassignments" operationId: "LocalAdmin_GetAccessRuleAssignments" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_GetAccessRuleAssignments" example: SessionGuid: "00000000000000000000000000000000" Context: SystemReference: 0 ImpersonatedUser: 0 FilterByObjectTypeId: 0 FilterByConstrId: 0 FilterByGroupId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_GetAccessRuleAssignmentsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" AssignmentList: - Group: 0 Rule: 0 Right: 0 Objecttype: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_getaccessrules": post: tags: - "LocalAdmin" summary: "Retrieves access rules and their details" description: "Operation **LocalAdmin_GetAccessRules**.\n\nRetrieves access rules and their details\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_getaccessrules" operationId: "LocalAdmin_GetAccessRules" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_GetAccessRules" example: SessionGuid: "00000000000000000000000000000000" Context: SystemReference: 0 ImpersonatedUser: 0 FilterByObjectTypeId: 0 FilterByConstrId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_GetAccessRulesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" AccessRuleList: - Constrid: 0 Constraintname: "String" Objecttype: 0 Constrainttype: "String" Systemreference: 0 Extendedconstr: RuleElementType: "OR" Field: "String" Operator: "String" Values: - "String" Constrstatus: 0 IsHierarchic: false default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_getextendedaccessrules": post: tags: - "LocalAdmin" summary: "Retrieves extended access rules by various filter criteria" description: "Operation **LocalAdmin_GetExtendedAccessRules**.\n\nRetrieves extended access rules by various filter criteria\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_getextendedaccessrules" operationId: "LocalAdmin_GetExtendedAccessRules" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_GetExtendedAccessRules" example: SessionGuid: "00000000000000000000000000000000" FilterByUserOrGroupId: 0 RetrieveRuleDetails: false FilterByConstrId: 0 RetrieveRuleList: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_GetExtendedAccessRulesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_getlookuppluginconfigurationproperties": post: tags: - "LocalAdmin" summary: "Gets an configuration of an lookup plugin instance" description: "Operation **LocalAdmin_GetLookupPluginConfigurationProperties**.\n\nGets an configuration of an lookup plugin instance\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_getlookuppluginconfigurationproperties" operationId: "LocalAdmin_GetLookupPluginConfigurationProperties" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_GetLookupPluginConfigurationProperties" example: SessionGuid: "00000000000000000000000000000000" LookupPluginName: "String" Systemreference: 0 LookupPluginClass: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_GetLookupPluginConfigurationPropertiesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_getlookuppluginconfigurations": post: tags: - "LocalAdmin" summary: "Retrieves all possible lookup plugin configurations for given systemreferenceguid" description: "Operation **LocalAdmin_GetLookupPluginConfigurations**.\n\nRetrieves all possible lookup plugin configurations for given systemreferenceguid\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_getlookuppluginconfigurations" operationId: "LocalAdmin_GetLookupPluginConfigurations" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_GetLookupPluginConfigurations" example: SessionGuid: "00000000000000000000000000000000" RegisteredSystem: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_GetLookupPluginConfigurationsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_getserversettings": post: tags: - "LocalAdmin" summary: "Retrieves user settings for the logged in system" description: "Operation **LocalAdmin_GetServerSettings**.\n\nRetrieves user settings for the logged in system\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_getserversettings" operationId: "LocalAdmin_GetServerSettings" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_GetServerSettings" example: SessionGuid: "00000000000000000000000000000000" FilterBySettingKey: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_GetServerSettingsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_setaccessruleassignments": post: tags: - "LocalAdmin" summary: "Assigns access rules to users/groups and sets the access permissions granted" description: "Operation **LocalAdmin_SetAccessRuleAssignments**.\n\nAssigns access rules to users/groups and sets the access permissions granted\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_setaccessruleassignments" operationId: "LocalAdmin_SetAccessRuleAssignments" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_SetAccessRuleAssignments" example: SessionGuid: "00000000000000000000000000000000" Context: SystemReference: 0 ImpersonatedUser: 0 AssignmentList: - Group: 0 Rule: 0 Right: 0 Objecttype: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_SetAccessRuleAssignmentsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" AssignmentList: - Group: 0 Rule: 0 Right: 0 Objecttype: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_setaccessrules": post: tags: - "LocalAdmin" summary: "Creates or modifies access rules" description: "Operation **LocalAdmin_SetAccessRules**.\n\nCreates or modifies access rules\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_setaccessrules" operationId: "LocalAdmin_SetAccessRules" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_SetAccessRules" example: SessionGuid: "00000000000000000000000000000000" AccessRuleList: - Constrid: 0 Constraintname: "String" Objecttype: 0 Constrainttype: "String" Systemreference: 0 Extendedconstr: RuleElementType: "OR" Field: "String" Operator: "String" Values: - "String" Constrstatus: 0 IsHierarchic: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_SetAccessRulesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" AccessRuleList: - Constrid: 0 Constraintname: "String" Objecttype: 0 Constrainttype: "String" Systemreference: 0 Extendedconstr: RuleElementType: "OR" Field: "String" Operator: "String" Values: - "String" Constrstatus: 0 IsHierarchic: false default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_setextendedaccessrule": post: tags: - "LocalAdmin" summary: "Creates or modifies a extended access rule" description: "Operation **LocalAdmin_SetExtendedAccessRule**.\n\nCreates or modifies a extended access rule\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_setextendedaccessrule" operationId: "LocalAdmin_SetExtendedAccessRule" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_SetExtendedAccessRule" example: SessionGuid: "00000000000000000000000000000000" ExtendedRule: UserOrGroup: 0 RuleElement: Constrid: 0 Constraintname: "String" Objecttype: 0 Constrainttype: "String" Systemreference: 0 Extendedconstr: RuleElementType: "OR" Field: "String" Operator: "String" Values: - "String" Constrstatus: 0 IsHierarchic: false ObjectTypeAccessRightList: - AssignedAccessRight: 0 ObjectType: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_SetExtendedAccessRuleResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_setserversetting": post: tags: - "LocalAdmin" summary: "Stores a server setting for the logged in user" description: "Operation **LocalAdmin_SetServerSetting**.\n\nStores a server setting for the logged in user\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_setserversetting" operationId: "LocalAdmin_SetServerSetting" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_SetServerSetting" example: SessionGuid: "00000000000000000000000000000000" Context: SystemReference: 0 ImpersonatedUser: 0 ServerSetting: Settingkey: "String" Settingtext: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_SetServerSettingResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/localadmin_userlogout": post: tags: - "LocalAdmin" summary: "Logs out an existing user session" description: "Operation **LocalAdmin_UserLogout**.\n\nLogs out an existing user session\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#localadmin_userlogout" operationId: "LocalAdmin_UserLogout" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_UserLogout" example: SessionGuid: "00000000000000000000000000000000" SessionId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/LocalAdmin_UserLogoutResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/securedcontent_getkeys": post: tags: - "SecuredContent" summary: "Gets secured content collections accessible to the currently logged in user" description: "Operation **SecuredContent_GetKeys**.\n\nGets secured content collections accessible to the currently logged in user\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#securedcontent_getkeys" operationId: "SecuredContent_GetKeys" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SecuredContent_GetKeys" example: SessionGuid: "00000000000000000000000000000000" FilterByCollectionName: "String" FilterByCollectionType: "None" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SecuredContent_GetKeysResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/securedcontent_getsecuredcontent": post: tags: - "SecuredContent" summary: "Retrieves content that is stored in encrypted format internally" description: "Operation **SecuredContent_GetSecuredContent**.\n\nRetrieves content that is stored in encrypted format internally\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#securedcontent_getsecuredcontent" operationId: "SecuredContent_GetSecuredContent" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SecuredContent_GetSecuredContent" example: SessionGuid: "00000000000000000000000000000000" ObjectId: 0 ObjectTypeDefinitionId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SecuredContent_GetSecuredContentResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" Result: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/securedcontent_setkey": post: tags: - "SecuredContent" summary: "Sets a user's personal \"secured content password\" during runtime" description: "Operation **SecuredContent_SetKey**.\n\nSets a user's personal \"secured content password\" during runtime\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#securedcontent_setkey" operationId: "SecuredContent_SetKey" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/SecuredContent_SetKey" example: SessionGuid: "00000000000000000000000000000000" OperationMode: "None" SecuredContentPassword: "String" SecuredContentPassPhrase: "String" OldSecuredContentPassPhrase: "String" CollectionId: 0 CollectionName: "String" CollectionUserId: 0 CollectionMemberType: "Member" DeprecatedCollectionPrivateKey: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/SecuredContent_SetKeyResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" Collection: Sccollectionid: 0 Systemreference: 0 Coltype: 0 Colstatus: 0 Name: "String" Usercreated: 0 Createdusername: "String" Dateedited: "0001-01-01T00:00:00" Useredited: 0 Editedusername: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/webclient/docuvita/resources/brandimage/{Name}/{Size}": post: tags: - "Web" summary: "Retrieves brand images" description: "Operation **Web_BrandImage**.\n\nRetrieves brand images\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_brandimage" operationId: "Web_BrandImage" parameters: - name: "Name" in: "path" required: true schema: type: "string" - name: "Size" in: "path" required: true schema: type: "integer" format: "int32" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_BrandImage" example: Name: "String" Size: 0 Language: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_BrandImageResponse" example: {} default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/webclient/docuvita/resources/brandimage/{Name}": post: tags: - "Web" summary: "Retrieves brand images" description: "Operation **Web_BrandImage**.\n\nRetrieves brand images\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_brandimage" operationId: "Web_BrandImage_route2" parameters: - name: "Name" in: "path" required: true schema: type: "string" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_BrandImage" example: Name: "String" Size: 0 Language: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_BrandImageResponse" example: {} default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web_getfavorites": post: tags: - "Web" summary: "Allows browsing and navigation in favorites" description: "Operation **Web_GetFavorites**.\n\nAllows browsing and navigation in favorites\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_getfavorites" operationId: "Web_GetFavorites" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_GetFavorites" example: SessionGuid: "00000000000000000000000000000000" FavoriteItemId: "String" ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_GetFavoritesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web_getmyworkspace": post: tags: - "Web" summary: "Retrieves the list of personal workspace items (e.g. customer records, project files etc.)" description: "Operation **Web_GetMyWorkspace**.\n\nRetrieves the list of personal workspace items (e.g. customer records, project files etc.)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_getmyworkspace" operationId: "Web_GetMyWorkspace" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_GetMyWorkspace" example: SessionGuid: "00000000000000000000000000000000" Context: SystemReference: 0 ImpersonatedUser: 0 WorkspaceItemId: "String" ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_GetMyWorkspaceResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web_getobjecttypeimage": post: tags: - "Web" summary: "Retrieves Objecttypeimage by given Objecttypeid and Size[SMALL|LARGE|MEDIUM|SELECTED]" description: "Operation **Web_GetObjectTypeImage**.\n\nRetrieves Objecttypeimage by given Objecttypeid and Size[SMALL|LARGE|MEDIUM|SELECTED]\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_getobjecttypeimage" operationId: "Web_GetObjectTypeImage" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_GetObjectTypeImage" example: SessionGuid: "00000000000000000000000000000000" Objecttypeid: 0 Size: "String" AsLink: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_GetObjectTypeImageResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web_getresources": post: tags: - "Web" summary: "Retrieves all language resources for the webclient in the given language" description: "Operation **Web_GetResources**.\n\nRetrieves all language resources for the webclient in the given language\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_getresources" operationId: "Web_GetResources" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_GetResources" example: Language: "String" IsMobile: false Refresh: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_GetResourcesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" ResourceDictionary: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web_getrightsgrid": post: tags: - "Web" summary: "Allows browsing and navigation in favorites" description: "Operation **Web_GetRightsGrid**.\n\nAllows browsing and navigation in favorites\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_getrightsgrid" operationId: "Web_GetRightsGrid" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_GetRightsGrid" example: SessionGuid: "00000000000000000000000000000000" ColumnFilter: "String" RowFilter: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_GetRightsGridResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web_getsearchtree": post: tags: - "Web" summary: "Displaying saved searches in a tree" description: "Operation **Web_GetSearchTree**.\n\nDisplaying saved searches in a tree\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_getsearchtree" operationId: "Web_GetSearchTree" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_GetSearchTree" example: SessionGuid: "00000000000000000000000000000000" UsersAndQueryItemId: "String" ResultSortConditions: - SortProperty: "Empty" SortOrder: "NoOrder" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_GetSearchTreeResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web_gettasktemplateimage": post: tags: - "Web" summary: "Retrieves image of task template by given workflow model id and task template name, and size[BIG|SMALL]" description: "Operation **Web_GetTaskTemplateImage**.\n\nRetrieves image of task template by given workflow model id and task template name, and size[BIG|SMALL]\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_gettasktemplateimage" operationId: "Web_GetTaskTemplateImage" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_GetTaskTemplateImage" example: SessionGuid: "00000000000000000000000000000000" Workflowmodelid: 0 Tasktemplate: "String" Size: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_GetTaskTemplateImageResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web_gettransformedpreview": post: tags: - "Web" summary: "Retrieves a preview document after the atempt to transform the passed document as HTML (e.g. X-Rechnung)." description: "Operation **Web_GetTransformedPreview**.\n\nRetrieves a preview document after the atempt to transform the passed document as HTML (e.g. X-Rechnung).\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_gettransformedpreview" operationId: "Web_GetTransformedPreview" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_GetTransformedPreview" example: SessionGuid: "00000000000000000000000000000000" Context: SystemReference: 0 ImpersonatedUser: 0 ObjectId: 0 VersionId: 0 FileContent: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_GetTransformedPreviewResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" TransformedPreview: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web_getwindowsclient": post: tags: - "Web" summary: "Web_GetWindowsClient" description: "Operation **Web_GetWindowsClient**.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_getwindowsclient" operationId: "Web_GetWindowsClient" responses: "200": description: "Erfolgreiche Antwort (Antwortstruktur in der Quelle nicht dokumentiert, z.B. Binärinhalt oder leerer Body)" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/client": post: tags: - "Web" summary: "Web_GetWindowsClient" description: "Operation **Web_GetWindowsClient**.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_getwindowsclient" operationId: "Web_GetWindowsClient_route2" responses: "200": description: "Erfolgreiche Antwort (Antwortstruktur in der Quelle nicht dokumentiert, z.B. Binärinhalt oder leerer Body)" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web_getworkflowcount": post: tags: - "Web" summary: "Retrieves the Count of workflows" description: "Operation **Web_GetWorkflowCount**.\n\nRetrieves the Count of workflows\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_getworkflowcount" operationId: "Web_GetWorkflowCount" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_GetWorkflowCount" example: SessionGuid: "00000000000000000000000000000000" UserId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_GetWorkflowCountResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" Counters: String: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web": get: tags: - "Web" summary: "Retrieve the login page for web client" description: "Operation **Web_Login**.\n\nRetrieve the login page for web client\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_login" operationId: "Web_Login" parameters: - name: "Language" in: "query" required: false schema: type: "string" - name: "SessionGuid" in: "query" required: false schema: type: "string" format: "uuid" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_LoginResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" MessageHeader: "String" ObjectId: "String" MessageText: "String" UrlPrefix: "String" Version: "String" Color1: "String" Color2: "String" Title: "String" Culture: "String" ExternalDownload: "String" TaskId: "String" WorkflowId: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" head: tags: - "Web" summary: "Web_TestConnection" description: "Operation **Web_TestConnection**.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_testconnection" operationId: "Web_TestConnection" responses: "200": description: "Erfolgreiche Antwort (Antwortstruktur in der Quelle nicht dokumentiert, z.B. Binärinhalt oder leerer Body)" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web/{FilterByRegisteredSystem}": get: tags: - "Web" summary: "Retrieve the login page for web client" description: "Operation **Web_Login**.\n\nRetrieve the login page for web client\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_login" operationId: "Web_Login_route2" parameters: - name: "FilterByRegisteredSystem" in: "path" required: true schema: type: "string" - name: "Language" in: "query" required: false schema: type: "string" - name: "SessionGuid" in: "query" required: false schema: type: "string" format: "uuid" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_LoginResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" MessageHeader: "String" ObjectId: "String" MessageText: "String" UrlPrefix: "String" Version: "String" Color1: "String" Color2: "String" Title: "String" Culture: "String" ExternalDownload: "String" TaskId: "String" WorkflowId: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" head: tags: - "Web" summary: "Web_TestConnection" description: "Operation **Web_TestConnection**.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_testconnection" operationId: "Web_TestConnection_route2" parameters: - name: "FilterByRegisteredSystem" in: "path" required: true schema: type: "string" responses: "200": description: "Erfolgreiche Antwort (Antwortstruktur in der Quelle nicht dokumentiert, z.B. Binärinhalt oder leerer Body)" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/index": get: tags: - "Web" summary: "Retrieve the login page for web client" description: "Operation **Web_Login**.\n\nRetrieve the login page for web client\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_login" operationId: "Web_Login_route3" parameters: - name: "Language" in: "query" required: false schema: type: "string" - name: "SessionGuid" in: "query" required: false schema: type: "string" format: "uuid" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_LoginResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" MessageHeader: "String" ObjectId: "String" MessageText: "String" UrlPrefix: "String" Version: "String" Color1: "String" Color2: "String" Title: "String" Culture: "String" ExternalDownload: "String" TaskId: "String" WorkflowId: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" head: tags: - "Web" summary: "Web_TestConnection" description: "Operation **Web_TestConnection**.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_testconnection" operationId: "Web_TestConnection_route3" responses: "200": description: "Erfolgreiche Antwort (Antwortstruktur in der Quelle nicht dokumentiert, z.B. Binärinhalt oder leerer Body)" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/debug": get: tags: - "Web" summary: "Retrieve the login page for web client" description: "Operation **Web_Login**.\n\nRetrieve the login page for web client\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_login" operationId: "Web_Login_route4" parameters: - name: "Language" in: "query" required: false schema: type: "string" - name: "SessionGuid" in: "query" required: false schema: type: "string" format: "uuid" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_LoginResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" MessageHeader: "String" ObjectId: "String" MessageText: "String" UrlPrefix: "String" Version: "String" Color1: "String" Color2: "String" Title: "String" Culture: "String" ExternalDownload: "String" TaskId: "String" WorkflowId: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" head: tags: - "Web" summary: "Web_TestConnection" description: "Operation **Web_TestConnection**.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_testconnection" operationId: "Web_TestConnection_route4" responses: "200": description: "Erfolgreiche Antwort (Antwortstruktur in der Quelle nicht dokumentiert, z.B. Binärinhalt oder leerer Body)" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web/{FilterByRegisteredSystem}/{ObjectId}": get: tags: - "Web" summary: "Retrieve the login page for web client" description: "Operation **Web_Login**.\n\nRetrieve the login page for web client\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_login" operationId: "Web_Login_route5" parameters: - name: "FilterByRegisteredSystem" in: "path" required: true schema: type: "string" - name: "ObjectId" in: "path" required: true schema: type: "string" - name: "Language" in: "query" required: false schema: type: "string" - name: "SessionGuid" in: "query" required: false schema: type: "string" format: "uuid" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_LoginResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" MessageHeader: "String" ObjectId: "String" MessageText: "String" UrlPrefix: "String" Version: "String" Color1: "String" Color2: "String" Title: "String" Culture: "String" ExternalDownload: "String" TaskId: "String" WorkflowId: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web/{FilterByRegisteredSystem}/Task/{TaskId}": post: tags: - "Web" summary: "Retrieve the login page for web client" description: "Operation **Web_Login**.\n\nRetrieve the login page for web client\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_login" operationId: "Web_Login_route6" parameters: - name: "FilterByRegisteredSystem" in: "path" required: true schema: type: "string" - name: "TaskId" in: "path" required: true schema: type: "string" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_Login" example: SessionGuid: "00000000000000000000000000000000" FilterByRegisteredSystem: "String" ObjectId: "String" Language: "String" TaskId: "String" WorkflowId: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_LoginResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" MessageHeader: "String" ObjectId: "String" MessageText: "String" UrlPrefix: "String" Version: "String" Color1: "String" Color2: "String" Title: "String" Culture: "String" ExternalDownload: "String" TaskId: "String" WorkflowId: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web/{FilterByRegisteredSystem}/Workflow/{WorkflowId}": post: tags: - "Web" summary: "Retrieve the login page for web client" description: "Operation **Web_Login**.\n\nRetrieve the login page for web client\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_login" operationId: "Web_Login_route7" parameters: - name: "FilterByRegisteredSystem" in: "path" required: true schema: type: "string" - name: "WorkflowId" in: "path" required: true schema: type: "string" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_Login" example: SessionGuid: "00000000000000000000000000000000" FilterByRegisteredSystem: "String" ObjectId: "String" Language: "String" TaskId: "String" WorkflowId: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_LoginResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" MessageHeader: "String" ObjectId: "String" MessageText: "String" UrlPrefix: "String" Version: "String" Color1: "String" Color2: "String" Title: "String" Culture: "String" ExternalDownload: "String" TaskId: "String" WorkflowId: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/debug/{FilterByRegisteredSystem}": post: tags: - "Web" summary: "Retrieve the login page for web client" description: "Operation **Web_Login**.\n\nRetrieve the login page for web client\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_login" operationId: "Web_Login_route8" parameters: - name: "FilterByRegisteredSystem" in: "path" required: true schema: type: "string" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_Login" example: SessionGuid: "00000000000000000000000000000000" FilterByRegisteredSystem: "String" ObjectId: "String" Language: "String" TaskId: "String" WorkflowId: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_LoginResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" MessageHeader: "String" ObjectId: "String" MessageText: "String" UrlPrefix: "String" Version: "String" Color1: "String" Color2: "String" Title: "String" Culture: "String" ExternalDownload: "String" TaskId: "String" WorkflowId: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/debug/{FilterByRegisteredSystem}/{ObjectId}": post: tags: - "Web" summary: "Retrieve the login page for web client" description: "Operation **Web_Login**.\n\nRetrieve the login page for web client\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_login" operationId: "Web_Login_route9" parameters: - name: "FilterByRegisteredSystem" in: "path" required: true schema: type: "string" - name: "ObjectId" in: "path" required: true schema: type: "string" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_Login" example: SessionGuid: "00000000000000000000000000000000" FilterByRegisteredSystem: "String" ObjectId: "String" Language: "String" TaskId: "String" WorkflowId: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_LoginResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" MessageHeader: "String" ObjectId: "String" MessageText: "String" UrlPrefix: "String" Version: "String" Color1: "String" Color2: "String" Title: "String" Culture: "String" ExternalDownload: "String" TaskId: "String" WorkflowId: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/debug/{FilterByRegisteredSystem}/Task/{TaskId}": post: tags: - "Web" summary: "Retrieve the login page for web client" description: "Operation **Web_Login**.\n\nRetrieve the login page for web client\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_login" operationId: "Web_Login_route10" parameters: - name: "FilterByRegisteredSystem" in: "path" required: true schema: type: "string" - name: "TaskId" in: "path" required: true schema: type: "string" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_Login" example: SessionGuid: "00000000000000000000000000000000" FilterByRegisteredSystem: "String" ObjectId: "String" Language: "String" TaskId: "String" WorkflowId: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_LoginResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" MessageHeader: "String" ObjectId: "String" MessageText: "String" UrlPrefix: "String" Version: "String" Color1: "String" Color2: "String" Title: "String" Culture: "String" ExternalDownload: "String" TaskId: "String" WorkflowId: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/debug/{FilterByRegisteredSystem}/Workflow/{WorkflowId}": post: tags: - "Web" summary: "Retrieve the login page for web client" description: "Operation **Web_Login**.\n\nRetrieve the login page for web client\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_login" operationId: "Web_Login_route11" parameters: - name: "FilterByRegisteredSystem" in: "path" required: true schema: type: "string" - name: "WorkflowId" in: "path" required: true schema: type: "string" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_Login" example: SessionGuid: "00000000000000000000000000000000" FilterByRegisteredSystem: "String" ObjectId: "String" Language: "String" TaskId: "String" WorkflowId: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_LoginResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" MessageHeader: "String" ObjectId: "String" MessageText: "String" UrlPrefix: "String" Version: "String" Color1: "String" Color2: "String" Title: "String" Culture: "String" ExternalDownload: "String" TaskId: "String" WorkflowId: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/logout": post: tags: - "Web" summary: "Retrieve the logout page for web client" description: "Operation **Web_Logout**.\n\nRetrieve the logout page for web client\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_logout" operationId: "Web_Logout" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_Logout" example: SessionGuid: "00000000000000000000000000000000" FilterByRegisteredSystem: "String" Language: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_LogoutResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" System: Systemreferenceid: 0 Systemname: "String" Systemguid: "String" IsRemote: 0 Remotehost: "String" Remoteport: 0 Systemstatus: 0 Admingroup: 0 Filestoreaddress: "String" Importstoreaddress: "String" Importgroup: 0 Systemalias: "String" Deleteadmingroup: 0 Deletemode: 0 Workflowadmingroup: 0 Mailconfiguration: "String" Defaultpassword: "String" Mailnewuserpassword: 0 Defaultculture: "String" Signatureconfig: "String" Crypttype: 0 Constraintsadmingroup: 0 Rightsadmingroup: 0 Workflowrolesadmingroup: 0 Externalusergroup: 0 Systemurl: "String" Objectlogdbaddress: "String" Importlogdbaddress: "String" Primarycolor: "String" Secondarycolor: "String" Logosmall: "AA==" Logomedium: "AA==" Logolarge: "AA==" Logoxlarge: "AA==" MessageHeader: "String" MessageText: "String" UrlPrefix: "String" LoginUrl: "String" Color1: "String" Color2: "String" Title: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/logout/{FilterByRegisteredSystem}": post: tags: - "Web" summary: "Retrieve the logout page for web client" description: "Operation **Web_Logout**.\n\nRetrieve the logout page for web client\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_logout" operationId: "Web_Logout_route2" parameters: - name: "FilterByRegisteredSystem" in: "path" required: true schema: type: "string" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_Logout" example: SessionGuid: "00000000000000000000000000000000" FilterByRegisteredSystem: "String" Language: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_LogoutResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" System: Systemreferenceid: 0 Systemname: "String" Systemguid: "String" IsRemote: 0 Remotehost: "String" Remoteport: 0 Systemstatus: 0 Admingroup: 0 Filestoreaddress: "String" Importstoreaddress: "String" Importgroup: 0 Systemalias: "String" Deleteadmingroup: 0 Deletemode: 0 Workflowadmingroup: 0 Mailconfiguration: "String" Defaultpassword: "String" Mailnewuserpassword: 0 Defaultculture: "String" Signatureconfig: "String" Crypttype: 0 Constraintsadmingroup: 0 Rightsadmingroup: 0 Workflowrolesadmingroup: 0 Externalusergroup: 0 Systemurl: "String" Objectlogdbaddress: "String" Importlogdbaddress: "String" Primarycolor: "String" Secondarycolor: "String" Logosmall: "AA==" Logomedium: "AA==" Logolarge: "AA==" Logoxlarge: "AA==" MessageHeader: "String" MessageText: "String" UrlPrefix: "String" LoginUrl: "String" Color1: "String" Color2: "String" Title: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/testconnection": head: tags: - "Web" summary: "Web_TestConnection" description: "Operation **Web_TestConnection**.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_testconnection" operationId: "Web_TestConnection_route5" responses: "200": description: "Erfolgreiche Antwort (Antwortstruktur in der Quelle nicht dokumentiert, z.B. Binärinhalt oder leerer Body)" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/web_updateaccessruleassignments": post: tags: - "Web" summary: "Updates" description: "Operation **Web_UpdateAccessRuleAssignments**.\n\nUpdates\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#web_updateaccessruleassignments" operationId: "Web_UpdateAccessRuleAssignments" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/Web_UpdateAccessRuleAssignments" example: SessionGuid: "00000000000000000000000000000000" AssignmentList: - Group: 0 Rule: 0 Right: 0 Objecttype: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/Web_UpdateAccessRuleAssignmentsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" AssignmentList: - Group: 0 Rule: 0 Right: 0 Objecttype: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/workflowadmin_deleteworkflowmodel": post: tags: - "WorkflowAdmin" summary: "Deletes an existing workflow model given that it is not used in running workflows" description: "Operation **WorkflowAdmin_DeleteWorkflowModel**.\n\nDeletes an existing workflow model given that it is not used in running workflows\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#workflowadmin_deleteworkflowmodel" operationId: "WorkflowAdmin_DeleteWorkflowModel" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_DeleteWorkflowModel" example: SessionGuid: "00000000000000000000000000000000" WorkflowModelId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_DeleteWorkflowModelResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/workflowadmin_deleteworkflowmodelregistrations": post: tags: - "WorkflowAdmin" summary: "Deletes registrations of workflow models to user/group/role and object type" description: "Operation **WorkflowAdmin_DeleteWorkflowModelRegistrations**.\n\nDeletes registrations of workflow models to user/group/role and object type\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#workflowadmin_deleteworkflowmodelregistrations" operationId: "WorkflowAdmin_DeleteWorkflowModelRegistrations" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_DeleteWorkflowModelRegistrations" example: SessionGuid: "00000000000000000000000000000000" WorkflowModelRegistrationIds: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_DeleteWorkflowModelRegistrationsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/workflowadmin_getavailableworkflowactions": post: tags: - "WorkflowAdmin" summary: "Retrieves available workflow action classes" description: "Operation **WorkflowAdmin_GetAvailableWorkflowActions**.\n\nRetrieves available workflow action classes\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#workflowadmin_getavailableworkflowactions" operationId: "WorkflowAdmin_GetAvailableWorkflowActions" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_GetAvailableWorkflowActions" example: SessionGuid: "00000000000000000000000000000000" FilterByActionName: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_GetAvailableWorkflowActionsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/workflowadmin_getworkflowactionconfiguration": post: tags: - "WorkflowAdmin" summary: "Retrieves the list of configuration properties for a named workflow action (i.e. to create a new action of this type)" description: "Operation **WorkflowAdmin_GetWorkflowActionConfiguration**.\n\nRetrieves the list of configuration properties for a named workflow action (i.e. to create a new action of this type)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#workflowadmin_getworkflowactionconfiguration" operationId: "WorkflowAdmin_GetWorkflowActionConfiguration" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_GetWorkflowActionConfiguration" example: SessionGuid: "00000000000000000000000000000000" ActionClassName: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_GetWorkflowActionConfigurationResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/workflowadmin_getworkflowmodelentries": post: tags: - "WorkflowAdmin" summary: "Retrieves stored WorkflowModel objects (will not return workflow definition, entry only)" description: "Operation **WorkflowAdmin_GetWorkflowModelEntries**.\n\nRetrieves stored WorkflowModel objects (will not return workflow definition, entry only)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#workflowadmin_getworkflowmodelentries" operationId: "WorkflowAdmin_GetWorkflowModelEntries" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_GetWorkflowModelEntries" example: SessionGuid: "00000000000000000000000000000000" FilterByWorkflowModelGuid: "String" FilterByWorkflowModelName: "String" FilterByWorkflowModelId: 0 EnabledRecordsOnly: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_GetWorkflowModelEntriesResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/workflowadmin_getworkflowmodelregistrations": post: tags: - "WorkflowAdmin" summary: "Retrieves registrations of workflow models to users/groups/roles and object types" description: "Operation **WorkflowAdmin_GetWorkflowModelRegistrations**.\n\nRetrieves registrations of workflow models to users/groups/roles and object types\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#workflowadmin_getworkflowmodelregistrations" operationId: "WorkflowAdmin_GetWorkflowModelRegistrations" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_GetWorkflowModelRegistrations" example: SessionGuid: "00000000000000000000000000000000" WorkflowModelIds: - 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_GetWorkflowModelRegistrationsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/workflowadmin_getworkflowrolesgrid": post: tags: - "WorkflowAdmin" summary: "Allows browsing and navigation in favorites" description: "Operation **WorkflowAdmin_GetWorkflowRolesGrid**.\n\nAllows browsing and navigation in favorites\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#workflowadmin_getworkflowrolesgrid" operationId: "WorkflowAdmin_GetWorkflowRolesGrid" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_GetWorkflowRolesGrid" example: SessionGuid: "00000000000000000000000000000000" ColumnFilter: "String" RowFilter: "String" AddedWorkflowRoles: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_GetWorkflowRolesGridResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/workflowadmin_getworkflowtemplate": post: tags: - "WorkflowAdmin" summary: "Retrieves a workflow template by ID, selected from list of dtoWorkflowModel entries" description: "Operation **WorkflowAdmin_GetWorkflowTemplate**.\n\nRetrieves a workflow template by ID, selected from list of dtoWorkflowModel entries\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#workflowadmin_getworkflowtemplate" operationId: "WorkflowAdmin_GetWorkflowTemplate" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_GetWorkflowTemplate" example: SessionGuid: "00000000000000000000000000000000" WorkflowModelId: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_GetWorkflowTemplateResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" WorkflowTemplate: TaskTemplates: - TaskTemplateName: "String" TaskTemplateDisplayName: "String" TaskTemplateDescription: "String" TaskTemplateType: "End" TaskFormType: "PropertyGrid" TaskFormDefinition: "String" TaskAssignedToRoles: "String" TaskAssignedToUsersAndGroups: "String" TaskTransitions: - IsDefaultTransition: false TaskResult: "String" DestinationTask: "String" TaskActions: - TaskState: "Stopped" Enabled: false ActionClass: "String" StartConditionType: "NoCondition" StartCondition: "String" ActionDescription: "String" TaskDelay: 0 TaskDue: 0 TaskReminder: 0 TaskTimeout: 0 DisplayOptions: 0 TemporaryAccessRights: 0 TaskFormValidationScript: "String" PermanentAccessRights: 0 TaskLayout: Top: 0 Left: 0 LogTaskAssignmentToRoles: false LogTaskAssignmentToUsersAndGroups: false TaskFormHtml: "String" MultiUserTaskAbortResults: - "String" IsAutoTaskWaitForCompleteTask: false ImageSmall: "AA==" ImageMedium: "AA==" ImageLarge: "AA==" TaskDelayWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false TaskDueWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false TaskReminderWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false TaskTimeoutWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false WorkflowValueFormValidationScript: "String" WorkflowWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false GlobalWorkflowActions: - TaskState: "Stopped" Enabled: false ActionClass: "String" StartConditionType: "NoCondition" StartCondition: "String" ActionDescription: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/workflowadmin_setworkflowmodel": post: tags: - "WorkflowAdmin" summary: "Creates or modifies workflow models" description: "Operation **WorkflowAdmin_SetWorkflowModel**.\n\nCreates or modifies workflow models\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#workflowadmin_setworkflowmodel" operationId: "WorkflowAdmin_SetWorkflowModel" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_SetWorkflowModel" example: SessionGuid: "00000000000000000000000000000000" WorkflowModelEntry: Workflowmodelid: 0 Workflowmodelguid: "00000000000000000000000000000000" Systemreference: 0 Workflowmodelversion: 0 Enabled: false Name: "String" Displayname: "String" Description: "String" Category: "String" Dateedited: "0001-01-01T00:00:00" Usercreated: 0 Useredited: 0 Createdusername: "String" Editedusername: "String" Workflowmodeltype: 0 WorkflowModel: TaskTemplates: - TaskTemplateName: "String" TaskTemplateDisplayName: "String" TaskTemplateDescription: "String" TaskTemplateType: "End" TaskFormType: "PropertyGrid" TaskFormDefinition: "String" TaskAssignedToRoles: "String" TaskAssignedToUsersAndGroups: "String" TaskTransitions: - IsDefaultTransition: false TaskResult: "String" DestinationTask: "String" TaskActions: - TaskState: "Stopped" Enabled: false ActionClass: "String" StartConditionType: "NoCondition" StartCondition: "String" ActionDescription: "String" TaskDelay: 0 TaskDue: 0 TaskReminder: 0 TaskTimeout: 0 DisplayOptions: 0 TemporaryAccessRights: 0 TaskFormValidationScript: "String" PermanentAccessRights: 0 TaskLayout: Top: 0 Left: 0 LogTaskAssignmentToRoles: false LogTaskAssignmentToUsersAndGroups: false TaskFormHtml: "String" MultiUserTaskAbortResults: - "String" IsAutoTaskWaitForCompleteTask: false ImageSmall: "AA==" ImageMedium: "AA==" ImageLarge: "AA==" TaskDelayWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false TaskDueWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false TaskReminderWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false TaskTimeoutWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false WorkflowValueFormValidationScript: "String" WorkflowWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false GlobalWorkflowActions: - TaskState: "Stopped" Enabled: false ActionClass: "String" StartConditionType: "NoCondition" StartCondition: "String" ActionDescription: "String" responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_SetWorkflowModelResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" WorkflowModel: Workflowmodelid: 0 Workflowmodelguid: "00000000000000000000000000000000" Systemreference: 0 Workflowmodelversion: 0 Enabled: false Name: "String" Displayname: "String" Description: "String" Category: "String" Dateedited: "0001-01-01T00:00:00" Usercreated: 0 Useredited: 0 Createdusername: "String" Editedusername: "String" Workflowmodeltype: 0 default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/admin_setworkflowmodelregistrations": post: tags: - "WorkflowAdmin" summary: "Creates or modifies workflow model registration records (these allow users/roles/groups to start workflows for defined object types)" description: "Operation **WorkflowAdmin_SetWorkflowModelRegistrations**.\n\nCreates or modifies workflow model registration records (these allow users/roles/groups to start workflows for defined object types)\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#workflowadmin_setworkflowmodelregistrations" operationId: "WorkflowAdmin_SetWorkflowModelRegistrations" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_SetWorkflowModelRegistrations" example: SessionGuid: "00000000000000000000000000000000" WorkflowModelRegistrations: - Workflowmodelregistrationid: 0 Workflowmodel: 0 Startbyrole: "String" Startbyuser: 0 Startbygroup: 0 Objecttype: 0 Registrationtype: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_SetWorkflowModelRegistrationsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/workflowadmin_setworkflowroleassignments": post: tags: - "WorkflowAdmin" summary: "Updates" description: "Operation **WorkflowAdmin_SetWorkflowRoleAssignments**.\n\nUpdates\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#workflowadmin_setworkflowroleassignments" operationId: "WorkflowAdmin_SetWorkflowRoleAssignments" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_SetWorkflowRoleAssignments" example: SessionGuid: "00000000000000000000000000000000" AssignmentList: - User: AccessRight: 0 Parentobject: 0 Objecttype: 0 IsLink: false Fulltext: "String" Objectid: 0 Name: "String" Description: "String" Usercreated: 0 Dateedited: "0001-01-01T00:00:00" Useredited: 0 Status: 0 Checkoutuser: 0 Checkoutlocation: "String" Deleteflag: 0 Documentdate: "0001-01-01T00:00:00" Abspath: "String" Otpath: "String" Fileextension: "String" Versioncount: 0 Createdusername: "String" Editedusername: "String" Notecount: 0 Systemreference: 0 Barcode: "String" Documenttype: "String" Voucherdate: "0001-01-01T00:00:00" Vouchertype: "String" Vouchernumber: "String" Externalvouchernumber: "String" Transactionkey: "String" Transactiontype: "String" Validfrom: "0001-01-01T00:00:00" Validuntil: "0001-01-01T00:00:00" Deleteflagsetby: 0 Deleteflagsetdate: "0001-01-01T00:00:00" Hiddenflagsetdate: "0001-01-01T00:00:00" Deletereason: 0 Approvalstatuscode: 0 Approvedby: 0 Approvedversion: 0 Latestversion: 0 Filesize: 0 Filehash: "String" Extmetadata: "String" Mailfrom: "String" Mailto: "String" Mailcc: "String" Mailbcc: "String" Mailsubject: "String" Mailmessageid: "String" Mailsenddate: "0001-01-01T00:00:00" Mailparentmailid: 0 Activeworkflowcount: 0 Relatedobjectscount: 0 Deletereasontext: "String" Updateabspath: 0 Lvl: 0 Role: "String" Assigned: 0 responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_SetWorkflowRoleAssignmentsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" "/archive/services/workflowadmin_testworkdaysettings": post: tags: - "WorkflowAdmin" summary: "Calculates time spans for workflow engine given custom work day settings." description: "Operation **WorkflowAdmin_TestWorkDaySettings**.\n\nCalculates time spans for workflow engine given custom work day settings.\n\nLaut Quelle für alle HTTP-Verben registriert („All Verbs“); hier als POST mit JSON-Body abgebildet.\n\nQuelle: https://wiki.fakturbox.de/de/tutorials/api-doku#workflowadmin_testworkdaysettings" operationId: "WorkflowAdmin_TestWorkDaySettings" requestBody: required: false content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_TestWorkDaySettings" example: SessionGuid: "00000000000000000000000000000000" TestTicks: 0 TestWorkDaySettings: ActiveWorkDays: 0 ShiftToNextWorkdayFromWeekend: false responses: "200": description: "Erfolgreiche Antwort" content: "application/json": schema: "$ref": "#/components/schemas/WorkflowAdmin_TestWorkDaySettingsResponse" example: ResponseStatus: ErrorCode: "String" Message: "String" StackTrace: "String" Errors: - ErrorCode: "String" FieldName: "String" Message: "String" Meta: String: "String" Meta: String: "String" default: description: "Fehler. Details stehen in ResponseStatus." content: "application/json": schema: "$ref": "#/components/schemas/ErrorResponse" components: schemas: AddExternalObjectsToMyWorkspace: type: "object" properties: ObjectExternalReferences: type: "array" items: type: "string" ObjectTypeId: type: "integer" format: "int32" UserId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Context: "$ref": "#/components/schemas/dvRequestContext" AddExternalObjectsToMyWorkspaceResponse: type: "object" properties: AddedObjectsList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" AddObjectsToMyWorkspace: type: "object" properties: ObjectReferences: type: "array" items: "$ref": "#/components/schemas/dvAddObjectToWorkspaceEntry" UserId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" AddObjectsToMyWorkspaceResponse: type: "object" properties: AddedObjectsList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" AddToFavorites: type: "object" properties: ObjectIds: type: "array" items: type: "integer" format: "int32" UserId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" AddToFavoritesResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" AddToMyWorkspace: type: "object" properties: ObjectIds: type: "array" items: type: "integer" format: "int32" UserId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" AddToMyWorkspaceResponse: type: "object" properties: AddedObjectsList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_CopyImageResourceContent: type: "object" properties: Name: type: "string" CopyFrom: "$ref": "#/components/schemas/dvImageResourceContent" CopyTo: "$ref": "#/components/schemas/dvImageResourceContent" SessionGuid: type: "string" format: "uuid" Admin_CopyImageResourceContentResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_CreateDocumentation: type: "object" properties: SessionGuid: type: "string" format: "uuid" Admin_CreateDocumentationResponse: type: "object" properties: DocumentationObject: "$ref": "#/components/schemas/dtoObjectsBase" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_DeleteAuthenticationModule: type: "object" properties: AuthenticationModuleConfigurationId: type: "array" items: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_DeleteAuthenticationModuleResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_DeleteCloudServiceGatewayPluginConfiguration: type: "object" properties: CloudServiceGatewayPluginConfigurationIds: type: "array" items: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_DeleteCloudServiceGatewayPluginConfigurationResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_DeleteImageResourceEntry: type: "object" properties: Name: type: "string" SessionGuid: type: "string" format: "uuid" Admin_DeleteImageResourceEntryResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_DeleteLookupPluginConfiguration: type: "object" properties: LookupPluginConfigurationId: type: "array" items: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_DeleteLookupPluginConfigurationResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_DeleteObjecttype: type: "object" properties: ObjectTypeId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_DeleteObjecttypedefinition: type: "object" properties: ObjectTypeDefinitionId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_DeleteObjecttypedefinitionResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_DeleteObjecttypeResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_DeleteOperationPluginConfiguration: type: "object" properties: OperationPluginConfigurationId: type: "array" items: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_DeleteOperationPluginConfigurationResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_DeleteTwoFactorAuthenticationPluginConfiguration: type: "object" properties: TwoFactorAuthenticationPluginConfigurationId: type: "array" items: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_DeleteTwoFactorAuthenticationPluginConfigurationResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_GetAuthenticationModuleConfigurationProperties: type: "object" properties: AuthenticationModuleConfigurationId: type: "integer" format: "int32" AuthenticationModuleClass: type: "string" SessionGuid: type: "string" format: "uuid" Admin_GetAuthenticationModuleConfigurationPropertiesResponse: type: "object" properties: ConfigurationPropertyList: type: "array" items: "$ref": "#/components/schemas/AuthenticationModuleConfigurationValue" SupportsUsermanagement: type: "boolean" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_GetAuthenticationModulePlugins: type: "object" properties: SessionGuid: type: "string" format: "uuid" Admin_GetAuthenticationModulePluginsResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ResultList: type: "array" items: "$ref": "#/components/schemas/dtoAuthenticationmoduleplugin" Admin_GetAuthenticationModules: type: "object" properties: RegisteredSystem: type: "integer" format: "int32" ClientType: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_GetAuthenticationModulesResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoAuthenticationmoduleconfiguration" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_GetAuthenticationUsermanagementList: type: "object" properties: AuthenticationConfigurationId: type: "integer" format: "int32" Path: type: "string" QueryTerm: type: "string" ItemType: "$ref": "#/components/schemas/dvUsermanagementItemType" SessionGuid: type: "string" format: "uuid" Admin_GetAuthenticationUsermanagementListResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dvUsermanagementItem" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_GetAuthenticationUsermanagementPath: type: "object" properties: AuthenticationConfigurationId: type: "integer" format: "int32" Path: type: "string" SessionGuid: type: "string" format: "uuid" Admin_GetAuthenticationUsermanagementPathResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dvUsermanagementItem" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_GetAuthenticationUsermanagementTree: type: "object" properties: AuthenticationConfigurationId: type: "integer" format: "int32" Root: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_GetAuthenticationUsermanagementTreeResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_GetCloudServiceGatewayPluginConfigurationProperties: type: "object" properties: CloudServiceGatewayPluginName: type: "string" Systemreference: type: "integer" format: "int32" CloudServiceGatewayPluginClass: type: "string" CloudServiceGatewayAttachZugferdToPdf: type: "boolean" SessionGuid: type: "string" format: "uuid" Admin_GetCloudServiceGatewayPluginConfigurationPropertiesResponse: type: "object" properties: ConfigurationPropertyList: type: "array" items: "$ref": "#/components/schemas/CloudServiceGatewayPluginConfigurationValue" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_GetCloudServiceGatewayPluginConfigurations: type: "object" properties: RegisteredSystem: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_GetCloudServiceGatewayPluginConfigurationsResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoCloudservicegatewaypluginconfiguration" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_GetCloudServiceGatewayPlugins: type: "object" properties: SessionGuid: type: "string" format: "uuid" Admin_GetCloudServiceGatewayPluginsResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ResultList: type: "array" items: "$ref": "#/components/schemas/dtoCloudservicegatewayplugin" Admin_GetImageResources: type: "object" properties: FilterByName: type: "string" FilterByImagetype: type: "integer" format: "int32" IncludeContentInResponse: type: "boolean" IncludeSmallImageInResponse: type: "boolean" ImageToStream: "$ref": "#/components/schemas/dvImageResourceContent" SessionGuid: type: "string" format: "uuid" Admin_GetImageResourcesResponse: type: "object" properties: ImageResourceList: type: "array" items: "$ref": "#/components/schemas/dtoImageresources" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_GetLookupPlugins: type: "object" properties: SessionGuid: type: "string" format: "uuid" Admin_GetLookupPluginsResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ResultList: type: "array" items: "$ref": "#/components/schemas/dtoLookupplugin" Admin_GetOperationPluginConfigurations: type: "object" properties: RegisteredSystem: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_GetOperationPluginConfigurationsResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoOperationpluginconfiguration" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_GetOperationPlugins: type: "object" properties: SessionGuid: type: "string" format: "uuid" Admin_GetOperationPluginsResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ResultList: type: "array" items: "$ref": "#/components/schemas/dtoOperationplugin" Admin_GetStatistics: type: "object" properties: RegisteredSystem: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_GetStatisticsResponse: type: "object" properties: TotalObjectsCount: type: "integer" format: "int32" TotalDocsCount: type: "integer" format: "int32" ActiveUserSessionsCount: type: "integer" format: "int32" ObjectMaintenanceQueueCount: type: "integer" format: "int32" SecurityMaintenanceQueueCount: type: "integer" format: "int32" IndexMaintenanceQueueCount: type: "integer" format: "int32" NeedsFulltextIndexingQueueCount: type: "integer" format: "int32" CurrentlyActiveUploads: type: "integer" format: "int32" TotalVersionsCount: type: "integer" format: "int32" TotalDocumentSpace: type: "string" MaxConcurrentUsersCount: type: "integer" format: "int32" MaxConcurrentWorkflowUsersCount: type: "integer" format: "int32" ActiveWorkflowUserSessionsCount: type: "integer" format: "int32" MaxSystems: type: "integer" format: "int32" BackgroundTaskInfo: type: "array" items: "$ref": "#/components/schemas/BackgroundTaskStatusInfo" WriteLockedObjectsCount: type: "integer" format: "int32" MaxLicenses: type: "integer" format: "int32" UsedLicenses: type: "integer" format: "int32" TotalRunningWorkflows: type: "integer" format: "int32" TotalWorkflowsWaitingForUserCompletion: type: "integer" format: "int32" TotalWorkflowsInProcessingQueue: type: "integer" format: "int32" TotalWorkflowsInProcessingState: type: "integer" format: "int32" FulltextPropertyWriterQueueCount: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_GetSystemCustomization: type: "object" properties: FilterByObjectTypeIds: type: "array" items: type: "integer" format: "int32" FilterByWorkflowIds: type: "array" items: type: "integer" format: "int32" FilterByRegisteredSystemIds: type: "array" items: type: "integer" format: "int32" FilterAuthenticationModuleIds: type: "array" items: type: "integer" format: "int32" FilterTwoFactorAuthenticationPluginIds: type: "array" items: type: "integer" format: "int32" FilterLookupPluginIds: type: "array" items: type: "integer" format: "int32" FilterCloudServiceGatewayIds: type: "array" items: type: "integer" format: "int32" IncludeStandardAccessRules: type: "boolean" IncludeExtendedAccessRules: type: "boolean" IncludeRegisteredSystems: type: "boolean" IncludeWorkflowRoles: type: "boolean" SessionGuid: type: "string" format: "uuid" Admin_GetSystemCustomizationResponse: type: "object" properties: ServerCustomization: "$ref": "#/components/schemas/dtoServerCustomization" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_GetTwoFactorAuthenticationPluginConfigurationProperties: type: "object" properties: TwoFactorAuthenticationPluginName: type: "string" Systemreference: type: "integer" format: "int32" TwoFactorAuthenticationPluginClass: type: "string" SessionGuid: type: "string" format: "uuid" Admin_GetTwoFactorAuthenticationPluginConfigurationPropertiesResponse: type: "object" properties: ConfigurationPropertyList: type: "array" items: "$ref": "#/components/schemas/TwoFactorAuthenticationPluginConfigurationValue" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_GetTwoFactorAuthenticationPluginConfigurations: type: "object" properties: RegisteredSystem: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_GetTwoFactorAuthenticationPluginConfigurationsResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoTwofactorauthenticationpluginconfiguration" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_GetTwoFactorAuthenticationPluginConfigurationUsers: type: "object" properties: SessionGuid: type: "string" format: "uuid" TwoFactorAuthenticationPluginConfigurationId: type: "integer" format: "int32" Admin_GetTwoFactorAuthenticationPluginConfigurationUsersResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" Admin_GetTwoFactorAuthenticationPlugins: type: "object" properties: SessionGuid: type: "string" format: "uuid" Admin_GetTwoFactorAuthenticationPluginsResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ResultList: type: "array" items: "$ref": "#/components/schemas/dtoTwofactorauthenticationplugin" Admin_ResetTwoFactorAuthenticationPluginConfiguration: type: "object" properties: ConfigurationId: type: "integer" format: "int32" ResetUserObjectIds: type: "array" items: type: "integer" format: "int32" ResetAllUsers: type: "boolean" SessionGuid: type: "string" format: "uuid" Admin_ResetTwoFactorAuthenticationPluginConfigurationResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SendTestEMail: type: "object" properties: MailConfigurationForTest: "$ref": "#/components/schemas/dvMailConfiguration" UseStoredMailConfiguration: type: "boolean" ToAddress: type: "string" SessionGuid: type: "string" format: "uuid" Admin_SendTestEMailResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SetAuthenticationModule: type: "object" properties: AuthenticationModuleConfiguration: "$ref": "#/components/schemas/dtoAuthenticationmoduleconfiguration" ConfigurationPropertyList: type: "array" items: "$ref": "#/components/schemas/AuthenticationModuleConfigurationValue" SessionGuid: type: "string" format: "uuid" Admin_SetAuthenticationModuleResponse: type: "object" properties: SavedConfiguration: "$ref": "#/components/schemas/dtoAuthenticationmoduleconfiguration" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SetAuthenticationUsermanagementUser: type: "object" properties: AuthenticationConfigurationId: type: "integer" format: "int32" GroupObjectId: type: "integer" format: "int32" UserInformation: type: "array" items: "$ref": "#/components/schemas/dvUsermanagementItem" SessionGuid: type: "string" format: "uuid" Admin_SetAuthenticationUsermanagementUserResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SetCloudServiceGatewayPluginConfiguration: type: "object" properties: CloudServiceGatewayPluginConfiguration: "$ref": "#/components/schemas/dtoCloudservicegatewaypluginconfiguration" ConfigurationPropertyList: type: "array" items: "$ref": "#/components/schemas/CloudServiceGatewayPluginConfigurationValue" SessionGuid: type: "string" format: "uuid" Admin_SetCloudServiceGatewayPluginConfigurationResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SetCustomizedStandardFields: type: "object" properties: ObjectTypeId: type: "integer" format: "int32" ObjectTypeDefinitionIdsToMerge: type: "array" items: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_SetCustomizedStandardFieldsResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SetImageResourceContent: type: "object" properties: Name: type: "string" ResourceToSet: "$ref": "#/components/schemas/dvImageResourceContent" SessionGuid: type: "string" format: "uuid" Admin_SetImageResourceContentResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SetImageResourceEntry: type: "object" properties: Name: type: "string" Imagetype: type: "integer" format: "int32" Mimetype: type: "string" Description: type: "string" SessionGuid: type: "string" format: "uuid" Admin_SetImageResourceEntryResponse: type: "object" properties: ImageResource: "$ref": "#/components/schemas/dtoImageresources" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SetLookupPluginConfiguration: type: "object" properties: LookupPluginConfiguration: "$ref": "#/components/schemas/dtoLookuppluginconfiguration" ConfigurationPropertyList: type: "array" items: "$ref": "#/components/schemas/LookupPluginConfigurationValue" FieldConfigurationList: type: "array" items: "$ref": "#/components/schemas/LookupPluginFieldConfiguration" SessionGuid: type: "string" format: "uuid" Admin_SetLookupPluginConfigurationResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SetObjecttype: type: "object" properties: Objecttype: "$ref": "#/components/schemas/dtoObjecttypes" ImageResourceName: type: "string" SessionGuid: type: "string" format: "uuid" Admin_SetObjecttypeDefinition: type: "object" properties: ObjecttypedefinitionList: type: "array" items: "$ref": "#/components/schemas/dtoObjecttypedefinition" SessionGuid: type: "string" format: "uuid" Admin_SetObjecttypeDefinitionResponse: type: "object" properties: ObjecttypedefinitionResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjecttypedefinition" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SetObjecttypeResponse: type: "object" properties: Objecttype: "$ref": "#/components/schemas/dtoObjecttypes" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SetOperationPluginConfiguration: type: "object" properties: OperationPluginConfiguration: "$ref": "#/components/schemas/dtoOperationpluginconfiguration" ConfigurationPropertyList: type: "array" items: "$ref": "#/components/schemas/OperationPluginConfigurationValue" SessionGuid: type: "string" format: "uuid" Admin_SetOperationPluginConfigurationResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SetRegisteredSystem: type: "object" properties: RegisteredSystem: "$ref": "#/components/schemas/dtoRegisteredsystems" AdministratorGroupName: type: "string" AdministratorUserName: type: "string" RetrieveGuidForTemplateUpload: type: "boolean" CreateAccessRules: type: "boolean" SessionGuid: type: "string" format: "uuid" Admin_SetRegisteredSystemResponse: type: "object" properties: RegisteredSystem: "$ref": "#/components/schemas/dtoRegisteredsystems" AdminGroup: "$ref": "#/components/schemas/dtoObjects" AdminUser: "$ref": "#/components/schemas/dtoObjects" UploadGuid: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SetSystemCustomization: type: "object" properties: ServerCustomization: "$ref": "#/components/schemas/dtoServerCustomization" SystemReferenceId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_SetSystemCustomizationResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SetTwoFactorAuthenticationPluginConfiguration: type: "object" properties: TwoFactorAuthenticationPluginConfiguration: "$ref": "#/components/schemas/dtoTwofactorauthenticationpluginconfiguration" ConfigurationPropertyList: type: "array" items: "$ref": "#/components/schemas/TwoFactorAuthenticationPluginConfigurationValue" SessionGuid: type: "string" format: "uuid" Admin_SetTwoFactorAuthenticationPluginConfigurationResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SetUpdateabspath: type: "object" properties: SessionGuid: type: "string" format: "uuid" Admin_SetUpdateabspathResponse: type: "object" properties: ObjectCount: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Admin_SyncAuthenticationUsermanagementUser: type: "object" properties: AuthenticationConfigurationId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Admin_SyncAuthenticationUsermanagementUserResponse: type: "object" properties: SyncStartedCount: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" AuthenticationInformation: type: "object" properties: Values: type: "array" items: "$ref": "#/components/schemas/AuthenticationInformationValue" SessionType: type: "integer" format: "int32" UiCulture: type: "string" SessionGuid: type: "string" format: "uuid" LogoutExistingSession: type: "boolean" CallingIpAddress: type: "string" AuthenticationInformationValue: type: "object" properties: Masked: type: "boolean" IsReactivationToken: type: "boolean" IsReactivationTokenIndicator: type: "boolean" AuthenticationModuleConfigurationFilter: type: "object" properties: Values: type: "array" items: "$ref": "#/components/schemas/AuthenticationInformationValue" AuthenticationModuleClassName: type: "string" AuthenticationModuleConfigurationValue: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." AutoProfilerConfiguration: type: "object" properties: Activated: type: "boolean" ConfigurationFileDescription: type: "string" ConfigurationFileVersion: type: "string" LastEditedAt: type: "string" format: "date-time" LastEditedBy: type: "string" Editable: type: "boolean" PartnerId: type: "integer" format: "int32" RequiredProductLicense: type: "string" AutoProfilerVersion: type: "string" UserName: type: "string" UserPassword: type: "string" SystemReference: type: "integer" format: "int32" IsNtlmUserAccount: type: "boolean" ConfigurationValues: type: "array" items: "$ref": "#/components/schemas/AutoProfilerConfigurationValue" AutoProfilers: type: "array" items: "$ref": "#/components/schemas/AutoProfilerSettings" Runtime_CycleCount: type: "integer" format: "int32" Runtime_LoadedFromFile: type: "string" Runtime_IsInConfiguratorTestMode: type: "boolean" AutoProfilerConfigurationValue: type: "object" properties: CfgKey: type: "string" CfgValue: type: "string" CfgDescription: type: "string" AutoProfilerDataLookupType: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." AutoProfilerScriptType: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." AutoProfilerSettings: type: "object" properties: Name: type: "string" Description: type: "string" Enabled: type: "boolean" SourceFolder: type: "string" TargetFolder: type: "string" LogFolder: type: "string" ErrorBackupFolder: type: "string" FieldPattern: type: "string" FilePattern: type: "string" NewDocIndicator: type: "string" SplitAllPages: type: "boolean" StartNewDocWhenSameFieldValueAppears: type: "boolean" ProfilerMode: "$ref": "#/components/schemas/ProfilerOperationMode" DocContentParser: "$ref": "#/components/schemas/DocContentParsers" DocContentParserSettings: "$ref": "#/components/schemas/IDocContentParserSettings" Recursive: type: "boolean" MinAgeOfFile: type: "integer" format: "int32" KeepErrorBackupLocal: type: "boolean" TargetFilename: type: "string" Simulation: type: "boolean" AllowEmptyFiles: type: "boolean" IgnoreDocReferences: type: "boolean" RetryFailedUploads: type: "boolean" Templates: type: "array" items: "$ref": "#/components/schemas/ImportTemplateSettings" DataLookups: type: "array" items: "$ref": "#/components/schemas/DataLookupSettings" Scripts: type: "array" items: "$ref": "#/components/schemas/ScriptSettings" Runtime_IterationWithLastSuccessfulValidation: type: "integer" format: "int32" IsCurrentlyEdited: type: "boolean" BackgroundTaskStatusInfo: type: "object" properties: BackgroundTaskName: type: "string" LastRuntime: type: "string" format: "date-time" BackupManagerOperationState: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." BarcodeParserSettings: type: "object" properties: ScanInterval: type: "integer" format: "int32" ExpectedBarcodes: type: "integer" format: "int32" AutomaticRecognition: type: "boolean" RenderPdfPages: type: "boolean" ConvertToPdf: type: "boolean" BarcodeParserList: type: "array" items: "$ref": "#/components/schemas/SingleBarcodeParserSettings" ConvertToBitonal: type: "boolean" AppendMultipleMatchedBarcodes: type: "boolean" SkipBlankPages: type: "boolean" SkipPagesWithoutMatchingBarcodes: type: "boolean" GatherTestResults: type: "boolean" MarkDocAsPdfA: type: "boolean" nullable: true RenderPdfAndImport: type: "boolean" nullable: true BarcodeType: type: "integer" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen numerisch (vermutlich Enumeration)." BatchDeletionAdmin_GetDeleteList: type: "object" properties: ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSort" PageNumber: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" BatchDeletionAdmin_GetDeleteListResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" BatchDeletionAdmin_RunBatchDelete: type: "object" properties: SkipFilesystemErrors: type: "boolean" SessionGuid: type: "string" format: "uuid" BatchDeletionAdmin_RunBatchDeleteResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" BatchObjectChangeOperation: type: "object" properties: SourceObjectTypeId: type: "integer" format: "int32" DestinationObjectTypeId: type: "integer" format: "int32" ObjectTypeDefinitionChangeOperations: type: "array" items: "$ref": "#/components/schemas/BatchObjectTypeDefinitionChangeOperation" SourceSystemReferenceId: type: "integer" format: "int32" DestinationSystemReferenceId: type: "integer" format: "int32" OnlyProcessSubElementsOf: type: "integer" format: "int32" BatchObjectTypeDefinitionChangeOperation: type: "object" properties: SourceObjectTypeDefinitionId: type: "integer" format: "int32" DestinationObjectTypeDefinitionId: type: "integer" format: "int32" ChangePassword: type: "object" properties: SystemReferenceId: type: "integer" format: "int32" UserName: type: "string" OldUserPassword: type: "string" NewUserPassword: type: "string" SessionType: type: "integer" format: "int32" AuthenticationModuleConfigurationId: type: "integer" format: "int32" AuthenticationInformation: type: "array" items: "$ref": "#/components/schemas/AuthenticationInformationValue" UiCulture: type: "string" DownloadDocumentIdentifier: type: "string" ChangePasswordResponse: type: "object" properties: Usersession: "$ref": "#/components/schemas/dtoUsersessions" DownloadDocumentIdentifier: type: "string" DownloadDocumentToken: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ChangeType: type: "object" properties: ObjectPropertyList: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" TypeChangeComment: type: "string" SessionGuid: type: "string" format: "uuid" ChangeTypeResponse: type: "object" properties: ObjectsElement: "$ref": "#/components/schemas/dtoObjectsBase" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Chat: type: "object" properties: ChatMessage: type: "string" ChatRecipientUser: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" ChatResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" CloudServiceGatewayPluginConfigurationValue: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." CommentTask: type: "object" properties: Taskid: type: "integer" format: "int32" Taskcomment: type: "string" SessionGuid: type: "string" format: "uuid" CommentTaskResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" CompleteTask: type: "object" properties: Taskid: type: "integer" format: "int32" TaskProperties: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" SessionGuid: type: "string" format: "uuid" CompleteTaskResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" DashboardNewsItem: type: "object" properties: Title: type: "string" Content: type: "string" DatePublished: type: "string" format: "date-time" ImageBase64: type: "string" SourceLink: type: "string" DatabaseEngine: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." DatabaseManagerOperationState: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." DataLookupSettings: type: "object" properties: Name: type: "string" Description: type: "string" Enabled: type: "boolean" Condition: type: "string" ConnectionString: type: "string" DataFetchStatement: type: "string" DataUpdateStatement: type: "string" LogWarningForNoResults: type: "boolean" DataLookupType: "$ref": "#/components/schemas/AutoProfilerDataLookupType" DeleteAcls: type: "object" properties: SecurityIdList: type: "array" items: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" DeleteAclsResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" DeleteDownloads: type: "object" properties: DownloadIds: type: "array" items: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" DeleteDownloadsResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" DeleteNote: type: "object" properties: NoteId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" DeleteNoteResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" DeleteObjectRelations: type: "object" properties: SourceObjectId: type: "integer" format: "int32" RelatedObjectIds: type: "array" items: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" DeleteObjectRelationsResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" DeleteSavedQueries: type: "object" properties: UsersAndQueriesIds: type: "array" items: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" DeleteSavedQueriesResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" DeleteStamp: type: "object" properties: StampId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" DeleteStampResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" DocContentParsers: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." DownloadDoc: type: "object" properties: DownloadDocIdentifier: type: "string" description: "Identifier for external download (guid or named)" DownloadDocToken: type: "string" description: "Onetime token for verifying external download (guid or named)" DownloadDocResponse: type: "object" properties: Options: type: "object" additionalProperties: type: "string" dtoAclsecurity: type: "object" properties: Securityid: type: "integer" format: "int32" Secobject: type: "integer" format: "int32" Secuser: type: "integer" format: "int32" Secrule: type: "integer" format: "int32" Sectype: type: "integer" format: "int32" Secright: type: "integer" format: "int32" Validfrom: type: "string" format: "date-time" Validto: type: "string" format: "date-time" Datecreated: type: "string" format: "date-time" Usercreated: type: "integer" format: "int32" Createdusername: type: "string" Dateedited: type: "string" format: "date-time" nullable: true Useredited: type: "integer" format: "int32" nullable: true Editedusername: type: "string" SecuserObject: "$ref": "#/components/schemas/dtoObjectsBase" SecruleObject: "$ref": "#/components/schemas/dtoConstr" dtoAuthenticationmoduleconfiguration: type: "object" properties: Configurationid: type: "integer" format: "int32" Systemreference: type: "integer" format: "int32" Systemalias: type: "string" Systemname: type: "string" Authenticationmoduleclass: type: "string" Authenticationmodulename: type: "string" Authenticationmoduledescription: type: "string" Configuration: type: "string" Isactive: type: "integer" format: "int32" Position: type: "integer" format: "int32" ShowInLoginScreen: type: "boolean" CanChangePassword: type: "boolean" Allowednetworks: type: "string" Blockednetworks: type: "string" dtoAuthenticationmoduleplugin: type: "object" properties: AuthenticationModuleClass: type: "string" AuthenticationModuleName: type: "string" AuthenticationModuleDescription: type: "string" dtoBatchimportlog: type: "object" properties: Batchimportlogid: type: "integer" format: "int32" Batchimportsession: type: "integer" format: "int32" Eventdate: type: "string" format: "date-time" Level: type: "string" Action: type: "string" Message: type: "string" Exception: type: "string" Originalfilename: type: "string" Objectid: type: "integer" format: "int32" nullable: true dtoBatchimports: type: "object" properties: Batchimportid: type: "integer" format: "int32" Batchimportguid: type: "string" format: "uuid" Systemreference: type: "integer" format: "int32" Name: type: "string" Tagname: type: "string" Datecreated: type: "string" format: "date-time" Owner: type: "integer" format: "int32" Ownername: type: "string" Status: type: "integer" format: "int32" Comment: type: "string" Usercommented: type: "integer" format: "int32" nullable: true Commentedusername: type: "string" Datecommented: type: "string" format: "date-time" nullable: true Userresolved: type: "integer" format: "int32" nullable: true Resolvedusername: type: "string" Dateresolved: type: "string" format: "date-time" nullable: true dtoBatchimportsessions: type: "object" properties: Batchimportsessionid: type: "integer" format: "int32" Batchimport: type: "integer" format: "int32" Startedbyuser: type: "integer" format: "int32" Startedbyusername: type: "string" Datestarted: type: "string" format: "date-time" Datefinished: type: "string" format: "date-time" nullable: true Operationmode: type: "string" Errorcount: type: "integer" format: "int32" Errorset: type: "string" Percentfinished: type: "integer" format: "int32" Warncount: type: "integer" format: "int32" dtoBatchimportusers: type: "object" properties: Batchimportuserid: type: "integer" format: "int32" Systemreference: type: "integer" format: "int32" Username: type: "string" NewPassword: type: "string" Allowlogin: type: "boolean" Batchimportuseremail: type: "string" Batchimportusertype: type: "integer" format: "int32" Allowednetworks: type: "string" Blockednetworks: type: "string" dtoCloudservicegatewayplugin: type: "object" properties: CloudServiceGatewayPluginClass: type: "string" CloudServiceGatewayPluginName: type: "string" CloudServiceGatewayPluginDescription: type: "string" dtoCloudservicegatewaypluginconfiguration: type: "object" properties: Configurationid: type: "integer" format: "int32" Systemreference: type: "integer" format: "int32" Systemalias: type: "string" Systemname: type: "string" Cloudservicegatewaypluginclass: type: "string" Cloudservicegatewaypluginname: type: "string" Cloudservicegatewayplugindescription: type: "string" Configuration: type: "string" Isactive: type: "integer" format: "int32" Position: type: "integer" format: "int32" Displayname: type: "string" dtoConfiguration: type: "object" properties: Application: type: "string" Section: type: "string" Key: type: "string" Value: type: "string" Description: type: "string" dtoConstr: type: "object" properties: Constrid: type: "integer" format: "int32" Constraintname: type: "string" Objecttype: type: "integer" format: "int32" Constrainttype: type: "string" Systemreference: type: "integer" format: "int32" Constritems: type: "array" items: "$ref": "#/components/schemas/dtoConstritems" Extendedconstr: "$ref": "#/components/schemas/dvExtendedRuleElement" Constrstatus: type: "integer" format: "int32" IsHierarchic: type: "boolean" dtoConstritems: type: "object" properties: Constraintitemid: type: "integer" format: "int32" Constr: type: "integer" format: "int32" Position: type: "integer" format: "int32" Andor: type: "integer" format: "int32" Field: type: "integer" format: "int32" Operator: type: "string" Value: type: "string" dtoDatabaseinformation: type: "object" properties: Databaseexists: type: "boolean" Isdocuvitadatabase: type: "boolean" Isemptydatabase: type: "boolean" Cancreatedatabase: type: "boolean" Version: "$ref": "#/components/schemas/dtoProductversion" Engine: "$ref": "#/components/schemas/DatabaseEngine" Name: type: "string" Connectionstring: type: "string" Administrationconnectionstring: type: "string" UpdateOrCreatePossible: type: "boolean" IndexDirectory: type: "string" dtoDownloadoperations: type: "object" properties: Downloadoperationid: type: "integer" format: "int32" Downloadrecipient: type: "integer" format: "int32" Datedownloaded: type: "string" format: "date-time" Agent: type: "string" Ip: type: "string" Downloadoperationstatus: type: "integer" format: "int32" dtoDownloadrecipients: type: "object" properties: Downloadrecipientid: type: "integer" format: "int32" Download: type: "integer" format: "int32" Recipientuser: type: "integer" format: "int32" Url: type: "string" Recipientuserstatus: type: "integer" format: "int32" Downloadquantity: type: "integer" format: "int32" dtoDownloads: type: "object" properties: Downloadid: type: "integer" format: "int32" Object: type: "integer" format: "int32" Version: type: "integer" format: "int32" Datecreated: type: "string" format: "date-time" Usercreated: type: "integer" format: "int32" Createdusername: type: "string" Dltype: type: "integer" format: "int32" Name: type: "string" Description: type: "string" Mailsubject: type: "string" Mailbody: type: "string" Validuntil: type: "string" format: "date-time" Alloweddlqty: type: "integer" format: "int32" Downloadstatus: type: "integer" format: "int32" DownloadRecipients: type: "array" items: "$ref": "#/components/schemas/dtoDownloadrecipients" dtoExtendedattributes: type: "object" properties: Object: type: "integer" format: "int32" Objecttypedefinition: type: "integer" format: "int32" dtoExtendedboolattributes: type: "object" properties: Object: type: "integer" format: "int32" Objecttypedefinition: type: "integer" format: "int32" Value: type: "boolean" nullable: true dtoExtendedcurrencyattributes: type: "object" properties: Object: type: "integer" format: "int32" Objecttypedefinition: type: "integer" format: "int32" Value: type: "number" format: "double" nullable: true dtoExtendeddatetimeattributes: type: "object" properties: Object: type: "integer" format: "int32" Objecttypedefinition: type: "integer" format: "int32" Value: type: "string" format: "date-time" nullable: true dtoExtendednumericattributes: type: "object" properties: Object: type: "integer" format: "int32" Objecttypedefinition: type: "integer" format: "int32" Value: type: "integer" format: "int32" nullable: true dtoExtendedstringattributes: type: "object" properties: Object: type: "integer" format: "int32" Objecttypedefinition: type: "integer" format: "int32" Value: type: "string" dtoExtendedtextattributes: type: "object" properties: Object: type: "integer" format: "int32" Objecttypedefinition: type: "integer" format: "int32" Value: type: "string" dtoFieldtypes: type: "object" properties: Fieldtypeid: type: "integer" format: "int32" Name: type: "string" Table: type: "string" dtoGroupsandrules: type: "object" properties: Group: type: "integer" format: "int32" Rule: type: "integer" format: "int32" Objecttype: type: "integer" format: "int32" Right: type: "integer" format: "int32" dtoImageresources: type: "object" properties: Imageresourceid: type: "integer" format: "int32" Imagetype: type: "integer" format: "int32" Mimetype: type: "string" Name: type: "string" Description: type: "string" Imgsmall: type: "string" format: "byte" Imgsmallselected: type: "string" format: "byte" Imgmedium: type: "string" format: "byte" Imglarge: type: "string" format: "byte" Imgxlarge: type: "string" format: "byte" dtoLogging: type: "object" properties: Loggingid: type: "integer" format: "int32" Loggingevent: type: "integer" format: "int32" Object: type: "integer" format: "int32" nullable: true Actinguser: type: "integer" format: "int32" Actingusername: type: "string" Version: type: "integer" format: "int32" nullable: true Eventraisedtimestamp: type: "string" format: "date-time" Eventcomment: type: "string" MetadataAvailable: type: "boolean" dtoLookupplugin: type: "object" properties: LookupPluginClass: type: "string" LookupPluginName: type: "string" LookupPluginDescription: type: "string" dtoLookuppluginconfiguration: type: "object" properties: Configurationid: type: "integer" format: "int32" Systemreference: type: "integer" format: "int32" Systemalias: type: "string" Systemname: type: "string" Lookuppluginclass: type: "string" Lookuppluginname: type: "string" Lookupplugindescription: type: "string" Configuration: type: "string" Isactive: type: "integer" format: "int32" Position: type: "integer" format: "int32" Displayname: type: "string" dtoMaintenanceusersession: type: "object" properties: SessionGuid: type: "string" format: "uuid" UiCulture: type: "string" StartedAt: type: "string" format: "date-time" LastAccessAt: type: "string" format: "date-time" dtoNotes: type: "object" properties: Noteid: type: "integer" format: "int32" Object: type: "integer" format: "int32" Notetext: type: "string" Importance: type: "integer" format: "int32" nullable: true Datecreated: type: "string" format: "date-time" Dateedited: type: "string" format: "date-time" nullable: true Usercreated: type: "integer" format: "int32" Createdusername: type: "string" Useredited: type: "integer" format: "int32" nullable: true Editedusername: type: "string" Notestate: type: "integer" format: "int32" dtoObjects: type: "object" properties: Parentobject: type: "integer" format: "int32" Objecttype: type: "integer" format: "int32" IsLink: type: "boolean" Fulltext: type: "string" Objectid: type: "integer" format: "int32" Name: type: "string" Description: type: "string" Datecreated: type: "string" format: "date-time" Dateedited: type: "string" format: "date-time" nullable: true Documentdate: type: "string" format: "date-time" nullable: true Usercreated: type: "integer" format: "int32" Useredited: type: "integer" format: "int32" nullable: true Deleteflag: type: "integer" format: "int32" Status: type: "integer" format: "int32" Checkoutuser: type: "integer" format: "int32" nullable: true Checkoutlocation: type: "string" Abspath: type: "string" Otpath: type: "string" Fileextension: type: "string" Versioncount: type: "integer" format: "int32" nullable: true Createdusername: type: "string" Editedusername: type: "string" Notecount: type: "integer" format: "int32" nullable: true Systemreference: type: "integer" format: "int32" Barcode: type: "string" Documenttype: type: "string" Voucherdate: type: "string" format: "date-time" nullable: true Vouchertype: type: "string" Vouchernumber: type: "string" Externalvouchernumber: type: "string" Transactionkey: type: "string" Transactiontype: type: "string" Validfrom: type: "string" format: "date-time" nullable: true Validuntil: type: "string" format: "date-time" nullable: true Deleteflagsetby: type: "integer" format: "int32" Deleteflagsetdate: type: "string" format: "date-time" nullable: true Hiddenflagsetdate: type: "string" format: "date-time" nullable: true Deletereason: type: "integer" format: "int32" nullable: true Approvalstatuscode: type: "integer" format: "int32" Approvedby: type: "integer" format: "int32" Approvedversion: type: "integer" format: "int32" Latestversion: type: "integer" format: "int32" Filesize: type: "integer" format: "int32" Filehash: type: "string" Extmetadata: type: "string" Mailfrom: type: "string" Mailto: type: "string" Mailcc: type: "string" Mailbcc: type: "string" Mailsubject: type: "string" Mailmessageid: type: "string" Mailsenddate: type: "string" format: "date-time" nullable: true Mailparentmailid: type: "integer" format: "int32" Activeworkflowcount: type: "integer" format: "int32" Relatedobjectscount: type: "integer" format: "int32" nullable: true Deletereasontext: type: "string" Updateabspath: type: "integer" format: "int32" Lvl: type: "integer" format: "int32" AccessRight: type: "integer" format: "int32" ExBA: type: "object" additionalProperties: "$ref": "#/components/schemas/dtoExtendedboolattributes" ExCA: type: "object" additionalProperties: "$ref": "#/components/schemas/dtoExtendedcurrencyattributes" ExDA: type: "object" additionalProperties: "$ref": "#/components/schemas/dtoExtendeddatetimeattributes" ExNA: type: "object" additionalProperties: "$ref": "#/components/schemas/dtoExtendednumericattributes" ExSA: type: "object" additionalProperties: "$ref": "#/components/schemas/dtoExtendedstringattributes" ExTA: type: "object" additionalProperties: "$ref": "#/components/schemas/dtoExtendedtextattributes" dtoObjectsBase: type: "object" properties: Parentobject: type: "integer" format: "int32" Objecttype: type: "integer" format: "int32" IsLink: type: "boolean" Fulltext: type: "string" Objectid: type: "integer" format: "int32" Name: type: "string" Description: type: "string" Datecreated: type: "string" format: "date-time" Dateedited: type: "string" format: "date-time" nullable: true Documentdate: type: "string" format: "date-time" nullable: true Usercreated: type: "integer" format: "int32" Useredited: type: "integer" format: "int32" nullable: true Deleteflag: type: "integer" format: "int32" Status: type: "integer" format: "int32" nullable: true Checkoutuser: type: "integer" format: "int32" nullable: true Checkoutlocation: type: "string" Abspath: type: "string" Otpath: type: "string" Fileextension: type: "string" Versioncount: type: "integer" format: "int32" nullable: true Createdusername: type: "string" Editedusername: type: "string" Notecount: type: "integer" format: "int32" nullable: true Systemreference: type: "integer" format: "int32" Barcode: type: "string" Documenttype: type: "string" Voucherdate: type: "string" format: "date-time" nullable: true Vouchertype: type: "string" Vouchernumber: type: "string" Externalvouchernumber: type: "string" Transactionkey: type: "string" Transactiontype: type: "string" Validfrom: type: "string" format: "date-time" nullable: true Validuntil: type: "string" format: "date-time" nullable: true Deleteflagsetby: type: "integer" format: "int32" Deleteflagsetdate: type: "string" format: "date-time" nullable: true Hiddenflagsetdate: type: "string" format: "date-time" nullable: true Deletereason: type: "integer" format: "int32" nullable: true Approvalstatuscode: type: "integer" format: "int32" Approvedby: type: "integer" format: "int32" Approvedversion: type: "integer" format: "int32" Latestversion: type: "integer" format: "int32" Filesize: type: "integer" format: "int32" Filehash: type: "string" Extmetadata: type: "string" Mailfrom: type: "string" Mailto: type: "string" Mailcc: type: "string" Mailbcc: type: "string" Mailsubject: type: "string" Mailmessageid: type: "string" Mailsenddate: type: "string" format: "date-time" nullable: true Mailparentmailid: type: "integer" format: "int32" Activeworkflowcount: type: "integer" format: "int32" Relatedobjectscount: type: "integer" format: "int32" nullable: true Deletereasontext: type: "string" Updateabspath: type: "integer" format: "int32" Lvl: type: "integer" format: "int32" AccessRight: type: "integer" format: "int32" dtoObjecttypedefinition: type: "object" properties: Objecttypedefinitionid: type: "integer" format: "int32" Objecttype: type: "integer" format: "int32" Fieldtype: type: "integer" format: "int32" Fieldname: type: "string" Prompt: type: "string" Description: type: "string" Category: type: "string" Required: type: "boolean" nullable: true Valuelookup: type: "boolean" nullable: true Predefinedvalues: type: "string" System: type: "boolean" nullable: true Public: type: "boolean" nullable: true Position: type: "integer" format: "int32" nullable: true Defaultvalue: type: "string" Lockstate: type: "integer" format: "int32" Fieldhidden: type: "integer" format: "int32" Fieldformat: type: "string" Autocalc: type: "integer" format: "int32" Autocalcexpression: type: "string" Multiline: type: "integer" format: "int32" Fieldlookuptype: type: "integer" format: "int32" nullable: true Fieldlookupfilter: type: "string" Fieldlookuppluginname: type: "string" Fieldlookupvaluemapping: type: "string" Fieldlookuppluginlistener: type: "string" Fieldlookuppluginfilter: type: "string" Customfunctions: type: "string" Customrenderer: type: "string" dtoObjecttypes: type: "object" properties: Objecttypeid: type: "integer" format: "int32" Name: type: "string" Displayname: type: "string" Internalname: type: "string" Description: type: "string" Icon: type: "string" format: "byte" Iconselected: type: "string" format: "byte" Allowedparenttypes: type: "string" Typeidentifier: type: "string" View: type: "integer" format: "int32" nullable: true Defaultparent: type: "integer" format: "int32" nullable: true Fulltextindexed: type: "boolean" nullable: true Predefineddescription: type: "string" Defaultdescription: type: "string" Descriptionlookup: type: "boolean" nullable: true Xmltemplate: type: "string" Typehidden: type: "integer" format: "int32" Retentionclass: type: "string" Preimportscriptfile: type: "string" Preimportscriptcode: type: "string" Postimportscriptfile: type: "string" Postimportscriptcode: type: "string" Mediumicon: type: "string" format: "byte" Largeicon: type: "string" format: "byte" Updatekeyfields: type: "string" Updateloctype: type: "integer" format: "int32" nullable: true Versionincrementstyle: type: "integer" format: "int32" Submaintenanceonobjectchange: type: "integer" format: "int32" dtoOperationplugin: type: "object" properties: OperationPluginClass: type: "string" OperationPluginName: type: "string" OperationPluginDescription: type: "string" dtoOperationpluginconfiguration: type: "object" properties: Configurationid: type: "integer" format: "int32" Systemreference: type: "integer" format: "int32" Systemalias: type: "string" Systemname: type: "string" Operationpluginclass: type: "string" Operationpluginname: type: "string" Operationplugindescription: type: "string" Configuration: type: "string" Isactive: type: "integer" format: "int32" Position: type: "integer" format: "int32" Displayname: type: "string" dtoProductversion: type: "object" properties: Major: type: "integer" format: "int32" Minor: type: "integer" format: "int32" Build: type: "integer" format: "int32" Revision: type: "integer" format: "int32" dtoRegisteredsystems: type: "object" properties: Systemreferenceid: type: "integer" format: "int32" Systemname: type: "string" Systemguid: type: "string" IsRemote: type: "integer" format: "int32" Remotehost: type: "string" Remoteport: type: "integer" format: "int32" Systemstatus: type: "integer" format: "int32" Admingroup: type: "integer" format: "int32" Filestoreaddress: type: "string" Importstoreaddress: type: "string" Importgroup: type: "integer" format: "int32" Systemalias: type: "string" Deleteadmingroup: type: "integer" format: "int32" Deletemode: type: "integer" format: "int32" Workflowadmingroup: type: "integer" format: "int32" Mailconfiguration: type: "string" Defaultpassword: type: "string" Mailnewuserpassword: type: "integer" format: "int32" Defaultculture: type: "string" Signatureconfig: type: "string" Crypttype: type: "integer" format: "int32" Constraintsadmingroup: type: "integer" format: "int32" Rightsadmingroup: type: "integer" format: "int32" Workflowrolesadmingroup: type: "integer" format: "int32" Externalusergroup: type: "integer" format: "int32" Systemurl: type: "string" Objectlogdbaddress: type: "string" Importlogdbaddress: type: "string" Primarycolor: type: "string" Secondarycolor: type: "string" Logosmall: type: "string" format: "byte" Logomedium: type: "string" format: "byte" Logolarge: type: "string" format: "byte" Logoxlarge: type: "string" format: "byte" dtoRegisteredsystemsInformation: type: "object" properties: DocumentCount: type: "integer" format: "int32" ObjectCount: type: "integer" format: "int32" DocumentSpace: type: "string" ImportSpace: type: "string" dtoSccollections: type: "object" properties: Sccollectionid: type: "integer" format: "int32" Systemreference: type: "integer" format: "int32" Coltype: type: "integer" format: "int32" Colstatus: type: "integer" format: "int32" Name: type: "string" Datecreated: type: "string" format: "date-time" Usercreated: type: "integer" format: "int32" Createdusername: type: "string" Dateedited: type: "string" format: "date-time" nullable: true Useredited: type: "integer" format: "int32" Editedusername: type: "string" Users: type: "array" items: "$ref": "#/components/schemas/dtoSckeys" dtoSckeys: type: "object" properties: Sccollection: type: "integer" format: "int32" Scuser: type: "integer" format: "int32" Membertype: "$ref": "#/components/schemas/dvSecuredContentCollectionMemberType" dtoServerCustomization: type: "object" properties: ProductName: type: "string" ProductVersion: type: "string" ObjecttypeList: type: "array" items: "$ref": "#/components/schemas/dtoObjecttypes" ObjecttypedefinitionList: type: "array" items: "$ref": "#/components/schemas/dtoObjecttypedefinition" AccessRules: type: "array" items: "$ref": "#/components/schemas/dtoConstr" AccessRuleAssignments: type: "array" items: "$ref": "#/components/schemas/dtoGroupsandrules" ReferencedUsersList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" ExtendedRules: type: "array" items: "$ref": "#/components/schemas/dvExtendedRule" ExtendedRulesAssignments: type: "array" items: "$ref": "#/components/schemas/dtoGroupsandrules" BatchimportUsers: type: "array" items: "$ref": "#/components/schemas/dtoBatchimportusers" RegisteredSystems: type: "array" items: "$ref": "#/components/schemas/dtoRegisteredsystems" UsersAndGroups: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" Users: type: "array" items: "$ref": "#/components/schemas/dtoObjects" Groups: type: "array" items: "$ref": "#/components/schemas/dtoObjects" LookuppluginsList: type: "array" items: "$ref": "#/components/schemas/dtoLookuppluginconfiguration" AuthenticationmodulesList: type: "array" items: "$ref": "#/components/schemas/dtoAuthenticationmoduleconfiguration" TwoFactorAuthenticationList: type: "array" items: "$ref": "#/components/schemas/dtoTwofactorauthenticationpluginconfiguration" CloudServiceGateway: type: "array" items: "$ref": "#/components/schemas/dtoCloudservicegatewaypluginconfiguration" WorkflowModel: type: "array" items: "$ref": "#/components/schemas/dtoServerCustomizationWorkflows" WorkflowModelRegistrations: type: "array" items: "$ref": "#/components/schemas/dtoWorkflowmodelregistration" WorkflowRole: type: "array" items: "$ref": "#/components/schemas/WorkflowRoleAssignment" StructureXMLTemplate: type: "string" ServerSettings: type: "array" items: "$ref": "#/components/schemas/dtoServersettings" dtoServerCustomizationWorkflows: type: "object" properties: WorkflowModel: "$ref": "#/components/schemas/dtoWorkflowmodel" WorkflowTemplate: "$ref": "#/components/schemas/WorkflowTemplate" dtoServersettings: type: "object" properties: Settingkey: type: "string" Settingtext: type: "string" dtoServiceextensionuploadroute: type: "object" properties: ServiceExtensionName: type: "string" UploadRoute: type: "string" CommandText: type: "string" CommandTitle: type: "string" CommandDescription: type: "string" ScanFileTypes: type: "integer" format: "int32" BarcodeSettings: "$ref": "#/components/schemas/BarcodeParserSettings" BarcodeObjecttype: type: "integer" format: "int32" BarcodeObjecttypeDefintion: type: "integer" format: "int32" BarcodeDisplayPathSelector: type: "string" BarcodeFieldName: type: "string" dtoStamps: type: "object" properties: Stampid: type: "integer" format: "int32" Name: type: "string" Template: type: "string" Thumbnail: type: "string" Systemreference: type: "integer" format: "int32" Isactive: type: "integer" format: "int32" Position: type: "integer" format: "int32" dtoTask: type: "object" properties: Taskid: type: "integer" format: "int32" Workflow: type: "integer" format: "int32" Tasktemplate: type: "string" Tasktemplatetype: type: "integer" format: "int32" Taskformtype: type: "integer" format: "int32" Taskformdefinition: type: "string" Tasksystemstate: type: "integer" format: "int32" Taskcomment: type: "string" Taskdisplayname: type: "string" Taskdescription: type: "string" Datecreated: type: "string" format: "date-time" Datelastactivity: type: "string" format: "date-time" Userlastactivity: type: "integer" format: "int32" Lastactivityusername: type: "string" Taskresult: type: "string" Taskdisplayoptions: type: "integer" format: "int32" Lastactivityuseremail: type: "string" Taskformhtml: type: "string" Datestarted: type: "string" format: "date-time" Duedate: type: "string" format: "date-time" nullable: true Reminddate: type: "string" format: "date-time" nullable: true Timeoutdate: type: "string" format: "date-time" nullable: true Datesentreminder: type: "string" format: "date-time" nullable: true Datecompleted: type: "string" format: "date-time" nullable: true Workflow_Workflowname: type: "string" Workflow_Workflowdisplayname: type: "string" Workflow_Workflowdescription: type: "string" Workflow_Workflowmodelid: type: "integer" format: "int32" Workflow_Workflowmodeltype: type: "integer" format: "int32" Workflow_Workflowmodelguid: type: "string" format: "uuid" Workflow_Firstobjectid: type: "integer" format: "int32" Workflow_Firstobjecttypeid: type: "integer" format: "int32" Workflow_Firstobjectelement: "$ref": "#/components/schemas/dtoObjectsBase" Workflow_Datecreated: type: "string" format: "date-time" Workflow_Usercreated: type: "integer" format: "int32" Workflow_Createdusername: type: "string" Workflow_Datelastactivity: type: "string" format: "date-time" Workflow_Userlastactivity: type: "integer" format: "int32" Workflow_Lastactivityusername: type: "string" dtoTwofactorauthenticationplugin: type: "object" properties: TwoFactorAuthenticationPluginClass: type: "string" TwoFactorAuthenticationPluginName: type: "string" TwoFactorAuthenticationPluginDescription: type: "string" dtoTwofactorauthenticationpluginconfiguration: type: "object" properties: Configurationid: type: "integer" format: "int32" Systemreference: type: "integer" format: "int32" Systemalias: type: "string" Systemname: type: "string" Twofactorauthenticationpluginclass: type: "string" Twofactorauthenticationpluginname: type: "string" Twofactorauthenticationplugindescription: type: "string" Configuration: type: "string" Isactive: type: "integer" format: "int32" Position: type: "integer" format: "int32" Displayname: type: "string" dtoUsersandqueries: type: "object" properties: Usersandqueriesid: type: "integer" format: "int32" Userid: type: "integer" format: "int32" Queryid: type: "integer" format: "int32" nullable: true Querytype: type: "string" Querydescription: type: "string" Simplequerytext: type: "string" dtoUsersessions: type: "object" properties: Sessionid: type: "integer" format: "int32" Systemreference: type: "integer" format: "int32" Sessionguid: type: "string" Sessiontype: type: "integer" format: "int32" UiCulture: type: "string" User: type: "integer" format: "int32" Userloginname: type: "string" Useremail: type: "string" Usergroup: type: "integer" format: "int32" Usergroupname: type: "string" Sessionstarted: type: "string" format: "date-time" Lastactivity: type: "string" format: "date-time" Hostip: type: "string" IsAdmin: type: "integer" format: "int32" IsImportAdmin: type: "integer" format: "int32" IsBatchDeletionAdmin: type: "integer" format: "int32" IsWorkflowAdmin: type: "integer" format: "int32" ReactivationToken: type: "string" DisconnectionInterval: type: "integer" format: "int32" Workflowuserstatus: type: "integer" format: "int32" AuthenticationModuleConfigurationId: type: "integer" format: "int32" IsRightsAdmin: type: "integer" format: "int32" IsConstraintsAdmin: type: "integer" format: "int32" IsWorkflowRolesAdmin: type: "integer" format: "int32" IsWorkflowMonitor: type: "integer" format: "int32" Sessionstate: type: "integer" format: "int32" dtoUsersettings: type: "object" properties: Settingkey: type: "string" Settingtext: type: "string" dtoVersions: type: "object" properties: Versionid: type: "integer" format: "int32" Object: type: "integer" format: "int32" Versioncomment: type: "string" Fileextension: type: "string" Usercreated: type: "integer" format: "int32" Datecreated: type: "string" format: "date-time" Deleteflag: type: "integer" format: "int32" Versionstatus: type: "integer" format: "int32" Filesize: type: "integer" format: "int32" Pagecount: type: "integer" format: "int32" Extmetadata: type: "string" Filehash: type: "string" Deleteflagsetby: type: "integer" format: "int32" Deleteflagsetdate: type: "string" format: "date-time" Hiddenflagsetdate: type: "string" format: "date-time" Deletereason: type: "integer" format: "int32" nullable: true Versionhidden: type: "integer" format: "int32" nullable: true Originalfilename: type: "string" Previewfileextension: type: "string" Previewfilesize: type: "integer" format: "int32" Previewfilehash: type: "string" Needsindexing: type: "integer" format: "int32" Isccanneddoc: type: "integer" format: "int32" Versionmajor: type: "integer" format: "int32" Versionminor: type: "integer" format: "int32" Versionrevision: type: "integer" format: "int32" Versionlabel: type: "string" Versionname: type: "string" dtoWorkflow: type: "object" properties: Workflowid: type: "integer" format: "int32" Systemreference: type: "integer" format: "int32" Workflowmodel: type: "integer" format: "int32" IsRunning: type: "integer" format: "int32" Currenttask: type: "integer" format: "int32" Currenttaskdisplayname: type: "string" Currenttasktemplate: type: "string" Datecreated: type: "string" format: "date-time" Usercreated: type: "integer" format: "int32" Createdusername: type: "string" Createduseremail: type: "string" Workflowname: type: "string" Workflowdisplayname: type: "string" Workflowdescription: type: "string" Datelastactivity: type: "string" format: "date-time" Userlastactivity: type: "integer" format: "int32" Lastactivityusername: type: "string" Lastactivityuseremail: type: "string" Firstobjectid: type: "integer" format: "int32" Firstobjecttypeid: type: "integer" format: "int32" dtoWorkflowlog: type: "object" properties: Workflowlogid: type: "integer" format: "int32" description: "Unique auto-incrementing ID for this log record" Workflow: type: "integer" format: "int32" description: "Workflow instance this log entry belongs to" Logentrytype: type: "integer" format: "int32" description: "Defines the type of entry of this record. (See dvTaskLogEntryType)" Currenttask: type: "string" description: "Current task of the workflow at the time of logging" Currenttaskdisplayname: type: "string" description: "Current task of the workflow at the time of logging" Taskresult: type: "string" description: "Task result of task in Currenttask at the time of logging" Logusername: type: "string" description: "User name of acting user (or SYSTEM)" Logtimestamp: type: "string" format: "date-time" Logmessage: type: "string" description: "Actual log message" Metadata: type: "string" description: "json string with property list (for user's answer of task)" Loguserid: type: "integer" format: "int32" description: "User Id of acting user" dtoWorkflowmodel: type: "object" properties: Workflowmodelid: type: "integer" format: "int32" description: "ID of this workflow model in the database. This is the unique identifier to retrieve the workflow model inside the system." Workflowmodelguid: type: "string" format: "uuid" Systemreference: type: "integer" format: "int32" Workflowmodelversion: type: "integer" format: "int32" Enabled: type: "boolean" description: "Flag to specify if workflow model is generally enabled or not. In case it is disabled, no further workflows of this model can be started, even if registrations to user/group/role and object type are present. However disabling the workflow model does not affect workflows of this model that are currently running." Name: type: "string" Displayname: type: "string" Description: type: "string" Category: type: "string" Datecreated: type: "string" format: "date-time" description: "Date of creation of this workflow model. Mandatory property" Dateedited: type: "string" format: "date-time" nullable: true description: "Date of last manipulation of this workflow model. Optional property" Usercreated: type: "integer" format: "int32" description: "id of the user (=object id) who created the workflow model. Mandatory property" Useredited: type: "integer" format: "int32" nullable: true description: "id of the user who performed the last manipulation of the workflow model. Optional property" Createdusername: type: "string" description: "Name of the user who created the workflow model (non-normalized for display performance, see Usercreated)" Editedusername: type: "string" description: "Name of the user who performed the last manipulation of the workflow model (non-normalized for display performance, see Useredited)" Workflowmodeltype: type: "integer" format: "int32" description: "Type of workflow model. Supported values are: 0: default (user) workflow 1: system workflow (cannot be added/modified/deleted manually)" dtoWorkflowmodelregistration: type: "object" properties: Workflowmodelregistrationid: type: "integer" format: "int32" description: "Unique ID of this workflow model registration" Workflowmodel: type: "integer" format: "int32" description: "ID of the workflow model this registration is bound to" Startbyrole: type: "string" Startbyuser: type: "integer" format: "int32" Startbygroup: type: "integer" format: "int32" Objecttype: type: "integer" format: "int32" Registrationtype: "$ref": "#/components/schemas/dvWorkflowRegistrationType" dtoWorkflowvalue: type: "object" properties: Workflowvalueid: type: "integer" format: "int32" description: "Unique ID of this workflow value" Workflow: type: "integer" format: "int32" description: "Unique ID of workflow instance value entry belongs to" Itemkey: type: "string" description: "Specific key" Itemdatatype: type: "string" description: "Data type as string B,C,D,N,S" Itemvaluebool: type: "boolean" nullable: true description: "Used if data type is B" Itemvaluecurrency: type: "number" format: "double" nullable: true description: "Used if data type is C" Itemvaluedatetime: type: "string" format: "date-time" nullable: true description: "Used if data type is D" Itemvaluenumeric: type: "integer" format: "int32" nullable: true description: "Used if data type is N" Itemvaluestring: type: "string" description: "Used if data type is S" dvActionStartConditionType: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvAddObjectToWorkspaceEntry: type: "object" properties: Objecttype: type: "integer" format: "int32" Objectid: type: "integer" format: "int32" Objectextmetadata: type: "string" dvBackupInstruction: type: "object" properties: Guid: type: "string" Name: type: "string" JobId: type: "integer" format: "int32" Id: type: "integer" format: "int32" TempFolder: type: "string" TempSpaceNeeded: type: "string" BackupStoreFolder: type: "string" BackupFolder: type: "string" BinaryFolder: type: "string" PartSize: type: "integer" format: "int32" Timeout: type: "integer" format: "int32" IncludeFilesytem: type: "boolean" IncludeIndex: type: "boolean" RegisteredSystemsInformation: type: "array" items: "$ref": "#/components/schemas/dtoRegisteredsystemsInformation" DatabaseConfiguration: type: "object" additionalProperties: type: "string" DatabaseEngine: "$ref": "#/components/schemas/DatabaseEngine" BackupStarted: type: "string" format: "date-time" BackupEnded: type: "string" format: "date-time" Successful: type: "boolean" dvBatchImportField: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvBatchImportLogField: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvBatchimportSetDownloadType: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvBatchImportUserTreeNode: type: "object" properties: Name: type: "string" UserId: type: "integer" format: "int32" ImportStatusMask: type: "integer" format: "int32" Count: type: "integer" format: "int32" dvBrowseMode: type: "integer" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen numerisch (vermutlich Enumeration)." dvDashboardType: type: "integer" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen numerisch (vermutlich Enumeration)." dvDeleteFlagElement: type: "object" properties: DeleteReason: "$ref": "#/components/schemas/dvDeleteReason" ObjectId: type: "integer" format: "int32" IncludeSubItems: type: "boolean" DeleteReasonText: type: "string" dvDeleteReason: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvExportMetadataFormat: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvExtendedRule: type: "object" properties: UserOrGroup: type: "integer" format: "int32" RuleElement: "$ref": "#/components/schemas/dtoConstr" ObjectTypeAccessRightList: type: "array" items: "$ref": "#/components/schemas/dvExtendedRuleObjectTypeAccessRight" dvExtendedRuleElement: type: "object" properties: RuleElementType: "$ref": "#/components/schemas/dvExtendedRuleElementType" Field: type: "string" Operator: type: "string" Values: type: "array" items: type: "string" SubItems: type: "array" items: "$ref": "#/components/schemas/dvExtendedRuleElement" dvExtendedRuleElementType: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvExtendedRuleObjectTypeAccessRight: type: "object" properties: AssignedAccessRight: type: "integer" format: "int32" ObjectType: type: "integer" format: "int32" dvFieldLookupType: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvGetDocumentPurpose: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvImageResourceContent: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvLicenseInformation: type: "object" properties: ProductType: type: "string" NeedsReactivationInDays: type: "integer" format: "int32" LicenseHolderName: type: "string" ProductName: type: "string" LicenseHolderCity: type: "string" LicenseHolderZipCode: type: "string" LicenseHolderStreet: type: "string" VendorName: type: "string" VendorSite: type: "string" VendorContactMail: type: "string" ContractNumber: type: "string" VendorContactPhone: type: "string" dvLookupSort: type: "object" properties: FieldId: type: "integer" format: "int32" SortOrder: "$ref": "#/components/schemas/dvSortOrder" dvMailConfiguration: type: "object" properties: FromAddress: type: "string" ReplyToAddress: type: "string" FixedCcAddress: type: "string" FixedBccAddress: type: "string" MailProvider: "$ref": "#/components/schemas/dvMailProvider" SmtpHost: type: "string" SmtpPort: type: "integer" format: "int32" SmtpSecure: type: "boolean" SmtpSecurity: "$ref": "#/components/schemas/dvSmtpSecurity" SmtpAuthUsername: type: "string" SmtpAuthPassword: type: "string" SmtpIgnoreInvalidCertificate: type: "boolean" OAuthTenantId: type: "string" OAuthClientId: type: "string" OAuthClientSecret: type: "string" SmtpAuthentication: "$ref": "#/components/schemas/dvSmtpAuthentication" dvMailProvider: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvObjectProperty: type: "object" properties: FieldId: type: "integer" format: "int32" FieldName: type: "string" FieldPrompt: type: "string" FieldFormat: type: "string" FieldDescription: type: "string" FieldDocumentation: type: "string" FieldType: type: "string" MultiLine: type: "boolean" FieldValueString: type: "string" FieldValueDateTime: type: "string" format: "date-time" nullable: true FieldValueNumeric: type: "integer" format: "int32" nullable: true FieldValueBool: type: "boolean" nullable: true FieldValueCurrency: type: "number" format: "double" nullable: true Position: type: "integer" format: "int32" Category: type: "string" Required: type: "boolean" LookupValuesOnly: type: "boolean" LookupValues: type: "array" items: type: "string" ReadOnly: type: "boolean" Visible: type: "boolean" IsListType: type: "boolean" ClearBeforeShow: type: "boolean" FieldLookupType: "$ref": "#/components/schemas/dvFieldLookupType" FieldLookupFilter: type: "array" items: type: "string" FieldLookupPluginName: type: "string" FieldLookupValueMapping: type: "string" FieldLookupPluginFilter: type: "string" FieldLookupPluginListener: type: "string" Masked: type: "boolean" ListValuesString: type: "array" items: type: "string" ListValuesDateTime: type: "array" items: type: "string" format: "date-time" nullable: true ListValuesNumeric: type: "array" items: type: "integer" format: "int32" nullable: true ListValuesBool: type: "array" items: type: "boolean" nullable: true ListValuesCurrency: type: "array" items: type: "number" format: "double" nullable: true CustomFunctions: type: "array" items: type: "string" CustomRenderer: type: "string" Dirty: type: "boolean" dvRequestContext: type: "object" properties: SystemReference: type: "integer" format: "int32" ImpersonatedUser: type: "integer" format: "int32" dvRestriction: type: "object" properties: RestrictionType: "$ref": "#/components/schemas/dvRestrictionType" RestrictionValue: type: "string" dvRestrictionType: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvSecuredContentCollectionMemberType: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvSecuredContentCollectionType: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvSetKeyMode: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvSmtpAuthentication: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvSmtpSecurity: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvSort: type: "object" properties: SortProperty: "$ref": "#/components/schemas/dvStandardField" SortOrder: "$ref": "#/components/schemas/dvSortOrder" dvSortBatchImportLogs: type: "object" properties: SortProperty: "$ref": "#/components/schemas/dvBatchImportLogField" SortOrder: "$ref": "#/components/schemas/dvSortOrder" dvSortBatchImports: type: "object" properties: SortProperty: "$ref": "#/components/schemas/dvBatchImportField" SortOrder: "$ref": "#/components/schemas/dvSortOrder" dvSortOrder: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvStandardField: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvTaskCheckoutElement: type: "object" properties: TaskId: type: "integer" format: "int32" UserId: type: "integer" format: "int32" DateRetrieved: type: "string" format: "date-time" dvTaskCheckoutState: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvTaskField: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvTaskFormTypes: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvTaskSort: type: "object" properties: SortProperty: "$ref": "#/components/schemas/dvTaskField" SortPropertyObject: "$ref": "#/components/schemas/dvStandardField" SortOrder: "$ref": "#/components/schemas/dvSortOrder" dvTaskState: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvTaskTemplateTypes: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvUsermanagementItem: type: "object" properties: Name: type: "string" Id: type: "string" Description: type: "string" Objectid: type: "integer" format: "int32" Type: "$ref": "#/components/schemas/dvUsermanagementItemType" Properties: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" IsLeaf: type: "boolean" Path: type: "string" dvUsermanagementItemType: type: "integer" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen numerisch (vermutlich Enumeration)." dvVersionIncrementStyle: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvVersionNumber: type: "object" properties: VersionIncrementStyle: "$ref": "#/components/schemas/dvVersionIncrementStyle" VersionMajor: type: "integer" format: "int32" VersionMinor: type: "integer" format: "int32" VersionRevision: type: "integer" format: "int32" VersionLabel: type: "string" dvWorkflowField: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." dvWorkflowRegistrationType: type: "integer" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen numerisch (vermutlich Enumeration)." dvWorkflowSort: type: "object" properties: SortProperty: "$ref": "#/components/schemas/dvWorkflowField" SortOrder: "$ref": "#/components/schemas/dvSortOrder" ErrorResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" FileUpload: type: "object" properties: Guid: type: "string" format: "uuid" FileUploadResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GenerateStamp: type: "object" properties: StampId: type: "integer" format: "int32" ObjectId: type: "integer" format: "int32" InputStamp: "$ref": "#/components/schemas/dtoStamps" SessionGuid: type: "string" format: "uuid" GenerateStampResponse: type: "object" properties: ResultStamp: "$ref": "#/components/schemas/dtoStamps" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Get2FAInformation: type: "object" properties: TwoFactorToken: type: "string" Get2FAInformationResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Information: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" Get2FAResponseRequest: type: "object" properties: TwoFactorToken: type: "string" RequestToken: type: "string" Get2FAResponseRequestResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetAcls: type: "object" properties: ObjectIdList: type: "array" items: type: "integer" format: "int32" IncludeSystemAcls: type: "boolean" SessionGuid: type: "string" format: "uuid" GetAclsResponse: type: "object" properties: AclList: type: "array" items: "$ref": "#/components/schemas/dtoAclsecurity" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetActiveUsersessions: type: "object" properties: IncludeAllSystems: type: "boolean" SessionGuid: type: "string" format: "uuid" GetActiveUsersessionsResponse: type: "object" properties: Usersessions: type: "array" items: "$ref": "#/components/schemas/dtoUsersessions" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetAllowedObjectTypeIdsForCreation: type: "object" properties: SessionGuid: type: "string" format: "uuid" GetAllowedObjectTypeIdsForCreationResponse: type: "object" properties: AllowedTypesDictionary: type: "object" additionalProperties: type: "array" items: type: "integer" format: "int32" AllowedLocationTypesDictionary: type: "object" additionalProperties: type: "array" items: type: "integer" format: "int32" AllowedWorkflowsDictionary: type: "object" additionalProperties: type: "array" items: "$ref": "#/components/schemas/dtoWorkflowmodel" AllowedWorkflowsToMonitor: type: "array" items: "$ref": "#/components/schemas/dtoWorkflowmodel" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetAuthenticationInformation: type: "object" properties: AuthenticationModuleConfigurationId: type: "integer" format: "int32" ClientType: type: "integer" format: "int32" ExternalLoginPhase: type: "integer" format: "int32" ExternalLoginContext: type: "string" format: "uuid" GetAuthenticationInformationResponse: type: "object" properties: AuthenticationInformation: "$ref": "#/components/schemas/AuthenticationInformation" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetAuthenticationModules: type: "object" properties: RegisteredSystem: type: "integer" format: "int32" ClientType: type: "integer" format: "int32" AuthenticationConfigurationFilter: "$ref": "#/components/schemas/AuthenticationModuleConfigurationFilter" GetAuthenticationModulesResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoAuthenticationmoduleconfiguration" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetAutocompleteSuggestions: type: "object" properties: SearchTerm: type: "string" SessionGuid: type: "string" format: "uuid" GetAutocompleteSuggestionsResponse: type: "object" properties: SuggestionList: type: "array" items: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetBackupInformation: type: "object" properties: SessionGuid: type: "string" format: "uuid" GetBackupInformationResponse: type: "object" properties: BackupManagerState: "$ref": "#/components/schemas/BackupManagerOperationState" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetClientConfiguration: type: "object" properties: SessionGuid: type: "string" format: "uuid" GetClientConfigurationResponse: type: "object" properties: ConfigurationList: type: "array" items: "$ref": "#/components/schemas/dtoConfiguration" ServiceExtensionUploadRoutes: type: "array" items: "$ref": "#/components/schemas/dtoServiceextensionuploadroute" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetConfiguration: type: "object" properties: SessionGuid: type: "string" format: "uuid" GetConfigurationResponse: type: "object" properties: ConfigurationList: type: "array" items: "$ref": "#/components/schemas/dtoConfiguration" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetDashboard: type: "object" properties: SessionGuid: type: "string" format: "uuid" GetDashboardContent: type: "object" properties: DashboardContentType: "$ref": "#/components/schemas/dvDashboardType" SessionGuid: type: "string" format: "uuid" GetDashboardContentResponse: type: "object" properties: MyRecentlyEditedObjectsList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" MyRecentlyEditedDocumentsList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" RecentlyEditedObjectsList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" RecentlyEditedDocumentsList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" MyRecentlySeenObjectsList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" MyRecentlySeenDocumentsList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" TaskResultList: type: "array" items: "$ref": "#/components/schemas/dtoTask" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetDashboardResponse: type: "object" properties: MyRecentDocumentsList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" Counters: type: "object" additionalProperties: type: "integer" format: "int32" NewsItems: type: "array" items: "$ref": "#/components/schemas/DashboardNewsItem" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetDatabaseInformation: type: "object" properties: SessionGuid: type: "string" format: "uuid" GetDatabaseInformationResponse: type: "object" properties: DatabaseInformation: "$ref": "#/components/schemas/dtoDatabaseinformation" DatabaseManagerState: "$ref": "#/components/schemas/DatabaseManagerOperationState" DatabaseLanguages: type: "array" items: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetDocument: type: "object" properties: VersionId: type: "integer" format: "int32" description: "Specifies the version id to download" ObjectId: type: "integer" format: "int32" CheckOut: type: "boolean" DownloadAsAttachment: type: "boolean" DownloadPreviewDocument: type: "boolean" Comment: type: "string" DownloadPurpose: "$ref": "#/components/schemas/dvGetDocumentPurpose" SessionGuid: type: "string" format: "uuid" GetDocumentResponse: type: "object" properties: Options: type: "object" additionalProperties: type: "string" GetDownloadOperations: type: "object" properties: Downloadrecipientid: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetDownloadOperationsResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoDownloadoperations" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetDownloadRecipients: type: "object" properties: Downloadid: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetDownloadRecipientsResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoDownloadrecipients" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetDownloads: type: "object" properties: FilterByDownloadId: type: "integer" format: "int32" FilterByObjectId: type: "integer" format: "int32" FilterByUserId: type: "integer" format: "int32" FilterByRecipientMailAddress: type: "string" FilterByDownloadStatus: type: "integer" format: "int32" DateFrom: type: "string" format: "date-time" DateTo: type: "string" format: "date-time" ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSort" PageNumber: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetDownloadsResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoDownloads" TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetExportSet: type: "object" properties: SelectedItemsExportSource: type: "string" ListExportSource: type: "string" QueryExportSource: type: "string" ExportDocumentFiles: type: "boolean" ExportPreviewFiles: type: "boolean" MetadataFormat: "$ref": "#/components/schemas/dvExportMetadataFormat" Recursive: type: "boolean" PrintToPdf: type: "boolean" ZipProtectionPassword: type: "string" SkipObjectId: type: "boolean" UseOriginalFilename: type: "boolean" SessionGuid: type: "string" format: "uuid" GetExportSetResponse: type: "object" properties: Options: type: "object" additionalProperties: type: "string" GetFavorites: type: "object" properties: ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSort" SessionGuid: type: "string" format: "uuid" GetFavoritesResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetFieldTypes: type: "object" properties: SessionGuid: type: "string" format: "uuid" GetFieldTypesResponse: type: "object" properties: FieldTypesList: type: "array" items: "$ref": "#/components/schemas/dtoFieldtypes" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetHistory: type: "object" properties: ObjectId: type: "integer" format: "int32" FilterByUser: type: "string" FilterEvents: type: "array" items: type: "integer" format: "int32" DocumentsOnly: type: "boolean" PageNumber: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" IncludeReadAccessItems: type: "boolean" SessionGuid: type: "string" format: "uuid" GetHistoryMetadata: type: "object" properties: LoggingId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetHistoryMetadataResponse: type: "object" properties: ObjectPropertyList: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetHistoryObjectList: type: "object" properties: ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSort" HistoryType: "$ref": "#/components/schemas/dvDashboardType" ObjectTypeClasses: type: "string" PageNumber: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetHistoryObjectListResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetHistoryResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoLogging" TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetList: type: "object" properties: Root: type: "integer" format: "int32" ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSort" BrowseMode: "$ref": "#/components/schemas/dvBrowseMode" FilterByObjectTypeIds: type: "array" items: type: "integer" format: "int32" PageNumber: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" SystemReference: type: "integer" format: "int32" ImpersonationUser: type: "integer" format: "int32" GetListResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetLookupPluginResultSet: type: "object" properties: LookupName: type: "string" QueryDetails: "$ref": "#/components/schemas/dvExtendedRuleElement" ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvLookupSort" PageNumber: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetLookupPluginResultSetResponse: type: "object" properties: Columns: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" ResultList: type: "array" items: type: "object" additionalProperties: {} TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetMailAttachment: type: "object" properties: VersionId: type: "integer" format: "int32" AttachmentName: type: "string" SessionGuid: type: "string" format: "uuid" GetMailAttachmentResponse: type: "object" properties: Options: type: "object" additionalProperties: type: "string" GetMailPreview: type: "object" properties: VersionId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetMailPreviewResponse: type: "object" properties: ObjectId: type: "integer" format: "int32" VersionId: type: "integer" format: "int32" MailFrom: type: "string" MailTo: type: "string" MailCc: type: "string" MailBcc: type: "string" MailSubject: type: "string" MailSendDate: type: "string" format: "date-time" MailBody: type: "string" MailBodyIsHtml: type: "boolean" MailAttachments: type: "array" items: type: "string" MailMessageId: type: "string" FileFormat: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetMyWorkspace: type: "object" properties: ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSort" SessionGuid: type: "string" format: "uuid" GetMyWorkspaceQuicksearchResults: type: "object" properties: SearchTerm: type: "string" ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSort" PageNumber: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetMyWorkspaceQuicksearchResultsResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetMyWorkspaceResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetNotes: type: "object" properties: FilterByNoteId: type: "integer" format: "int32" FilterByObjectId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetNotesResponse: type: "object" properties: ResultNotes: type: "array" items: "$ref": "#/components/schemas/dtoNotes" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetObject: type: "object" properties: ObjectId: type: "integer" format: "int32" SubselectPath: type: "string" SessionGuid: type: "string" format: "uuid" GetObjectProperties: type: "object" properties: ObjectId: type: "integer" format: "int32" ObjectTypeId: type: "integer" format: "int32" Purpose: "$ref": "#/components/schemas/RequestPurpose" ParentObject: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetObjectPropertiesResponse: type: "object" properties: ObjectPropertyList: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" ObjectPathElements: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" NewObjectPropertyList: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" IsFavorite: type: "boolean" IsWorkspace: type: "boolean" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetObjectRelations: type: "object" properties: ObjectId: type: "integer" format: "int32" ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSort" IncludeLinksToObject: type: "boolean" IncludeLinksFromObject: type: "boolean" IncludeRealParentObject: type: "boolean" PageNumber: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetObjectRelationsResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetObjectResponse: type: "object" properties: ResultObject: "$ref": "#/components/schemas/dtoObjects" ObjectPathElements: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetObjecttypeDefinition: type: "object" properties: FilterById: type: "integer" format: "int32" FilterByObjectTypeId: type: "integer" format: "int32" IncludeHiddenFields: type: "boolean" FilterByName: type: "string" SessionGuid: type: "string" format: "uuid" GetObjecttypeDefinitionResponse: type: "object" properties: ObjecttypedefinitionList: type: "array" items: "$ref": "#/components/schemas/dtoObjecttypedefinition" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetObjecttypes: type: "object" properties: FilterById: type: "integer" format: "int32" FilterByName: type: "string" FilterByInternalName: type: "string" MyWorkspaceTypesOnly: type: "boolean" FilterByAccessibilityByCurrentUser: type: "boolean" IncludeHiddenTypes: type: "boolean" RemoveImageData: type: "boolean" SessionGuid: type: "string" format: "uuid" GetObjecttypesResponse: type: "object" properties: ObjecttypeList: type: "array" items: "$ref": "#/components/schemas/dtoObjecttypes" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetQueryResultSet: type: "object" properties: QueryDetails: "$ref": "#/components/schemas/dtoConstr" ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSort" BrowseMode: "$ref": "#/components/schemas/dvBrowseMode" PageNumber: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Context: "$ref": "#/components/schemas/dvRequestContext" GetQueryResultSetResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetSavedQueries: type: "object" properties: FilterByQueryType: type: "string" FilterByUsersAndQueriesId: type: "integer" format: "int32" IncludeQueryDetails: type: "boolean" SessionGuid: type: "string" format: "uuid" GetSavedQueriesResponse: type: "object" properties: SavedQueries: type: "array" items: "$ref": "#/components/schemas/dtoUsersandqueries" SavedQueryDefinitions: type: "array" items: "$ref": "#/components/schemas/dtoConstr" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetServiceExtensionUploadRoutes: type: "object" properties: SessionGuid: type: "string" format: "uuid" GetServiceExtensionUploadRoutesResponse: type: "object" properties: RouteList: type: "array" items: "$ref": "#/components/schemas/dtoServiceextensionuploadroute" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetStamps: type: "object" properties: FilterByStampId: type: "integer" format: "int32" FilterByIsActive: type: "boolean" nullable: true SessionGuid: type: "string" format: "uuid" GetStampsResponse: type: "object" properties: ResultStamps: type: "array" items: "$ref": "#/components/schemas/dtoStamps" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetStylesheet: type: "object" properties: Color1: type: "string" Color2: type: "string" GetStylesheetResponse: type: "object" properties: Options: type: "object" additionalProperties: type: "string" GetTask: type: "object" properties: Taskid: type: "integer" format: "int32" description: "Task id of the task to be retrieved. Server will check that task is open for completion, and that either user is assigned to this task, or user is member of the workflow admin role." SessionGuid: type: "string" format: "uuid" GetTaskResponse: type: "object" properties: TaskProperties: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" description: "Task details in form of a property grid. When completing the task, property grid values need to be sent back and will be validated on the server." TaskElement: "$ref": "#/components/schemas/dtoTask" WorkflowObjects: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" PreviousTaskCheckout: allOf: - "$ref": "#/components/schemas/dvTaskCheckoutElement" description: "If set," ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetTasks: type: "object" properties: UserId: type: "integer" format: "int32" DateFrom: type: "string" format: "date-time" DateTo: type: "string" format: "date-time" ObjectId: type: "integer" format: "int32" FilterString: type: "string" TaskDateCreatedFrom: type: "string" format: "date-time" nullable: true TaskDateCreatedTo: type: "string" format: "date-time" nullable: true PageNumber: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvTaskSort" SessionGuid: type: "string" format: "uuid" GetTasksResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoTask" AffectedWorkflows: type: "array" items: type: "string" TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetThumbnail: type: "object" properties: ObjectId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetTree: type: "object" properties: Root: type: "integer" format: "int32" ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSort" BrowseMode: "$ref": "#/components/schemas/dvBrowseMode" SessionGuid: type: "string" format: "uuid" Context: "$ref": "#/components/schemas/dvRequestContext" GetTreeResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetUsersAndGroupsList: type: "object" properties: IncludeUsers: type: "boolean" IncludeGroups: type: "boolean" IncludeOwnUserAndGroupsOnly: type: "boolean" FilterBySystemReferenceId: type: "integer" format: "int32" IncludeEmptyValue: type: "boolean" FilterByWorkflowRole: type: "array" items: type: "string" ExcludeInactiveUserAndGroups: type: "boolean" AlwaysIncludeOwnUserAndGroups: type: "boolean" FilterByWorkflowCreator: type: "boolean" FilterByWorkflowLastActiveUser: type: "boolean" FilterByWorkflowAssignee: type: "boolean" SessionGuid: type: "string" format: "uuid" GetUsersAndGroupsListResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetUserSettings: type: "object" properties: FilterBySettingKey: type: "string" SessionGuid: type: "string" format: "uuid" GetUserSettingsResponse: type: "object" properties: SettingsList: type: "array" items: "$ref": "#/components/schemas/dtoUsersettings" RestrictionList: type: "object" additionalProperties: "$ref": "#/components/schemas/dvRestriction" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetValidationScripts: type: "object" properties: SessionGuid: type: "string" format: "uuid" GetValidationScriptsResponse: type: "object" properties: Options: type: "object" additionalProperties: type: "string" GetVersionFulltext: type: "object" properties: VersionId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetVersionFulltextResponse: type: "object" properties: Fulltext: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetVersionList: type: "object" properties: FilterByObjectId: type: "integer" format: "int32" FilterByVersionId: type: "integer" format: "int32" LatestOnly: type: "boolean" PageNumber: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetVersionListResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoVersions" TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetWorkflowDiagram: type: "object" properties: WorkflowModelId: type: "integer" format: "int32" WorkflowId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetWorkflowDiagramResponse: type: "object" properties: WorkflowTemplate: "$ref": "#/components/schemas/WorkflowTemplate" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetWorkflowLog: type: "object" properties: WorkflowId: type: "integer" format: "int32" FilterEvents: type: "array" items: type: "integer" format: "int32" PageNumber: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetWorkflowLogResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoWorkflowlog" TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetWorkflowModelEntries: type: "object" properties: FilterByWorkflowModelGuid: type: "string" FilterByWorkflowModelName: type: "string" FilterByWorkflowModelId: type: "integer" format: "int32" EnabledRecordsOnly: type: "boolean" SessionGuid: type: "string" format: "uuid" GetWorkflowModelEntriesResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoWorkflowmodel" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetWorkflows: type: "object" properties: FilterByWorkflowId: type: "integer" format: "int32" description: "Filter the result set by a specific workflow ID. User either needs to be workflow admin or have full read access on the object(s) the specified workflow is running on." FilterByObjectId: type: "integer" format: "int32" description: "Retrieve workflows that are running on the specified object ID. User either needs to be workflow admin or have full read access on the object specified here." OnlyRunningWorkflows: type: "boolean" description: "If true, only currently running workflows will be returned. Otherwise all workflows matching the filter criteria will be returned." OnlyCompletedWorkflows: type: "boolean" description: "If true, only currently completed(=stopped) workflows will be returned." FilterByWorkflowModelId: type: "array" items: type: "integer" format: "int32" description: "If a list is provided, result list will be filtered by workflow model ID." FilterByAssignedUser: type: "array" items: type: "integer" format: "int32" description: "If a list is provided, result will be filtered so only those workflows with given users/groups assigned to tasks will be returned." ResolveGroupsAndRolesForAssignedUser: type: "boolean" description: "If true, the assignements by group id or workflowrole will be resolved to specific users. This enables FilterByAssignedUser to match those resolved users." FilterByAssignedWorkflowRole: type: "array" items: type: "string" description: "If specified, result list will contain only workflows with tasks that are assigned to the given workflow roles." FilterByResolvingUser: type: "array" items: type: "integer" format: "int32" description: "If a list is provided, result will be filtered so only those workflows where given users have actually resolved a task will be returned." FilterByErrorEntryExists: type: "boolean" description: "If set, only return workflows that have an error log entry." FilterByWarnEntryExists: type: "boolean" description: "If set, only return workflows that have a warn log entry." FilterByWorkflowValues: type: "array" items: "$ref": "#/components/schemas/dtoWorkflowvalue" description: "Returns only workflows that match the searched workflow values with key item and or value.Doesn't search for sub strings with like." OnlyCompletedTasks: type: "boolean" description: "If specified, task filter (FilterByAssignedUser, FilterByAssignedWorkflowRole or FilterByResolvingUser and TaskDueDateFrom/To) will only match tasks that are completed." OnlyOpenTasks: type: "boolean" description: "If specified, task filter (FilterByAssignedUser, FilterByAssignedWorkflowRole or FilterByResolvingUser and TaskDueDateFrom/To) will only match tasks that are NOT completed." FilterByLastActivityUser: type: "array" items: type: "integer" format: "int32" description: "If a list is provided, result will be filtered by the last active user that completed the task." FilterByCreatedUser: type: "array" items: type: "integer" format: "int32" description: "If a list is provided, result will be filtered by the user who started the workflow." FilterByCurrentTask: type: "string" description: "If a string is provided, result will be filtered by taskdisplayname containing the string" CreatedDateFrom: type: "string" format: "date-time" description: "Filter the result set by creation date of workflow (start date)" CreatedDateTo: type: "string" format: "date-time" description: "Filter the result set by creation date of workflow (end date)" TaskDueDateFrom: type: "string" format: "date-time" nullable: true description: "If specified, task filter will allow only tasks from due date period given via TaskDueDateFrom and TaskDueDateTo." TaskDueDateTo: type: "string" format: "date-time" nullable: true description: "If specified, task filter will allow only tasks from due date period given via TaskDueDateFrom and TaskDueDateTo." LastActivityDateFrom: type: "string" format: "date-time" nullable: true description: "If specified, workflow filter will allow only tasks from last activity date period given via LastActivityDateFrom and LastActivityDateTo." LastActivityDateTo: type: "string" format: "date-time" nullable: true description: "If specified, workflow filter will allow only tasks from last activity date period given via LastActivityDateFrom and LastActivityDateTo." PageNumber: type: "integer" format: "int32" description: "If the total number of items exceeds PageSize, retrieve the page specified here. If this page doesn't exist, retrieve page 0 (first page) with a max of PageSize elements." PageSize: type: "integer" format: "int32" description: "Specify the number of items that are retrieved per operation. PageSize needs to be between 1 and 1000 (including), or 200 will be assumed" ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvWorkflowSort" description: "Sort condition(s) for the result set" SessionGuid: type: "string" format: "uuid" description: "User session used to process this request" GetWorkflowsResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoWorkflow" description: "List of workflows" WorkflowObjects: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" description: "List of workflowsobjects" TotalItemCount: type: "integer" format: "int32" description: "Total number of workflows retrieved" TotalPageCount: type: "integer" format: "int32" description: "Total number of list pages in relation to PageSize" PageSize: type: "integer" format: "int32" description: "Resulting/actual PageSize for this operation. See PageSize on request object" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetWorkflowStartProperties: type: "object" properties: WorkflowModelId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" GetWorkflowStartPropertiesResponse: type: "object" properties: PropertyList: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" GetWorkflowValues: type: "object" properties: FilterByWorkflowId: type: "integer" format: "int32" description: "Filter the result set by a specific workflow ID. User either needs to be workflow admin or have full read access on the object(s) the specified workflow is running on." SessionGuid: type: "string" format: "uuid" description: "The session GUID identifying the current user session." GetWorkflowValuesResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoWorkflowvalue" description: "List of workflow values" ResponseStatus: allOf: - "$ref": "#/components/schemas/ResponseStatus" description: "The status of the response, including error information if any." IDocContentParserSettings: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." ImportAdmin_GetImportList: type: "object" properties: UserId: type: "integer" format: "int32" ImportStatusMask: type: "integer" format: "int32" ExcludedImportStatusMask: type: "integer" format: "int32" TextFilter: type: "string" FromFilter: type: "string" format: "date-time" ToFilter: type: "string" format: "date-time" ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSortBatchImports" PageNumber: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" ImportAdmin_GetImportListResponse: type: "object" properties: ImportList: type: "array" items: "$ref": "#/components/schemas/dtoBatchimports" TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ImportAdmin_GetImportLog: type: "object" properties: BatchImportId: type: "integer" format: "int32" BatchImportSessionId: type: "integer" format: "int32" ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSortBatchImportLogs" PageNumber: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" ImportAdmin_GetImportLogResponse: type: "object" properties: LogList: type: "array" items: "$ref": "#/components/schemas/dtoBatchimportlog" TotalItemCount: type: "integer" format: "int32" TotalPageCount: type: "integer" format: "int32" PageSize: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ImportAdmin_GetImportSessions: type: "object" properties: BatchImportId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" ImportAdmin_GetImportSessionsResponse: type: "object" properties: SessionList: type: "array" items: "$ref": "#/components/schemas/dtoBatchimportsessions" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ImportAdmin_GetImportSet: type: "object" properties: Batchimportids: type: "array" items: type: "integer" format: "int32" BatchimportSetType: "$ref": "#/components/schemas/dvBatchimportSetDownloadType" IncludeLog: type: "boolean" SessionGuid: type: "string" format: "uuid" ImportAdmin_GetImportSetResponse: type: "object" properties: Options: type: "object" additionalProperties: type: "string" ImportAdmin_GetImportUsers: type: "object" properties: FilterByImportuserid: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" ImportAdmin_GetImportUsersResponse: type: "object" properties: UserList: type: "array" items: "$ref": "#/components/schemas/dtoBatchimportusers" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ImportAdmin_GetImportUsersTree: type: "object" properties: UserId: type: "integer" format: "int32" ImportStatusMask: type: "integer" format: "int32" TextFilter: type: "string" FromFilter: type: "string" format: "date-time" ToFilter: type: "string" format: "date-time" SessionGuid: type: "string" format: "uuid" ImportAdmin_GetImportUsersTreeResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dvBatchImportUserTreeNode" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ImportAdmin_SetImportComment: type: "object" properties: BatchImportIds: type: "array" items: type: "integer" format: "int32" Comment: type: "string" SessionGuid: type: "string" format: "uuid" ImportAdmin_SetImportCommentResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ImportAdmin_SetImportResolvedFlag: type: "object" properties: BatchImportIds: type: "array" items: type: "integer" format: "int32" Resolved: type: "boolean" SessionGuid: type: "string" format: "uuid" ImportAdmin_SetImportResolvedFlagResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ImportAdmin_SetImportUser: type: "object" properties: ImportUser: "$ref": "#/components/schemas/dtoBatchimportusers" SessionGuid: type: "string" format: "uuid" ImportAdmin_SetImportUserResponse: type: "object" properties: ImportUser: "$ref": "#/components/schemas/dtoBatchimportusers" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ImportAPI_StartImport: type: "object" properties: BatchImportIds: type: "array" items: type: "integer" format: "int32" UserName: type: "string" Password: type: "string" SystemReference: type: "integer" format: "int32" ImportAPI_StartImportResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ImportAPI_StoreDocumentationConfiguration: type: "object" properties: ApConfiguration: "$ref": "#/components/schemas/AutoProfilerConfiguration" ConfigurationName: type: "string" HostName: type: "string" UserName: type: "string" Password: type: "string" SystemReference: type: "integer" format: "int32" ImportAPI_UploadImportSet: type: "object" properties: ImportName: type: "string" ImportTagName: type: "string" BatchImportGuid: type: "string" StartImportAfterUpload: type: "boolean" UserName: type: "string" Password: type: "string" SystemReference: type: "integer" format: "int32" ImportAPI_UploadImportSetResponse: type: "object" properties: BatchImport: "$ref": "#/components/schemas/dtoBatchimports" UploadGuid: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ImportTemplateSettings: type: "object" properties: Name: type: "string" Description: type: "string" Enabled: type: "boolean" Condition: type: "string" XmlContent: type: "string" InfoResponse: type: "object" properties: ProductName: type: "string" ProductVersion: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_BatchObjectChanger: type: "object" properties: Simulation: type: "boolean" BatchObjectChangeOperations: type: "array" items: "$ref": "#/components/schemas/BatchObjectChangeOperation" RestrictToObjectIds: type: "array" items: type: "integer" format: "int32" LoggerName: type: "string" LogComment: type: "string" Limit: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" LocalAdmin_BatchObjectChangerResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_CleanDuplicates: type: "object" properties: Simulation: type: "boolean" ObjectTypeIds: type: "array" items: type: "integer" format: "int32" LoggerName: type: "string" SessionGuid: type: "string" format: "uuid" LocalAdmin_CleanDuplicatesResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_DeleteAccessRuleAssignments: type: "object" properties: DeletionList: type: "array" items: "$ref": "#/components/schemas/dtoGroupsandrules" SessionGuid: type: "string" format: "uuid" LocalAdmin_DeleteAccessRuleAssignmentsResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_DeleteAccessRules: type: "object" properties: ConstrIds: type: "array" items: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" LocalAdmin_DeleteAccessRulesResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_DeleteExtendedAccessRules: type: "object" properties: ConstrIds: type: "array" items: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" LocalAdmin_DeleteExtendedAccessRulesResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_GetAccessRuleAssignments: type: "object" properties: FilterByObjectTypeId: type: "integer" format: "int32" FilterByConstrId: type: "integer" format: "int32" FilterByGroupId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Context: "$ref": "#/components/schemas/dvRequestContext" LocalAdmin_GetAccessRuleAssignmentsResponse: type: "object" properties: AssignmentList: type: "array" items: "$ref": "#/components/schemas/dtoGroupsandrules" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_GetAccessRules: type: "object" properties: FilterByObjectTypeId: type: "integer" format: "int32" FilterByConstrId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" Context: "$ref": "#/components/schemas/dvRequestContext" LocalAdmin_GetAccessRulesResponse: type: "object" properties: AccessRuleList: type: "array" items: "$ref": "#/components/schemas/dtoConstr" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_GetExtendedAccessRules: type: "object" properties: FilterByUserOrGroupId: type: "integer" format: "int32" RetrieveRuleDetails: type: "boolean" FilterByConstrId: type: "integer" format: "int32" RetrieveRuleList: type: "boolean" SessionGuid: type: "string" format: "uuid" LocalAdmin_GetExtendedAccessRulesResponse: type: "object" properties: RulesByUserOrGroup: type: "object" additionalProperties: type: "array" items: "$ref": "#/components/schemas/dvExtendedRule" RuleCountByUserOrGroup: type: "object" additionalProperties: type: "integer" format: "int32" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_GetLookupPluginConfigurationProperties: type: "object" properties: LookupPluginName: type: "string" Systemreference: type: "integer" format: "int32" LookupPluginClass: type: "string" SessionGuid: type: "string" format: "uuid" LocalAdmin_GetLookupPluginConfigurationPropertiesResponse: type: "object" properties: ConfigurationPropertyList: type: "array" items: "$ref": "#/components/schemas/LookupPluginConfigurationValue" FieldConfigurationList: type: "array" items: "$ref": "#/components/schemas/LookupPluginFieldConfiguration" ExtendedFieldConfigurationPropertyList: type: "array" items: "$ref": "#/components/schemas/LookupPluginExtendedFieldConfigurationValue" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_GetLookupPluginConfigurations: type: "object" properties: RegisteredSystem: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" LocalAdmin_GetLookupPluginConfigurationsResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoLookuppluginconfiguration" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_GetServerSettings: type: "object" properties: FilterBySettingKey: type: "string" SessionGuid: type: "string" format: "uuid" LocalAdmin_GetServerSettingsResponse: type: "object" properties: SettingsList: type: "array" items: "$ref": "#/components/schemas/dtoServersettings" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_SetAccessRuleAssignments: type: "object" properties: AssignmentList: type: "array" items: "$ref": "#/components/schemas/dtoGroupsandrules" SessionGuid: type: "string" format: "uuid" Context: "$ref": "#/components/schemas/dvRequestContext" LocalAdmin_SetAccessRuleAssignmentsResponse: type: "object" properties: AssignmentList: type: "array" items: "$ref": "#/components/schemas/dtoGroupsandrules" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_SetAccessRules: type: "object" properties: AccessRuleList: type: "array" items: "$ref": "#/components/schemas/dtoConstr" SessionGuid: type: "string" format: "uuid" LocalAdmin_SetAccessRulesResponse: type: "object" properties: AccessRuleList: type: "array" items: "$ref": "#/components/schemas/dtoConstr" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_SetExtendedAccessRule: type: "object" properties: ExtendedRule: "$ref": "#/components/schemas/dvExtendedRule" SessionGuid: type: "string" format: "uuid" LocalAdmin_SetExtendedAccessRuleResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_SetServerSetting: type: "object" properties: ServerSetting: "$ref": "#/components/schemas/dtoServersettings" SessionGuid: type: "string" format: "uuid" Context: "$ref": "#/components/schemas/dvRequestContext" LocalAdmin_SetServerSettingResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LocalAdmin_UserLogout: type: "object" properties: SessionId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" LocalAdmin_UserLogoutResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" LookupPluginConfigurationValue: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." LookupPluginExtendedFieldConfigurationValue: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." LookupPluginFieldConfiguration: type: "object" properties: ExtendedConfigurationValues: type: "array" items: "$ref": "#/components/schemas/LookupPluginExtendedFieldConfigurationValue" MaintenanceLogin: type: "object" properties: Username: type: "string" Password: type: "string" Language: type: "string" MaintenanceLoginResponse: type: "object" properties: MaintenanceSession: "$ref": "#/components/schemas/dtoMaintenanceusersession" DatabaseManagerStatus: "$ref": "#/components/schemas/DatabaseManagerOperationState" ServerIsInMaintenanceMode: type: "boolean" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" MaintenanceLogout: type: "object" properties: SessionGuid: type: "string" format: "uuid" MaintenanceLogoutResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" MigrateOldWorkflows: type: "object" properties: SessionGuid: type: "string" format: "uuid" MigrateOldWorkflowsResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" MigratedWorkflows: type: "integer" format: "int32" OperationPluginConfigurationValue: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." PrepareServiceExtensionUpload: type: "object" properties: Route: "$ref": "#/components/schemas/dtoServiceextensionuploadroute" UploadInformation: type: "string" SessionGuid: type: "string" format: "uuid" PrepareServiceExtensionUploadResponse: type: "object" properties: UploadGuid: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ProfilerOperationMode: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." ReadBackupFile: type: "object" properties: BackupFile: type: "string" SessionGuid: type: "string" format: "uuid" ReadBackupFileResponse: type: "object" properties: BackupInstruction: "$ref": "#/components/schemas/dvBackupInstruction" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" RefreshSession: type: "object" properties: UiCulture: type: "string" SessionGuid: type: "string" format: "uuid" RefreshSessionResponse: type: "object" properties: Usersession: "$ref": "#/components/schemas/dtoUsersessions" License: "$ref": "#/components/schemas/dvLicenseInformation" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" RegisteredSystems: type: "object" properties: FilterByRegisteredSystemGuid: type: "string" SessionGuid: type: "string" format: "uuid" RegisteredSystemsResponse: type: "object" properties: SystemsList: type: "array" items: "$ref": "#/components/schemas/dtoRegisteredsystems" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" RemoveDeleteFlag: type: "object" properties: DeleteFlagElements: type: "array" items: "$ref": "#/components/schemas/dvDeleteFlagElement" SessionGuid: type: "string" format: "uuid" RemoveDeleteFlagResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" RemoveFromFavorites: type: "object" properties: ObjectIds: type: "array" items: type: "integer" format: "int32" UserId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" RemoveFromFavoritesResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" RemoveFromMyWorkspace: type: "object" properties: ObjectIds: type: "array" items: type: "integer" format: "int32" UserId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" RemoveFromMyWorkspaceResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" RemoveVersionDeleteFlag: type: "object" properties: VersionId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" RemoveVersionDeleteFlagResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" RequestPurpose: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." ResetUserPassword: type: "object" properties: UserId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" ResetUserPasswordResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ResponseError: type: "object" properties: ErrorCode: type: "string" FieldName: type: "string" Message: type: "string" Meta: type: "object" additionalProperties: type: "string" ResponseStatus: type: "object" description: "Standard-Statusobjekt von ServiceStack; Struktur aus den Beispielen der Quelle abgeleitet." properties: ErrorCode: type: "string" Message: type: "string" StackTrace: type: "string" Errors: type: "array" items: "$ref": "#/components/schemas/ResponseError" Meta: type: "object" additionalProperties: type: "string" RightsGridColumnDefinition: type: "object" properties: header: type: "string" width: type: "integer" format: "int32" dataIndex: type: "string" xtype: type: "string" RightsGridFieldDefinition: type: "object" properties: name: type: "string" type: type: "string" RightsGridValue: type: "object" properties: id: type: "string" text: type: "string" systemId: type: "integer" format: "int32" groupId: type: "integer" format: "int32" userId: type: "integer" format: "int32" name: type: "string" leaf: type: "boolean" iconCls: type: "string" children: type: "array" items: "$ref": "#/components/schemas/RightsGridValue" values: type: "array" items: "$ref": "#/components/schemas/dtoGroupsandrules" SaveAdvancedQuery: type: "object" properties: UsersandqueriesObject: "$ref": "#/components/schemas/dtoUsersandqueries" QueryDefinition: "$ref": "#/components/schemas/dtoConstr" SessionGuid: type: "string" format: "uuid" SaveAdvancedQueryResponse: type: "object" properties: SavedQuery: "$ref": "#/components/schemas/dtoUsersandqueries" SavedQueryDefinition: "$ref": "#/components/schemas/dtoConstr" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SaveSimpleQuery: type: "object" properties: UsersandqueriesObject: "$ref": "#/components/schemas/dtoUsersandqueries" SessionGuid: type: "string" format: "uuid" SaveSimpleQueryResponse: type: "object" properties: SavedQuery: "$ref": "#/components/schemas/dtoUsersandqueries" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" ScanDirection: type: "integer" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen numerisch (vermutlich Enumeration)." ScriptSettings: type: "object" properties: Name: type: "string" Description: type: "string" Enabled: type: "boolean" Condition: type: "string" ScriptCode: type: "string" ScriptFile: type: "string" ScriptType: "$ref": "#/components/schemas/AutoProfilerScriptType" SecuredContent_GetKeys: type: "object" properties: FilterByCollectionName: type: "string" FilterByCollectionType: "$ref": "#/components/schemas/dvSecuredContentCollectionType" SessionGuid: type: "string" format: "uuid" SecuredContent_GetKeysResponse: type: "object" properties: Collections: type: "array" items: "$ref": "#/components/schemas/dtoSccollections" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SecuredContent_GetSecuredContent: type: "object" properties: ObjectId: type: "integer" format: "int32" ObjectTypeDefinitionId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" SecuredContent_GetSecuredContentResponse: type: "object" properties: Result: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SecuredContent_SetKey: type: "object" properties: OperationMode: "$ref": "#/components/schemas/dvSetKeyMode" SecuredContentPassword: type: "string" SecuredContentPassPhrase: type: "string" OldSecuredContentPassPhrase: type: "string" CollectionId: type: "integer" format: "int32" CollectionName: type: "string" CollectionUserId: type: "integer" format: "int32" CollectionMemberType: "$ref": "#/components/schemas/dvSecuredContentCollectionMemberType" DeprecatedCollectionPrivateKey: type: "string" SessionGuid: type: "string" format: "uuid" SecuredContent_SetKeyResponse: type: "object" properties: Collection: "$ref": "#/components/schemas/dtoSccollections" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetAcls: type: "object" properties: AclList: type: "array" items: "$ref": "#/components/schemas/dtoAclsecurity" SessionGuid: type: "string" format: "uuid" SetAclsResponse: type: "object" properties: AclList: type: "array" items: "$ref": "#/components/schemas/dtoAclsecurity" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetDeleteFlag: type: "object" properties: DeleteFlagElements: type: "array" items: "$ref": "#/components/schemas/dvDeleteFlagElement" SessionGuid: type: "string" format: "uuid" SetDeleteFlagResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetDownload: type: "object" properties: Download: "$ref": "#/components/schemas/dtoDownloads" DownloadRecipients: type: "array" items: "$ref": "#/components/schemas/dtoDownloadrecipients" SessionGuid: type: "string" format: "uuid" SetDownloadResponse: type: "object" properties: Download: "$ref": "#/components/schemas/dtoDownloads" DownloadRecipients: type: "array" items: "$ref": "#/components/schemas/dtoDownloadrecipients" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetFirstRegisteredSystem: type: "object" properties: FileStoreAddress: type: "string" ImportStoreAddress: type: "string" Systemname: type: "string" SessionGuid: type: "string" format: "uuid" SetFirstRegisteredSystemResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetIndexDirectory: type: "object" properties: IndexDirectory: type: "string" SessionGuid: type: "string" format: "uuid" SetIndexDirectoryResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetNote: type: "object" properties: NoteToSave: "$ref": "#/components/schemas/dtoNotes" SessionGuid: type: "string" format: "uuid" SetNoteResponse: type: "object" properties: ResultNote: "$ref": "#/components/schemas/dtoNotes" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetNoteState: type: "object" properties: NewNoteState: type: "integer" format: "int32" NoteId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" SetNoteStateResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetObject: type: "object" properties: ObjectToSave: "$ref": "#/components/schemas/dtoObjects" VersionOriginalFilename: type: "string" VersionComment: type: "string" VersionExternalMetadata: type: "string" VersionNumber: "$ref": "#/components/schemas/dvVersionNumber" SessionGuid: type: "string" format: "uuid" SetObjectProperties: type: "object" properties: ObjectPropertyList: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" VersionOriginalFilename: type: "string" VersionComment: type: "string" VersionExternalMetadata: type: "string" VersionNumber: "$ref": "#/components/schemas/dvVersionNumber" SessionGuid: type: "string" format: "uuid" Context: "$ref": "#/components/schemas/dvRequestContext" SetObjectPropertiesResponse: type: "object" properties: ObjectPropertyList: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" DocUploadGuid: type: "string" ObjectPathElements: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetObjectRelations: type: "object" properties: SourceObjectId: type: "integer" format: "int32" RelatedObjectIds: type: "array" items: type: "integer" format: "int32" LinkComment: type: "string" SessionGuid: type: "string" format: "uuid" Context: "$ref": "#/components/schemas/dvRequestContext" SetObjectRelationsResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetObjectResponse: type: "object" properties: SavedObject: "$ref": "#/components/schemas/dtoObjects" DocUploadGuid: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetParent: type: "object" properties: ObjectIds: type: "array" items: type: "integer" format: "int32" NewParentObject: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" SetParentResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetStamp: type: "object" properties: StampToSave: "$ref": "#/components/schemas/dtoStamps" SessionGuid: type: "string" format: "uuid" SetStampResponse: type: "object" properties: ResultStamp: "$ref": "#/components/schemas/dtoStamps" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetUserSetting: type: "object" properties: UserSetting: "$ref": "#/components/schemas/dtoUsersettings" SessionGuid: type: "string" format: "uuid" SetUserSettingResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetVersion: type: "object" properties: ObjectId: type: "integer" format: "int32" CheckIn: type: "boolean" VersionOriginalFilename: type: "string" VersionComment: type: "string" VersionExternalMetadata: type: "string" VersionNumber: "$ref": "#/components/schemas/dvVersionNumber" AppendToPrevious: type: "boolean" SessionGuid: type: "string" format: "uuid" SetVersionDeleteFlag: type: "object" properties: VersionId: type: "integer" format: "int32" ForceLastVersionDelete: type: "boolean" SessionGuid: type: "string" format: "uuid" SetVersionDeleteFlagResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetVersionFulltext: type: "object" properties: VersionId: type: "integer" format: "int32" Fulltext: type: "string" SessionGuid: type: "string" format: "uuid" SetVersionFulltextResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetVersionNumber: type: "object" properties: VersionId: type: "integer" format: "int32" VersionNumber: "$ref": "#/components/schemas/dvVersionNumber" SessionGuid: type: "string" format: "uuid" SetVersionNumberResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SetVersionResponse: type: "object" properties: DocUploadGuid: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" SingleBarcodeParserSettings: type: "object" properties: Name: type: "string" Description: type: "string" Enabled: type: "boolean" RecognitionBarcodeType: "$ref": "#/components/schemas/BarcodeType" BarcodeFieldName: type: "string" Pattern: type: "string" BarcodeScanDirection: "$ref": "#/components/schemas/ScanDirection" MarginTop: type: "integer" format: "int32" MarginLeft: type: "integer" format: "int32" MarginRight: type: "integer" format: "int32" MarginBottom: type: "integer" format: "int32" StartBackup: type: "object" properties: BackupInstruction: "$ref": "#/components/schemas/dvBackupInstruction" SessionGuid: type: "string" format: "uuid" StartBackupResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" StartRestore: type: "object" properties: BackupInstruction: "$ref": "#/components/schemas/dvBackupInstruction" SessionGuid: type: "string" format: "uuid" StartRestoreResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" StartWorkflow: type: "object" properties: WorkflowModelId: type: "integer" format: "int32" WorkflowObjects: type: "array" items: "$ref": "#/components/schemas/WorkflowObject" WorkflowValues: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" SkipStartingWhenRunningWorkflowExists: type: "boolean" OneWorkflowPerObject: type: "boolean" SessionGuid: type: "string" format: "uuid" StartWorkflowResponse: type: "object" properties: Workflow: allOf: - "$ref": "#/components/schemas/dtoWorkflow" description: "This field is obsolete, please use WorkflowsStarted instead." WorkflowsStarted: type: "array" items: "$ref": "#/components/schemas/dtoWorkflow" WorkflowsFailed: type: "array" items: "$ref": "#/components/schemas/WorkflowFailed" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" StopWorkflow: type: "object" properties: WorkflowId: type: "integer" format: "int32" description: "Id of the running workflow instance to be stopped. The caller of this operation needs to be owner of the specified workflow instance (the user who created it) or needs to be a member of the workflow admin role." TerminationComment: type: "string" description: "Optional comment that describes the reason for terminating this workflow instance. It will be stored in the workflow's log." WorkflowsToStop: type: "array" items: "$ref": "#/components/schemas/WorkflowToStop" description: "List of WorkflowObjects to Stop." SessionGuid: type: "string" format: "uuid" StopWorkflowResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" WorkflowIds: type: "array" items: type: "integer" format: "int32" WorkflowsFailedToStop: type: "array" items: "$ref": "#/components/schemas/WorkflowFailedToStop" TaskActionTemplate: type: "object" properties: TaskState: "$ref": "#/components/schemas/dvTaskState" Enabled: type: "boolean" ActionClass: type: "string" ActionConfig: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" StartConditionType: "$ref": "#/components/schemas/dvActionStartConditionType" StartCondition: type: "string" ActionDescription: type: "string" TaskDisplayOptions: type: "integer" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen numerisch (vermutlich Enumeration)." TaskLayout: type: "object" properties: Top: type: "integer" format: "int32" Left: type: "integer" format: "int32" TaskTemplate: type: "object" properties: TaskTemplateName: type: "string" TaskTemplateDisplayName: type: "string" TaskTemplateDescription: type: "string" TaskTemplateType: "$ref": "#/components/schemas/dvTaskTemplateTypes" TaskFormType: "$ref": "#/components/schemas/dvTaskFormTypes" TaskFormDefinition: type: "string" TaskAssignedToRoles: type: "string" TaskAssignedToUsersAndGroups: type: "string" TaskTransitions: type: "array" items: "$ref": "#/components/schemas/TaskTransitionTemplate" TaskActions: type: "array" items: "$ref": "#/components/schemas/TaskActionTemplate" TaskDelay: type: "integer" format: "int64" TaskDue: type: "integer" format: "int64" TaskReminder: type: "integer" format: "int64" TaskTimeout: type: "integer" format: "int64" DisplayOptions: "$ref": "#/components/schemas/TaskDisplayOptions" TemporaryAccessRights: type: "integer" format: "int32" TaskFormValidationScript: type: "string" PermanentAccessRights: type: "integer" format: "int32" TaskLayout: "$ref": "#/components/schemas/TaskLayout" LogTaskAssignmentToRoles: type: "boolean" LogTaskAssignmentToUsersAndGroups: type: "boolean" TaskFormHtml: type: "string" MultiUserTaskAbortResults: type: "array" items: type: "string" IsAutoTaskWaitForCompleteTask: type: "boolean" ImageSmall: type: "string" format: "byte" ImageMedium: type: "string" format: "byte" ImageLarge: type: "string" format: "byte" TaskDelayWorkDaySettings: "$ref": "#/components/schemas/WorkDaySettings" TaskDueWorkDaySettings: "$ref": "#/components/schemas/WorkDaySettings" TaskReminderWorkDaySettings: "$ref": "#/components/schemas/WorkDaySettings" TaskTimeoutWorkDaySettings: "$ref": "#/components/schemas/WorkDaySettings" TaskTransitionTemplate: type: "object" properties: IsDefaultTransition: type: "boolean" TaskResult: type: "string" DestinationTask: type: "string" ToggleTaskCheckoutState: type: "object" properties: Taskid: type: "integer" format: "int32" NewCheckoutState: "$ref": "#/components/schemas/dvTaskCheckoutState" SessionGuid: type: "string" format: "uuid" ToggleTaskCheckoutStateResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" TransferOldIndex: type: "object" properties: IndexRepositoryPath: type: "string" SessionGuid: type: "string" format: "uuid" TransferOldIndexResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" TwoFactorAuthenticationPluginConfigurationValue: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." Unlock: type: "object" properties: ObjectId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" UnlockResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" UpdateDatabase: type: "object" properties: SessionGuid: type: "string" format: "uuid" Language: type: "string" UpdateDatabaseResponse: type: "object" properties: ApiConnectionKey: type: "string" SystemPassword: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" UserLogin: type: "object" properties: SystemReferenceId: type: "integer" format: "int32" UserName: type: "string" UserPassword: type: "string" UserDomain: type: "string" PerformIntegratedUserLogin: type: "boolean" AuthenticationModuleConfigurationId: type: "integer" format: "int32" AuthenticationInformation: type: "array" items: "$ref": "#/components/schemas/AuthenticationInformationValue" LogoutExistingSession: type: "boolean" SessionType: type: "integer" format: "int32" UiCulture: type: "string" SessionGuid: type: "string" format: "uuid" DownloadDocumentIdentifier: type: "string" WaitForExternalLogin: type: "boolean" UserLoginResponse: type: "object" properties: Usersession: "$ref": "#/components/schemas/dtoUsersessions" DownloadDocumentIdentifier: type: "string" DownloadDocumentToken: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" UserLogout: type: "object" properties: SessionGuid: type: "string" format: "uuid" UserLogoutResponse: type: "object" properties: Success: type: "boolean" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Validate2FARequest: type: "object" properties: TwoFactorToken: type: "string" ValidationInformation: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" Validate2FARequestResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Web_BrandImage: type: "object" properties: Name: type: "string" Size: type: "integer" format: "int32" Language: type: "string" Web_BrandImageResponse: type: "object" properties: Options: type: "object" additionalProperties: type: "string" Web_GetFavorites: type: "object" properties: FavoriteItemId: type: "string" ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSort" SessionGuid: type: "string" format: "uuid" Web_GetFavoritesResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Web_GetMyWorkspace: type: "object" properties: WorkspaceItemId: type: "string" ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSort" SessionGuid: type: "string" format: "uuid" Context: "$ref": "#/components/schemas/dvRequestContext" Web_GetMyWorkspaceResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoObjectsBase" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Web_GetObjectTypeImage: type: "object" properties: Objecttypeid: type: "integer" format: "int32" Size: type: "string" AsLink: type: "boolean" SessionGuid: type: "string" format: "uuid" Web_GetObjectTypeImageResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Web_GetResources: type: "object" properties: Language: type: "string" IsMobile: type: "boolean" Refresh: type: "boolean" Web_GetResourcesResponse: type: "object" properties: ResourceDictionary: type: "object" additionalProperties: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Web_GetRightsGrid: type: "object" properties: ColumnFilter: type: "string" RowFilter: type: "string" SessionGuid: type: "string" format: "uuid" Web_GetRightsGridResponse: type: "object" properties: ColumnData: type: "array" items: "$ref": "#/components/schemas/RightsGridColumnDefinition" FieldData: type: "array" items: "$ref": "#/components/schemas/RightsGridFieldDefinition" Values: type: "array" items: "$ref": "#/components/schemas/RightsGridValue" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Web_GetSearchTree: type: "object" properties: UsersAndQueryItemId: type: "string" ResultSortConditions: type: "array" items: "$ref": "#/components/schemas/dvSort" SessionGuid: type: "string" format: "uuid" Web_GetSearchTreeResponse: type: "object" properties: UsersAndQueriesList: type: "array" items: "$ref": "#/components/schemas/dtoUsersandqueries" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Web_GetTaskTemplateImage: type: "object" properties: Workflowmodelid: type: "integer" format: "int32" Tasktemplate: type: "string" Size: type: "string" SessionGuid: type: "string" format: "uuid" Web_GetTaskTemplateImageResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Web_GetTransformedPreview: type: "object" properties: ObjectId: type: "integer" format: "int32" VersionId: type: "integer" format: "int32" FileContent: type: "string" SessionGuid: type: "string" format: "uuid" Context: "$ref": "#/components/schemas/dvRequestContext" Web_GetTransformedPreviewResponse: type: "object" properties: TransformedPreview: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Web_GetWorkflowCount: type: "object" properties: SessionGuid: type: "string" format: "uuid" description: "The session GUID identifying the current user session." UserId: type: "integer" format: "int32" description: "User id, to get count of workflows from the user" Web_GetWorkflowCountResponse: type: "object" properties: Counters: type: "object" additionalProperties: type: "integer" format: "int32" description: "Structure to report counters of workflows. MyWorkflow: All workflows related to the userID. RunningWorkflows: All Workflows that are currently running. RunningWorkflowsToday: All Workflows that are currently running and from today. RunningWorkflowsLastWeek(Last 7 Days):All Workflows that are currently running and from last 7 days. RunningWorkflowsLastMonth(Last 30 Days):All Workflows that are currently running and from last 30 days. WorkflowsWithErrors:All Workflows with errors." ResponseStatus: allOf: - "$ref": "#/components/schemas/ResponseStatus" description: "The status of the response, including error information if any." Web_Login: type: "object" properties: FilterByRegisteredSystem: type: "string" ObjectId: type: "string" TaskId: type: "string" WorkflowId: type: "string" Language: type: "string" SessionGuid: type: "string" format: "uuid" Web_LoginResponse: type: "object" properties: SystemsList: type: "array" items: "$ref": "#/components/schemas/dtoRegisteredsystems" MessageHeader: type: "string" ObjectId: type: "string" MessageText: type: "string" UrlPrefix: type: "string" Version: type: "string" Color1: type: "string" Color2: type: "string" Title: type: "string" Culture: type: "string" AllSystemsList: type: "array" items: "$ref": "#/components/schemas/dtoRegisteredsystems" ExternalDownload: type: "string" TaskId: type: "string" WorkflowId: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Web_Logout: type: "object" properties: FilterByRegisteredSystem: type: "string" Language: type: "string" SessionGuid: type: "string" format: "uuid" Web_LogoutResponse: type: "object" properties: System: "$ref": "#/components/schemas/dtoRegisteredsystems" MessageHeader: type: "string" MessageText: type: "string" UrlPrefix: type: "string" LoginUrl: type: "string" Color1: type: "string" Color2: type: "string" Title: type: "string" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" Web_TestConnection: type: "object" properties: FilterByRegisteredSystem: type: "string" Web_UpdateAccessRuleAssignments: type: "object" properties: AssignmentList: type: "array" items: "$ref": "#/components/schemas/dtoGroupsandrules" SessionGuid: type: "string" format: "uuid" Web_UpdateAccessRuleAssignmentsResponse: type: "object" properties: AssignmentList: type: "array" items: "$ref": "#/components/schemas/dtoGroupsandrules" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" WorkDaySettings: type: "object" properties: ActiveWorkDays: "$ref": "#/components/schemas/WorkflowWorkDays" ShiftToNextWorkdayFromWeekend: type: "boolean" WorkflowActionInfoAttribute: type: "object" properties: WorkflowActionClass: type: "string" WorkflowActionName: type: "string" WorkflowActionDescription: type: "string" WorkflowAdmin_DeleteWorkflowModel: type: "object" properties: WorkflowModelId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" WorkflowAdmin_DeleteWorkflowModelRegistrations: type: "object" properties: WorkflowModelRegistrationIds: type: "array" items: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" WorkflowAdmin_DeleteWorkflowModelRegistrationsResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" WorkflowAdmin_DeleteWorkflowModelResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" WorkflowAdmin_GetAvailableWorkflowActions: type: "object" properties: FilterByActionName: type: "string" SessionGuid: type: "string" format: "uuid" WorkflowAdmin_GetAvailableWorkflowActionsResponse: type: "object" properties: AvailableActionsList: type: "array" items: "$ref": "#/components/schemas/WorkflowActionInfoAttribute" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" WorkflowAdmin_GetWorkflowActionConfiguration: type: "object" properties: ActionClassName: type: "string" SessionGuid: type: "string" format: "uuid" WorkflowAdmin_GetWorkflowActionConfigurationResponse: type: "object" properties: PropertiesList: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" WorkflowAdmin_GetWorkflowModelEntries: type: "object" properties: FilterByWorkflowModelGuid: type: "string" FilterByWorkflowModelName: type: "string" FilterByWorkflowModelId: type: "integer" format: "int32" EnabledRecordsOnly: type: "boolean" SessionGuid: type: "string" format: "uuid" WorkflowAdmin_GetWorkflowModelEntriesResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoWorkflowmodel" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" WorkflowAdmin_GetWorkflowModelRegistrations: type: "object" properties: WorkflowModelIds: type: "array" items: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" WorkflowAdmin_GetWorkflowModelRegistrationsResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoWorkflowmodelregistration" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" WorkflowAdmin_GetWorkflowRolesGrid: type: "object" properties: ColumnFilter: type: "string" RowFilter: type: "string" AddedWorkflowRoles: type: "string" SessionGuid: type: "string" format: "uuid" WorkflowAdmin_GetWorkflowRolesGridResponse: type: "object" properties: ColumnData: type: "array" items: "$ref": "#/components/schemas/WorkflowRolesGridColumnDefinition" FieldData: type: "array" items: "$ref": "#/components/schemas/WorkflowRolesGridFieldDefinition" Values: type: "array" items: "$ref": "#/components/schemas/WorkflowRolesGridValue" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" WorkflowAdmin_GetWorkflowTemplate: type: "object" properties: WorkflowModelId: type: "integer" format: "int32" SessionGuid: type: "string" format: "uuid" WorkflowAdmin_GetWorkflowTemplateResponse: type: "object" properties: WorkflowTemplate: "$ref": "#/components/schemas/WorkflowTemplate" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" WorkflowAdmin_SetWorkflowModel: type: "object" properties: WorkflowModelEntry: "$ref": "#/components/schemas/dtoWorkflowmodel" WorkflowModel: "$ref": "#/components/schemas/WorkflowTemplate" SessionGuid: type: "string" format: "uuid" WorkflowAdmin_SetWorkflowModelRegistrations: type: "object" properties: WorkflowModelRegistrations: type: "array" items: "$ref": "#/components/schemas/dtoWorkflowmodelregistration" SessionGuid: type: "string" format: "uuid" WorkflowAdmin_SetWorkflowModelRegistrationsResponse: type: "object" properties: ResultList: type: "array" items: "$ref": "#/components/schemas/dtoWorkflowmodelregistration" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" WorkflowAdmin_SetWorkflowModelResponse: type: "object" properties: WorkflowModel: "$ref": "#/components/schemas/dtoWorkflowmodel" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" WorkflowAdmin_SetWorkflowRoleAssignments: type: "object" properties: AssignmentList: type: "array" items: "$ref": "#/components/schemas/WorkflowRoleAssignment" SessionGuid: type: "string" format: "uuid" WorkflowAdmin_SetWorkflowRoleAssignmentsResponse: type: "object" properties: ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" WorkflowAdmin_TestWorkDaySettings: type: "object" properties: TestStartDate: type: "string" format: "date-time" TestTicks: type: "integer" format: "int64" TestWorkDaySettings: "$ref": "#/components/schemas/WorkDaySettings" SessionGuid: type: "string" format: "uuid" WorkflowAdmin_TestWorkDaySettingsResponse: type: "object" properties: ResultDate: type: "string" format: "date-time" ResponseStatus: "$ref": "#/components/schemas/ResponseStatus" WorkflowFailed: type: "object" properties: Objectid: type: "integer" format: "int32" LogMessage: type: "string" Reason: "$ref": "#/components/schemas/WorkflowOperationResult" WorkflowFailedToStop: type: "object" properties: WorkflowId: type: "integer" format: "int32" LogMessage: type: "string" WorkflowObject: type: "object" properties: ObjectId: type: "integer" format: "int32" VersionId: type: "integer" format: "int32" WorkflowOperationResult: type: "string" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen als Zeichenkette (vermutlich Enumeration). Werteliste unbekannt." WorkflowRoleAssignment: type: "object" properties: User: "$ref": "#/components/schemas/dtoObjectsBase" Role: type: "string" Assigned: type: "integer" format: "int32" WorkflowRolesGridColumnDefinition: type: "object" properties: header: type: "string" width: type: "integer" format: "int32" dataIndex: type: "string" xtype: type: "string" WorkflowRolesGridFieldDefinition: type: "object" properties: name: type: "string" type: type: "string" WorkflowRolesGridValue: type: "object" properties: id: type: "string" text: type: "string" systemId: type: "integer" format: "int32" groupId: type: "integer" format: "int32" userId: type: "integer" format: "int32" name: type: "string" groupName: type: "string" iconCls: type: "string" values: type: "array" items: "$ref": "#/components/schemas/WorkflowRoleAssignment" WorkflowTemplate: type: "object" properties: TaskTemplates: type: "array" items: "$ref": "#/components/schemas/TaskTemplate" WorkflowValueList: type: "array" items: "$ref": "#/components/schemas/dvObjectProperty" WorkflowValueFormValidationScript: type: "string" WorkflowWorkDaySettings: "$ref": "#/components/schemas/WorkDaySettings" GlobalWorkflowActions: type: "array" items: "$ref": "#/components/schemas/TaskActionTemplate" WorkflowToStop: type: "object" properties: WorkflowId: type: "integer" format: "int32" TerminationComment: type: "string" WorkflowWorkDays: type: "integer" description: "In der Quelle nicht dokumentierter Typ; in den Beispielen numerisch (vermutlich Enumeration)."