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

Authorizations

Path parameters

entityNamestringRequired

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

fileIdinteger · int32Optional

documentIdinteger · int32Optional

fileGuidstring · uuidOptional

entityIdinteger · int32Optional

includeRevisionbooleanOptionalDefault: false

showNullValuesbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/DocumentRead/{entityName}/FileData HTTP/1.1
Host: 
Accept: */*

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

Authorizations

Path parameters

entityNamestringRequired

fileGuidstring · uuidRequired

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

Responsestring · byte

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/DocumentRead/{entityName}/FileContent/{fileGuid} HTTP/1.1
Host: 
Accept: */*

Ynl0ZXM=

---

Dokumentenvorlagen abrufen

Version 1.2

---

get

Authorizations

Path parameters

entityNamestringRequired

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

fileTypeIdinteger · int32Optional

documentTemplateIdinteger · int32Optional

documentTemplateNamestringOptional

showNullValuesbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/DocumentRead/{entityName}/DocumentTemplate HTTP/1.1
Host: 
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "TemplateEntity": {
      "Id": 1,
      "Name": "text",
      "Prefix": "text",
      "FileEntity": {
        "Id": 1,
        "Name": "text"
      }
    },
    "NodeId": 1,
    "Remark": "text",
    "CreationDate": "2025-05-12",
    "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

Authorizations

Path parameters

entityNamestringRequired

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

entityIdinteger · int32Optional

externalDocumentLinkIdinteger · int32Optional

showNullValuesbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/DocumentRead/{entityName}/ExternalDocumentLinks HTTP/1.1
Host: 
Accept: */*

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

---