Dokumente ändern

Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren.

Dateien übertragen

Hinweise zur Funktion

Die "ExternalDocumentId" erlaubt es Ihnen, Ihre eigene ID an das Dokument zu übertragen und nachzuverfolgen.

Die "EntityId" ist die ID des Datensatzes der jeweiligen Entität, für die ein Dokument hochgeladen werden soll (Beispielsweise die ID einer einzelnen Rechnung wenn man über den "EntityName" Pfad "InvoiceReceipt" eine Rechnung übermittelt).

Im Schlüssel "Contents" können Sie die Base64-encodierten Binärdaten hinterlegen. Der Upload ist auf eine Payload-Größe von 10 MB beschränkt.

Der SHA1-Hashkey wird aus den nicht-encodierten Binärdaten errechnet und soll die Datenintegrität nach der Decodierung in unserem System gewährleisten. Stimmt der Hashkey nicht überein, wird die Datei nicht gespeichert.

Weitere Informationen zur Encodierung und zum Hashkey erhalten Sie auf der Seite "Dokumente und Medien".

Die Funktionen "externe Dokumenten-Links speichern" und "externe Dokumenten-ID setzen" stehen Ihnen nicht zur Verfügung, wenn der Kunde bereits das WOWIPORT-DMS nutzt. Da die Testinstanz der OPEN WOWI über ein externes DMS verfügt, können die API-Endpunkte hier nicht getestet werden.

Die Speicherung von neuen Dateien ist auch mit einem WOWIPORT-DMS möglich. Wir empfehlen jedoch, diese Dateien direkt im WOWIPORT-DMS zu speichern.

Weitere Informationen zur Schnittstelle des WOWIPORT-DMS finden Sie bei unserem Partner d.velop.

Version 1.2

---

post

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

entityNamestringErforderlich

Abfrageparameter

apiKeystringOptional

Rumpf

