/
[GET] /native

[GET] /native

/api/dms/schema/native

Description

Return the complete object definition and not only the part the current user is allowed to see in the native format, but in JSON formatted.
A user can send an If-None-Match Header in which the date of his object definition is included. In case the server does not have a more current object definition, it returns a HTTP 304 not modified. This saves bandwidth.

Request
Method

GET

Request optional Header

  • If-None-Match (String): Base64 string of the lastModificationDate from the JSON result to optimize the result payload. (Since Version 6.2.0)

Response
Format

JSON

Minimum Version

3.0.0

Changelog

  • 6.2.0: If-None-Match Header introduced.

Request
Example

/api/dms/schema/native

Result
Example

The asobjdef.xml file from the etc server directory transformed into JSON with all its information.

{ "asobjdef": { "images": "", "languages": { "language": [{ "name": "German", "lang_id": 7, "active": 2 },{ "name": "English", "lang_id": 9, "active": 1 }] }, "created": "2019-09-24T12:39:53", "limited_objects": 1, "version": "5.20", "OS4x": "", "cabinet": [{ "internal": "Kunde", "cotype": 17, "name": "Kunde", "object": [{ "internal": "Kunde", "cotype": 17, "limited_objects": { "limited_object": [{ "count": 3, "type": 262179 }, { "count": 3, "type": 393222 }] }, "multiframe": { "width": 0, "height": 0 }, "extablename": "", "IconID": 0, "compressionflags": 0, "names": { "name": [{ "imageid": "", "newurl": "", "readonlyurl": "", "requesturl": "", "updateurl": "", "tooltip": "", "lang_id": 7, "defaulturl": "", "content": "Kunde" }, { "imageid": "", "newurl": "", "readonlyurl": "", "requesturl": "", "updateurl": "", "tooltip": "", "lang_id": 9, "defaulturl": "", "content": "Customer" }] }, "no_dias": 1, "name": "Kunde", "os_guid": "860C29BA2D404D4684B2168EE51E3DDC", "historyflags": 0, "fulltext": 1, "ids": { "vid": 0, "pid": 0, "oid": 17 }, "tablename": "stamm18", "fields": { "field": [{ "init": "", "field_pos": { "top": 10, "left": 5, "bottom": 12, "right": 55 }, "internal": "Kundenname", "searchgroupname": "", "taborder": 0, "tooltip": "|", "flags": { "dt": "X", "flags2": 536870912, "flags1": 1048576, "flags": 4194304, "input_length": 50, "align": "left" }, "regularexpression": "", "prnalias": "", "classstring": "", "fieldname": "feld1", "names": { "name": [{ "imageid": "", "newurl": "", "readonlyurl": "", "requesturl": "", "updateurl": "", "tooltip": "|", "lang_id": 7, "defaulturl": "", "content": "Kundenname" }, { "imageid": "", "newurl": "", "readonlyurl": "", "requesturl": "", "updateurl": "", "tooltip": "|", "lang_id": 9, "defaulturl": "", "content": "Kundenname" }] }, "name": "Kundenname", "os_guid": "24AFDC2BA13247338321C0522335D5A6", "input_pos": { "top": 10, "left": 70, "bottom": 12, "right": 80 } }] }, "maintype": 0, "referencetype": 0, "frame": { "top": 0, "left": 0, "bottom": 373, "right": 284 } }] }] } }

 

Related content