ObjDefService (/objdef)
- Team Dodo
- Technische Redaktion
/osrest/api/objdef/global
Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON
Diese Methode liefert die komplette globale Objektdefinition als JSON zurück. Das Ergebnis kann auch Teile der Objektdefinition beinhalten, die der Benutzer nicht sehen darf. Alle verlinkten Listen werden aufgelöst und zu normalen Listen umgeformt. Je nach Größe kann das Ergebnis recht umfangreich sein. Der Aufbau ist äquivalent zur XML, lediglich als JSON transformiert.
Es kann ein If-Modified-Since Header bei der Anfrage mitgeliefert werden. Ist die serverseitige Objektdefinition nicht neuer als das Datum+Uhrzeit im Header, so wird nur ein HTTP/304 Not Modified zurückgegeben. Dies signalisiert dem Client auf schnelle Weise, dass er seine gecachte Objektdefinition verwenden kann.
/osrest/api/objdef/full
Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON
Diese Methode liefert den kompletten Teil der Objektdefinition als JSON zurück, den der Benutzer sehen darf. Je nach Größe kann der Aufruf etwas dauern und das Ergebnis recht umfangreich sein. Der Aufbau ist äquivalent zur XML, lediglich als JSON transformiert.
/osrest/api/objdef/languages
Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON
Diese Methode liefert die in der Objektdefinition definierten Sprachen als JSON zurück. Je nach Größe kann der Aufruf etwas dauern und das Ergebnis recht umfangreich sein. Der Aufbau ist äquivalent zur XML, lediglich als JSON transformiert.
/osrest/api/objdef/search/[id]
Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON
Diese Methode erwartet eine Objekttyp-ID von einem Ordner, Register oder Dokument und liefert diesen Teil der Objektdefinition als JSON formatiert zurück und der Aufbau des JSON ist äquivalent zur XML.
Parameter:
id: ObjectTypeID des Objekts
Optionale Parameter:
refresh: ruft die Objektdefinition neu ab
JSON Content
{
"object": {
"IconID": "1073742179",
"compressionflags": "0",
"cotype": "55",
"extablename": "",
"fields": {"field": [
{
"classstring": "",
"field_pos": {
"bottom": "398",
"left": "286",
"right": "229",
"top": "26"
},
.../osrest/api/objdef/search
Unterstützte Anfragemethoden: POST
Unterstützte Ergebnisformate: JSON
Diese Methode erwartet eine oder mehrere Objekttyp-ID von einem Ordner, Register oder Dokument und liefert diese Teile der Objektdefinition als JSON formatiert zurück. Der Aufbau des JSON ist äquivalent zur XML.
Optionale Parameter:
refresh: ruft die Objektdefinition neu ab
POST Beispiel [
{ "id": 22 }, { "id": "413" }, ...
]
|
Ergebnis {
"objectTypes": [
{
"internal": "addresses",
"cotype": "2",
...
},
...
]
}
|
|---|