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",
                "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 Optional
template.context[].calcByFormula boolean Optional
template.context[].code string

Code

Optional
template.context[].defaultValue object Optional
template.context[].deleted boolean Optional
template.context[].formula string Optional
template.context[].indexed boolean Optional
template.context[].required boolean Optional
template.context[].searchable boolean Optional
template.context[].single boolean Optional
template.context[].type string

Type

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