application/jsontext/jsonapplication/*+json

Filenamestring · nullfähigOptional

CreationDatestring · date-timeOptional

ExternalDocumentIdstring · nullfähigOptional

FileTypeIdinteger · int32Optional

DataPrivacyCategoryIdinteger · int32Optional

EntityIdinteger · int32Optional

Contentsstring · byte · nullfähigOptional

Sha1Hashstring · nullfähigOptional

Antworten

201

Created

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

post

/openwowi/v1.2/DocumentEdit/{entityName}/File

HTTPcURLJavaScriptPython

POST /openwowi/v1.2/DocumentEdit/{entityName}/File HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "Filename": "text",
  "CreationDate": "2026-03-11T00:38:06.232Z",
  "ExternalDocumentId": "text",
  "FileTypeId": 1,
  "DataPrivacyCategoryId": 1,
  "EntityId": 1,
  "Contents": "Ynl0ZXM=",
  "Sha1Hash": "text"
}

application/jsontext/jsonapplication/*+json

{
  "Id": 1,
  "FileGuid": "123e4567-e89b-12d3-a456-426614174000",
  "FileName": "text",
  "EntityName": "text",
  "ExternalDocumentId": "text",
  "Sha1HashKey": "text",
  "CreationDate": "2026-03-11",
  "Entity": {
    "Id": 1,
    "IdNum": "text"
  },
  "FileType": {
    "Id": 1,
    "Name": "text"
  },
  "DataPrivacyCategory": {
    "Id": 1,
    "Name": "text"
  }
}

---

Externe Dokumenten-ID setzen

Hinweise zur Funktion

Nach dem Abruf einer Datei und der Speicherung in einem externen DMS können Sie Ihre eigene ID an unser Dokument übergeben, um dieses erneut identifizieren zu können. Die "ExternalDocumentId" wird am Dokumentencontainer und nicht an der einzelnen Revision gespeichert. Wir empfehlen deshalb, die Nummer der Dokumentenrevision ebenfalls zu speichern, damit Sie Folge-Revisionen identifizieren können.

Version 1.2

---

put

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

entityNamestringErforderlich

fileGuidstring · uuidErforderlich

Abfrageparameter

apiKeystringErforderlich

showNullValuesbooleanOptionalDefault: false

Rumpf

application/jsontext/jsonapplication/*+json

ExternalDocumentIdstring · nullfähigOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

FileGuidstring · uuidOptional

FileNamestring · nullfähigOptional

EntityNamestring · nullfähigOptional

ExternalDocumentIdstring · nullfähigOptional

Sha1HashKeystring · nullfähigOptional

CreationDatestring · date · nullfähigOptionalExample: 2026-03-11Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

put

/openwowi/v1.2/DocumentEdit/{entityName}/FileData/{fileGuid}/SetExternalDocumentId

HTTPcURLJavaScriptPython

PUT /openwowi/v1.2/DocumentEdit/{entityName}/FileData/{fileGuid}/SetExternalDocumentId?apiKey=text HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "ExternalDocumentId": "text"
}

application/jsontext/jsonapplication/*+json

{
  "Id": 1,
  "FileGuid": "123e4567-e89b-12d3-a456-426614174000",
  "FileName": "text",
  "EntityName": "text",
  "ExternalDocumentId": "text",
  "Sha1HashKey": "text",
  "CreationDate": "2026-03-11",
  "Entity": {
    "Id": 1,
    "IdNum": "text"
  },
  "FileType": {
    "Id": 1,
    "Name": "text"
  },
  "DataPrivacyCategory": {
    "Id": 1,
    "Name": "text"
  },
  "Document": {
    "Id": 1,
    "LatestRevision": 1,
    "DocumentDate": "2026-03-11T00:38:06.232Z",
    "OriginalDocumentName": "text",
    "DocumentName": "text",
    "Template": {
      "Id": 1,
      "Name": "text",
      "FileEntity": {
        "Id": 1,
        "Name": "text"
      }
    },
    "File2Name": "text",
    "File2Guid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "DocumentRevisions": [
    {
      "Id": 1,
      "Revision": 1,
      "FileName1": "text",
      "FileName2": "text",
      "FileGuid1": "123e4567-e89b-12d3-a456-426614174000",
      "FileGuid2": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

---

Externe Dokumenten-Links speichern

Um Ihren Kunden die Möglichkeit zu geben, direkt aus WOWIPORT in die korrekten Dateien in einem externen DMS abzuspringen, bieten wir die Möglichkeit, einen neuen Tab "Externes DMS" in WOWIPORT anzulegen. In diesem Tab können Sie Links zu allen relevanten Dokumenten hinterlegen.

Die Freischaltung dieses Tabs erfolgt über die API Key Konfiguration (siehe letzte Checkbox unterhalb der Endpunktberechtigungen in der Beschreibung zur API Key Einrichtung).

Bitte beachten Sie, dass diese Links nur über die API verwaltet werden können. Der Nutzer hat in der UI keine Möglichkeit zur Verwaltung der Links. Die Wartung der Links obliegt dem API-Nutzer.

Bitte beachten Sie, dass diese Funktion nicht für Kunden mit einem WOWIPORT DMS zur Verfügung stehen.

Externen Link anlegen

Version 1.2

---

post

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

entityNamestringErforderlich

Abfrageparameter

apiKeystringOptional

Rumpf

application/jsontext/jsonapplication/*+json

Filenamestring · nullfähigOptional

FileDatestring · date-timeOptional

ExternalLinkstring · nullfähigOptional

ExternalDocumentIdstring · nullfähigOptional

EntityIdinteger · int32Optional

Antworten

201

Created

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

post

/openwowi/v1.2/DocumentEdit/{entityName}/ExternalDocumentLink

HTTPcURLJavaScriptPython

POST /openwowi/v1.2/DocumentEdit/{entityName}/ExternalDocumentLink HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "Filename": "text",
  "FileDate": "2026-03-11T00:38:06.232Z",
  "ExternalLink": "text",
  "ExternalDocumentId": "text",
  "EntityId": 1
}

application/jsontext/jsonapplication/*+json

{
  "ExternalDocumentLinkId": 1,
  "EntityId": 1
}

---

Externen Link bearbeiten

Version 1.2

---

put

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

entityNamestringErforderlich

externalDocumentLinkIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Rumpf

application/jsontext/jsonapplication/*+json

Filenamestring · nullfähigOptional

FileDatestring · date-timeOptional

ExternalLinkstring · nullfähigOptional

ExternalDocumentIdstring · nullfähigOptional

EntityIdinteger · int32Optional

Antworten

200

OK

text/plainapplication/jsontext/json

ExternalDocumentLinkIdinteger · int32Optional

EntityIdinteger · int32Optional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

put

/openwowi/v1.2/DocumentEdit/{entityName}/ExternalDocumentLink/{externalDocumentLinkId}

HTTPcURLJavaScriptPython

PUT /openwowi/v1.2/DocumentEdit/{entityName}/ExternalDocumentLink/{externalDocumentLinkId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "Filename": "text",
  "FileDate": "2026-03-11T00:38:06.232Z",
  "ExternalLink": "text",
  "ExternalDocumentId": "text",
  "EntityId": 1
}

application/jsontext/jsonapplication/*+json

{
  "ExternalDocumentLinkId": 1,
  "EntityId": 1
}

---

Externen Link löschen

Version 1.2

---

delete

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

entityNamestringErforderlich

externalDocumentLinkIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Antworten

200

OK

text/plainapplication/jsontext/json

ExternalDocumentLinkIdinteger · int32Optional

EntityIdinteger · int32Optional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

delete

/openwowi/v1.2/DocumentEdit/{entityName}/ExternalDocumentLink/{externalDocumentLinkId}

HTTPcURLJavaScriptPython

DELETE /openwowi/v1.2/DocumentEdit/{entityName}/ExternalDocumentLink/{externalDocumentLinkId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "ExternalDocumentLinkId": 1,
  "EntityId": 1
}

---