storage.rest.api - Patch document

Owned by Development (Unlicensed)
Sept. 28, 2021
1 min read

PATCH

http://{{host}}:{{port}}/storage/rest/api/Repositories('{{repository}}')/Documents('{{document_uuid}}')?SessionToken={{SessionToken}}

Beschreibung

Ändert ein bestehendes Dokument mit der ID {{document_uuid}} im Repository {{repository}} auf dem CONTENT SERVER mit dem übergebenen JSON-Daten. Rückgabe des kompletten geänderten Dokuments als JSON Struktur. Im Gegensatz zu Change document (PUT) werden nur die übergebenen Daten geändert bzw. hinzugefügt. Bestehende Daten bleiben unverändert.

Parameter

NameWertBeschreibung

Url

SessionToken{{SessionToken}}Session Token aus Authenticate request

Request Header

Content-Typeapplication/json
If-Match{{ifmatch_token}}Der {{ifmatch_token}} entspricht dem bei einer Abfrage eine Dokuments erhaltenen OData @etag und muss bei einer Änderung eines Dokuments im If-Match Request Header übergeben werden. Damit ist sichergestellt, dass sich das Dokument seit dem Empfang nicht aus einer anderen Quelle geändert hat.

Response Header

Content-Typeapplication/json; odata.metadata=minimal; odata.streaming=false; IEEE754Compatible=false; charset=UTF-8

Body

Das zu ändernde Dokument muss als gültige JSON-Struktur im <body> mitgegeben werden. 

Der folgende Beispiel body als JSON ändert ein in Create document erstelltes Dokument. Auch unveränderte Daten werden bei der Rückgabe im komplette Dokument geliefert.


Example Request

curl --location --request PATCH "http://localhost:4680/storage/rest/api/Repositories('REPO')/Documents('257ABB4EA56843A4B68594E86E0754B1')?SessionToken=8E96F313F3894D5BA1EF54332979B1F7" \
  --header "Content-Type: application/json" \
  --data-raw '{
    "_subject": "This is a patched subject",
    "_doctype": "order",
    "myattr": "test",
    "_fields": {
        "Checkbox" : {
            "_name" : "Checkbox",
            "_datatype" : "BOOLEAN",
            "_value" : true
        }
    }
}'

Example Response