Dokumente: Dokument hochladen [POST] - REST API

Beschreibung

Der Antrag ermöglicht das Hochladen eines neuen Dokuments in die angegebene Drop Zone.
Es ist nur ein direkter Upload möglich, ein Verweis auf den übergeordneten Unterlagen/Dokumentenbereich wird nicht unterstützt.

Anfrage URL

{SERVER_BASE_URL}/rest/api/antraege/Dokument_hochladen

Headers

Accept: application/json

Request body

• Unterlage
  Hochzuladende Datei
• Antrags_ID
  ID des Antrags
• Unterlagen_Sektion_Code
  ID der Drop-Zone, in die das neue Dokument hochgeladen werden soll
• RevisionsKommentare
  Kommentar zur hochgeladenen Revision

Beispiel

Unterlage: "Anlage A10-Angaben zur Containerbeladung.pdf"
Antrags_ID: "ORG-24-001"
Unterlagen_Sektion_Code: "UNTERLAGEN_ZU_ABFAELLEN"
RevisionsKommentare: "AGD - Angaben zum KC 1, KC 2, KC3 und KC4 der Charge 1 (beladen mit 200-l-Fässern)"

Antworten

Success

{
"SUCCESS": "1",
"TYP": "DateiUploadErfolgreich",
"ERGEBNIS_INFO": {
    "HOCHGELADEN_AM": "2024-02-01 12:57:20",
    "REVISIONSKOMMENTARE": "AGD - Angaben zum KC 1, KC 2, KC3 und KC4 der Charge 1 (beladen mit 200-l-Fässern)",
    "HOCHGELADEN_VON": "Mustermann, Max",
    "NWL_DOKUMENT_REVISION_ID": "NWL_D_12415791",
    "DATEINAME": "Anlage A10-Angaben zur Containerbeladung.pdf",
    "REVISION_ID": "6D01E713-F1DF-4A22-8547-1F5B272E9F95",
    "REVISION_NR": 1,
    "DOKUMENT_ID": "6D01E668-F7F6-40B8-438F-27A956899E56"
},
"DETAIL": "Datei erfolgreich hochgeladen."
}

Fehler

{
    "RESPONSE_CODE": "G400.013",
    "SUCCESS": "0",
    "TYP": "DateiUploadFehler",
    "DETAIL": "Die Datei \"Anlage A10-Angaben zur Containerbeladung\" mit dem gleichen Namen ist bereits an der folgenden Stelle angehängt: Unterlagen zu Abfällen."
}

 

Beispiel für das Senden einer Anfrage mit der Postman-Software

 

Beispiel für die Referenzierung der Dokumentrevision in Antragsfeldern

Fall: Funktion [POST] Antrag aktualisieren
Verwenden Sie das Tag <a href="">...</a>, wobei „href“ wie folgt definiert ist: "/index.cfm/fo/REVISION_ID". Verwenden Sie „REVISION_ID“ aus der Antwort als Dateikennung.
Beispiel: Antrag Angaben - Rich-Text-Felder, Feld "Nachweis / Angaben zum Aktivitätsinventar der Abfälle".

....
"NACHWEIS_ZUM_AKTIVITAETSINVENTAR": 
'Für Detailangaben siehe AGD - Datei <a href="/index.cfm/fo/6D01E713-F1DF-4A22-8547-1F5B272E9F95" rel="noopener" target="_blank">Anlage A10-Angaben zur Containerbeladung, Revision: 1 /NWL_D_12415791/</a>.'
....