The following objects are used in multiple endpoints within the Model API.
Response Body
| Element | Description | Type | Notes |
|---|---|---|---|
| mixinTypes | List of mixins defined for the content model. These are based on a set of schemas, which could be empty. | array | None |
| noPerDocumentQuery | True/false indicator of whether the mixin can be used in per-document queries. | Boolean | A true value indicates that queries will not return documents where the specified mixin is set directly on a specific document instance. |
| projectId | Alphanumeric ID for the project. | string | Optional in request bodies. |
| primaryTypes | List of the primary object types used in the content model. | array | None |
| extends | Type of primary object being extended. | string | Values include Document, File, Folder. Optional in request bodies. |
| mixins | List of mixins included in the primary type. | array | Optional in request bodies. |
| subtypes | List of object types that are allowed as children of the primary type. | array | Optional in request bodies. |
| fullTextIndexed | True/false indicator of whether full-text searches can be performed on the document type. | Boolean | Optional in request bodies. |
| special | True/false indicator of whether the primary type is skipped during copies. | Boolean | None |
| schemas | List of assocations between names and sets of fields with prefixes that are used in the content model. | array | None |
| prefix | Prefix associated with all fields in the schema. | string | Required in request bodies. |
| proxy | True/false indicator of whether the schema is applied implicitly to all proxy documents. | Boolean | None |
| versionWriteable | True/false indicator of whether the schema can be written even when the document is a version, which is usually immutable. | Boolean | None |
| types | List of name-type associations that can be used in several places in the content model. | array | When defining fields for either a types or
schemas element, the following primitive field types are
available:
|
Sample Response
{
"mixinTypes": {
"SysFolderish": {
"noPerDocumentQuery": true,
"projectId": "HxP001"
}
},
"primaryTypes": {
"SysContent": {},
"SysFile": {
"extends": "SysContent",
"mixins": [
"SysFilish",
"SysVersionable"
],
"schemas": [
"testschema1",
"file",
"sysfiles",
"identifier",
"address"
]
},
"SysFolder": {
"extends": "SysContent",
"mixins": [
"SysFolderish"
],
"schemas": [
"identifier"
],
"subtypes": [
"SysFile"
]
}
},
"schemas": {
"identifier": {
"fields": {
"nm_firstname": {
"type": "string"
},
"nm_lastname": {
"type": "string"
}
},
"prefix": "nm"
},
"address": {
"fields": {
"adr_home": {
"type": "string"
},
"adr_office": {
"type": "string"
}
},
"prefix": "adr"
}
},
"types": {
"blob": {
"fields": {
"digest": {
"type": "string"
},
"encoding": {
"type": "string"
},
"filename": {
"type": "string"
},
"key": {
"type": "binary"
},
"length": {
"type": "long"
},
"mimeType": {
"type": "string"
}
}
}
}
}