GET /api/dms/schema/objecttype/{localname}

As of Versionproduct version 1.0 | component version 1.0
Request MethodGET
Response FormatJSON
DescriptionRetrieves the definition of the object type identified by its localname. The definition contains attributes of the object type and definitions of all its fields.
Request Example
/api/dms/schema/objecttype/email
Result Example
{
    "id": "email",
    "localName": "email",
    "displayName": "email",
    "baseId": "document",
    "creatable": true,
    "contentStreamAllowed": "required",
    "fulltextIndexed": true,
    "fields": [
        {
            "id": "system:objectId",
            "localName": "system:objectId",
            "displayName": "system:objectId",
            "description": "Id of the object",
            "propertyType": "string",
            "cardinality": "single",
            "updatability": "readonly",
            "required": false
        },
        {
            "id": "system:baseTypeId",
            "localName": "system:baseTypeId",
            "displayName": "system:baseTypeId",
            "description": "Id of the base object-type for the object",
            "propertyType": "string",
            "cardinality": "single",
            "updatability": "readonly",
            "required": false
        },
        {
            "id": "system:objectTypeId",
            "localName": "system:objectTypeId",
            "displayName": "system:objectTypeId",
            "description": "Id of the object’s type",
            "propertyType": "string",
            "cardinality": "single",
            "updatability": "readonly",
            "required": false
        },
        {
            "id": "system:secondaryObjectTypeIds",
            "localName": "system:secondaryObjectTypeIds",
            "displayName": "system:secondaryObjectTypeIds",
            "description": "Ids of the object’s secondary types.",
            "propertyType": "string",
            "cardinality": "multi",
            "updatability": "readonly",
            "required": false
        },
        {
            "id": "system:createdBy",
            "localName": "system:createdBy",
            "displayName": "system:createdBy",
            "description": "User who created the object",
            "propertyType": "string",
            "cardinality": "single",
            "updatability": "readonly",
            "required": false
        },
        {
            "id": "system:creationDate",
            "localName": "system:creationDate",
            "displayName": "system:creationDate",
            "description": "DateTime when the object was created",
            "propertyType": "datetime",
            "cardinality": "single",
            "updatability": "readonly",
            "required": false
        },
        {
            "id": "system:lastModifiedBy",
            "localName": "system:lastModifiedBy",
            "displayName": "system:lastModifiedBy",
            "description": "User who last modified the object",
            "propertyType": "string",
            "cardinality": "single",
            "updatability": "readonly",
            "required": false
        },
        {
            "id": "system:lastModificationDate",
            "localName": "system:lastModificationDate",
            "displayName": "system:lastModificationDate",
            "description": "DateTime when the object was last modified",
            "propertyType": "datetime",
            "cardinality": "single",
            "updatability": "readonly",
            "required": false
        },
        {
            "id": "system:versionNumber",
            "localName": "system:versionNumber",
            "displayName": "system:versionNumber",
            "description": "The version number of the object",
            "propertyType": "integer",
            "cardinality": "single",
            "updatability": "readonly",
            "required": true
        },
        ...
        {
            "id": "from",
            "localName": "from",
            "displayName": "from",
            "description": "system-wide field for the e-mail sender",
            "propertyType": "string",
            "cardinality": "single",
            "updatability": "readwrite",
            "required": false
        },
        {
            "id": "to",
            "localName": "to",
            "displayName": "to",
            "description": "system-wide field for the e-mail recipients",
            "propertyType": "string",
            "cardinality": "multi",
            "updatability": "readwrite",
            "required": false
        },
        {
            "id": "cc",
            "localName": "cc",
            "displayName": "cc",
            "description": "system-wide field for the e-mail cc",
            "propertyType": "string",
            "cardinality": "multi",
            "updatability": "readwrite",
            "required": false
        },
        {
            "id": "bcc",
            "localName": "bcc",
            "displayName": "bcc",
            "description": "system-wide field for the e-mail bcc",
            "propertyType": "string",
            "cardinality": "multi",
            "updatability": "readwrite",
            "required": false
        },
        {
            "id": "subject",
            "localName": "subject",
            "displayName": "subject",
            "description": "system-wide field for the e-mail subject",
            "propertyType": "string",
            "cardinality": "single",
            "updatability": "readwrite",
            "required": false
        },
        ...
    ]
}