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.

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/openwowi/v1.2/DocumentEdit/{entityName}/File

Authorization

Authorization

Path parameters

entityName*string

Query parameters

Body

application/jsontext/jsonapplication/*+json

Filenamenullable string

CreationDatestring (date-time)

ExternalDocumentIdnullable string

FileTypeIdinteger (int32)

DataPrivacyCategoryIdinteger (int32)

EntityIdinteger (int32)

Contentsnullable string (byte)

Sha1Hashnullable string

Response

201400401

Created

Body

text/plainapplication/jsontext/json

Idinteger (int32)

FileGuidstring (uuid)

FileNamenullable string

EntityNamenullable string

ExternalDocumentIdnullable string

Sha1HashKeynullable string

CreationDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

Entitynullable all of

FileTypenullable all of

DataPrivacyCategorynullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/DocumentEdit/{entityName}/File', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400

{
  "Id": 1,
  "FileGuid": "123e4567-e89b-12d3-a456-426614174000",
  "FileName": "text",
  "EntityName": "text",
  "ExternalDocumentId": "text",
  "Sha1HashKey": "text",
  "CreationDate": "2025-02-05",
  "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/openwowi/v1.2/DocumentEdit/{entityName}/FileData/{fileGuid}/SetExternalDocumentId

Authorization

Authorization

Path parameters

entityName*string

fileGuid*string (uuid)

Query parameters

Body

application/jsontext/jsonapplication/*+json

ExternalDocumentIdnullable string

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

FileGuidstring (uuid)

FileNamenullable string

EntityNamenullable string

ExternalDocumentIdnullable string

Sha1HashKeynullable string

CreationDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

Entitynullable all of

FileTypenullable all of

DataPrivacyCategorynullable all of

Documentnullable all of

DocumentRevisionsnullable array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/DocumentEdit/{entityName}/FileData/{fileGuid}/SetExternalDocumentId?apiKey=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "Id": 1,
  "FileGuid": "123e4567-e89b-12d3-a456-426614174000",
  "FileName": "text",
  "EntityName": "text",
  "ExternalDocumentId": "text",
  "Sha1HashKey": "text",
  "CreationDate": "2025-02-05",
  "Entity": {
    "Id": 1,
    "IdNum": "text"
  },
  "FileType": {
    "Id": 1,
    "Name": "text"
  },
  "DataPrivacyCategory": {
    "Id": 1,
    "Name": "text"
  },
  "Document": {
    "Id": 1,
    "LatestRevision": 1,
    "DocumentDate": "2025-02-05T04:09:01.875Z",
    "OriginalDocumentName": "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.

Externen Link anlegen

Version 1.2

---

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

Authorization

Authorization

Path parameters

entityName*string

Query parameters

Body

application/jsontext/jsonapplication/*+json

Filenamenullable string

FileDatestring (date-time)

ExternalLinknullable string

ExternalDocumentIdnullable string

EntityIdinteger (int32)

Response

201400401

Created

Body

text/plainapplication/jsontext/json

ExternalDocumentLinkIdinteger (int32)

EntityIdinteger (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/DocumentEdit/{entityName}/ExternalDocumentLink', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400

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

---

Externen Link bearbeiten

Version 1.2

---

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

Authorization

Authorization

Path parameters

entityName*string

externalDocumentLinkId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

Filenamenullable string

FileDatestring (date-time)

ExternalLinknullable string

ExternalDocumentIdnullable string

EntityIdinteger (int32)

Response

200400401

OK

Body

text/plainapplication/jsontext/json

ExternalDocumentLinkIdinteger (int32)

EntityIdinteger (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/DocumentEdit/{entityName}/ExternalDocumentLink/{externalDocumentLinkId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

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

---

Externen Link löschen

Version 1.2

---

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

Authorization

Authorization

Path parameters

entityName*string

externalDocumentLinkId*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

ExternalDocumentLinkIdinteger (int32)

EntityIdinteger (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/DocumentEdit/{entityName}/ExternalDocumentLink/{externalDocumentLinkId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

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

---