Dokumente lesen

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

Metadaten zum Dokument abrufen

Hinweise zur Funktion

Den "entityName" können Sie dem Katalog "FileEntity" entnehmen.

WOWIPORT-Dokumente können unter Umständen unterschiedliche Revisionen beinhalten.

Das Dokument (Node "Document") dient dabei als Container für die Revisionen. Wenn Sie vorherige Revisionen abrufen möchten, benötigen Sie den Parameter "IncludeRevision". Die FileGuid kann zwei Ausprägungen haben, welche jeweils entweder das PDF-Dokument oder das Word-Dokument repräsentieren.

Die letzte Revision ist in der Top-Node als "FileGuid" hinterlegt. Beinhaltet die letzte Revision ein Word- und ein PDF-Dokument, finden Sie dort das PDF-Dokument.

Hochgeladene Dateien haben keinen Dokumentencontainer und keine Revisionen.

Version 1.2

---

GET/openwowi/v1.2/DocumentRead/{entityName}/FileData

Authorization

Authorization

Path parameters

entityName*string

Query parameters

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/DocumentRead/{entityName}/FileData', {
    method: 'GET',
    headers: {},
});
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:04:19.551Z",
      "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"
      }
    ]
  }
]

---

Binärdatei abrufen

Hinweise zur Funktion

Die Daten werden über die entsprechende FileGuid abgerufen. Für die Übertragung wurden die Dateien nach dem Base64-Verfahren encodiert. Weitere Informationen finden Sie auf der Seite "Dokumente und Medien".

Version 1.2

---

GET/openwowi/v1.2/DocumentRead/{entityName}/FileContent/{fileGuid}

Authorization

Authorization

Path parameters

entityName*string

fileGuid*string (uuid)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

string (byte)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/DocumentRead/{entityName}/FileContent/{fileGuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

text

---

Dokumentenvorlagen abrufen

Version 1.2

---

GET/openwowi/v1.2/DocumentRead/{entityName}/DocumentTemplate

Authorization

Authorization

Path parameters

entityName*string

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

Namenullable string

TemplateEntitynullable all of

NodeIdinteger (int32)

Remarknullable string

CreationDatestring (date)

Example: "2025-02-05"

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

EntityNamenullable string

FileTypenullable all of

DataPrivacyCategorynullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/DocumentRead/{entityName}/DocumentTemplate', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "Id": 1,
    "Name": "text",
    "TemplateEntity": {
      "Id": 1,
      "Name": "text",
      "Prefix": "text",
      "FileEntity": {
        "Id": 1,
        "Name": "text"
      }
    },
    "NodeId": 1,
    "Remark": "text",
    "CreationDate": "2025-02-05",
    "EntityName": "text",
    "FileType": {
      "Id": 1,
      "Name": "text",
      "Classification": {
        "Id": 1,
        "Name": "text"
      }
    },
    "DataPrivacyCategory": {
      "Id": 1,
      "Name": "text"
    }
  }
]

---

Externe Dokumenten-Links abrufen

Version 1.2

---

GET/openwowi/v1.2/DocumentRead/{entityName}/ExternalDocumentLinks

Authorization

Authorization

Path parameters

entityName*string

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

Filenamenullable string

FileDatestring (date)

Example: "2025-02-05"

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

ExternalDocumentIdnullable string

ExternalLinknullable string

Entitynullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/DocumentRead/{entityName}/ExternalDocumentLinks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "Id": 1,
    "Filename": "text",
    "FileDate": "2025-02-05",
    "ExternalDocumentId": "text",
    "ExternalLink": "text",
    "Entity": {
      "EntityId": 1,
      "EntityName": "text",
      "EntityIdNum": "text"
    }
  }
]

---