Public Web API: Model of the metadata description instance of a process template (Get process template metadata description by code)

Methods

GET — Get process template metadata description by code

Resource

{
    "error": "string",
    "success": "boolean",
    "template": {
        "__createdAt": "date-time",
        "__createdBy": "uuid",
        "__deletedAt": "date-time",
        "__name": "string",
        "__updatedAt": "date-time",
        "__updatedBy": "uuid",
        "code": "string",
        "context": [
            {
                "array": "boolean",
                "calcByFormula": "boolean",
                "code": "string",
                "data": {},
                "defaultValue": {},
                "deleted": "boolean",
                "formula": "string",
                "indexed": "boolean",
                "required": "boolean",
                "searchable": "boolean",
                "single": "boolean",
                "type": "string"
            }
        ],
        "namespace": "string",
        "process": {
            "items": {
                "<key>": {
                    "id": "uuid",
                    "name": "string",
                    "settings": {
                        "formFields": [
                            {
                                "code": "string",
                                "display": "string",
                                "name": "string",
                                "readonly": "boolean",
                                "required": "boolean",
                                "tooltip": "string"
                            }
                        ]
                    },
                    "type": "string"
                }
            }
        },
        "readonly": "boolean",
        "version": "uint64"
    }
}

Properties

Name	Type	Description	Additional
error	string	Error message if `success == false`	Optional
success	boolean	Successful request flag	Optional
template	object	Complete metadata description of process template	Optional
template.__createdAt	date-time		Optional
template.__createdBy	uuid		Optional
template.__deletedAt	date-time		Optional
template.__name	string		Optional
template.__updatedAt	date-time		Optional
template.__updatedBy	uuid		Optional
template.code	string		Optional
template.context[]	array		Optional
template.context[].array	boolean	Array	Optional
template.context[].calcByFormula	boolean	Set a formula for the field	Optional
template.context[].code	string	Code	Optional
template.context[].data	object	Additional field attributes	Optional
template.context[].defaultValue	object	Default value	Optional
template.context[].deleted	boolean	Deletion flag	Optional
template.context[].formula	string	Formula	Optional
template.context[].indexed	boolean	Search and Sort	Optional
template.context[].required	boolean	Required	Optional
template.context[].searchable	boolean	Full-text search	Optional
template.context[].single	boolean	Attribute that shows if the field stores a single value (if the attriute is`true` then it is a single value, if the attibute is `false` then it is a multiple value)	Optional
template.context[].type	string	Type Possible values are: `String` `Float` `Integer` `Boolean` `DateTime` `Duration` `Category` `Tag` `Money` `File` `Phone` `Email` `Image` `Status` `Version` `JSON` `SysUser` `FullName` `Link` `SysOSNode` `SysCollection` `RefItem` `Enum` `Table` `Account` `Role`	Optional
template.namespace	string	Namespace.	Optional
template.process	object	Process template process	Optional
template.process.items	object		Optional
template.process.items.<key>	map of object	Process instance	Optional
template.process.items.<key>.id	uuid		Optional
template.process.items.<key>.name	string		Optional
template.process.items.<key>.settings	object	Process instance settings	Optional
template.process.items.<key>.settings.formFields[]	array		Optional
template.process.items.<key>.settings.formFields[].code	string		Optional
template.process.items.<key>.settings.formFields[].display	string		Optional
template.process.items.<key>.settings.formFields[].name	string		Optional
template.process.items.<key>.settings.formFields[].readonly	boolean		Optional
template.process.items.<key>.settings.formFields[].required	boolean		Optional
template.process.items.<key>.settings.formFields[].tooltip	string		Optional
template.process.items.<key>.type	string		Optional
template.readonly	boolean		Optional
template.version	uint64		Optional