Freigegeben: JSON-Repräsentation

In diesem Kapitel erfahren Sie, wie Sie die Notizen eines DMS-Objektes abrufen und speichern können.

Um die Notizen eines DMS-Objektes abzurufen oder zu speichern, müssen Sie folgende Schritte durchführen:

Ermitteln der URL zu einem Repository

Im Kapitel Ermitteln eines Repositorys können Sie nachlesen, wie Sie die URL zu einem Repository ermitteln.

Ermitteln und Aufrufen der Linkrelation zum Abrufen der Details eines DMS-Objektes

Im Kapitel Abrufen und Anzeigen von Details eines DMS-Objektes können Sie nachlesen, wie Sie die URL zum Abrufen der Details eines DMS-Objektes ermitteln und aufrufen.

Ermitteln der Linkrelation zum Abrufen der Notizen eines DMS-Objektes

Das JSON-Objekt zu den Details eines DMS-Objektes enthält die Linkrelation notes , mit deren Hilfe Sie die Notizen des DMS-Objektes abrufen können.

Response

{
  "_links": {    
         "notes":{
           "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123/n"
         }
  },
  "id": "D000000123"  
}

Abrufen der Notizen eines DMS-Objektes

Rufen Sie die Notizen des DMS-Objektes mit der zuvor ermittelten URL wie folgt ab:

Request

GET https://host/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123/n HTTP/1.1
Accept: application/hal+json

Sie erhalten als Antwort das Objekt mit den Notizen des DMS-Objektes:

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "_links": {
        "self": {
            "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123/n"
        }
    },
    "notes":[{
            "creator" : {
                "id": "MargaS"
                "displayName": "Marga Schilling"
            },
            "text": "This is a sample text."
            "created": "2019-09-03T09:09:09.453+02:00"
        }
    ]
}

Struktur eines Notizelementes

Struktur eines Erstellerobjektes

Speichern der Notizen eines DMS-Objektes

Mit einer HTTP POST -Anforderung für die zuvor ermittelte URL können Sie eine Notiz zu einem DMS-Objekt erstellen. Wenn Sie mehrere Notizen erstellen möchten, wiederholen Sie den Vorgang. Speichern Sie eine Notiz wie folgt ab:

Request

POST https://host/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123/n HTTP/1.1
Content-Type: application/json
Content-Length: 42

{
    "text": "This is a sample text."
}

Response

HTTP/1.1 200 OK

Struktur des Notizelementes