GET api/Documents?STID={STID}&AGID={AGID}&PersID={PersID}&GFID={GFID}&SUCHTEXT={SUCHTEXT}&MaxCount={MaxCount}&offset={offset}

Request Information

URI Parameters

Name	Type	Additional information
STID	integer	Default value is 0
AGID	integer	Default value is 0
PersID	integer	Default value is 0
GFID	integer	Default value is 0
SUCHTEXT	string	Default value is
MaxCount	integer	Default value is 100
offset	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

DocSearchMetadataObject

Name	Type	Additional information
id	string	None.
error	boolean	None.
status_code	integer	None.
documents	Collection of DocumentMetadata	None.

Response Formats

application/json, text/json

Sample:

{
  "id": "sample string 1",
  "error": true,
  "status_code": 3,
  "documents": [
    {
      "DocID": "sample string 1",
      "ArcID": 2,
      "Ausblenden": true,
      "STID": 4,
      "AGID": 5,
      "PersID": 6,
      "GFID": 7,
      "Stichtag": "2025-06-06T12:30:40.1108675+02:00",
      "Titel": "sample string 8",
      "Dokumententyp": "sample string 9",
      "GFName": "sample string 10",
      "Bemerkung": "sample string 11",
      "Archivdatum": "2025-06-06T12:30:40.1108675+02:00",
      "Archivbenutzer": "sample string 12",
      "DocIDZusatz": 13,
      "Extension": "sample string 14",
      "Filename": "sample string 15",
      "Web": true,
      "CustomMetaData": [
        {
          "Feld": "sample string 1",
          "Wert": "sample string 2"
        },
        {
          "Feld": "sample string 1",
          "Wert": "sample string 2"
        }
      ]
    },
    {
      "DocID": "sample string 1",
      "ArcID": 2,
      "Ausblenden": true,
      "STID": 4,
      "AGID": 5,
      "PersID": 6,
      "GFID": 7,
      "Stichtag": "2025-06-06T12:30:40.1108675+02:00",
      "Titel": "sample string 8",
      "Dokumententyp": "sample string 9",
      "GFName": "sample string 10",
      "Bemerkung": "sample string 11",
      "Archivdatum": "2025-06-06T12:30:40.1108675+02:00",
      "Archivbenutzer": "sample string 12",
      "DocIDZusatz": 13,
      "Extension": "sample string 14",
      "Filename": "sample string 15",
      "Web": true,
      "CustomMetaData": [
        {
          "Feld": "sample string 1",
          "Wert": "sample string 2"
        },
        {
          "Feld": "sample string 1",
          "Wert": "sample string 2"
        }
      ]
    }
  ]
}