Public Web API: Model of document template’s metadata description instance (Get the metadata description of a document template by ID)

Methods

GET — Get the metadata description of a document template by ID

Resource

{
    "docTemplateEntity": {
        "__createdAt": "date-time",
        "__createdBy": "uuid",
        "__deletedAt": "date-time",
        "__id": "uuid",
        "__name": "string",
        "__updatedAt": "date-time",
        "__updatedBy": "uuid",
        "extension": "string",
        "fileId": "uuid",
        "namespace": "string",
        "variables": [
            {
                "code": "string",
                "type": "string"
            }
        ]
    },
    "error": "string",
    "success": "boolean"
}

Properties

Name	Type	Description	Additional
docTemplateEntity	object	Full metadata description of a document template	Optional
docTemplateEntity.__createdAt	date-time	Date the document template was created/set	Optional
docTemplateEntity.__createdBy	uuid	ID of the user who created the document template	Optional
docTemplateEntity.__deletedAt	date-time	Date the document template was deleted	Optional
docTemplateEntity.__id	uuid	ID of the document template	Optional
docTemplateEntity.__name	string	Document template name	Optional
docTemplateEntity.__updatedAt	date-time	Date the document template was edited/updated	Optional
docTemplateEntity.__updatedBy	uuid	ID of the user who changed or updated the document template	Optional
docTemplateEntity.extension	string	Document template file format	Optional
docTemplateEntity.fileId	uuid	File ID	Optional
docTemplateEntity.namespace	string	Document template workspace	Optional
docTemplateEntity.variables[]	array	Document template fields	Optional
docTemplateEntity.variables[].code	string	Field code	Optional
docTemplateEntity.variables[].type	string	Field type	Optional
error	string	Error message if `success == false`	Optional
success	boolean	Successful request flag	Optional