Методы

  • GET — Получение схемы шаблона процесса по коду

Ресурс

{
    "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"
    }
}

Свойства

Имя Тип Описание Дополнительно
error string

Текст ошибки, если success == false

Опциональное
success boolean

Признак успешного запроса

Опциональное
template object

Полная схема шаблона процесса

Опциональное
template.__createdAt date-time Опциональное
template.__createdBy uuid Опциональное
template.__deletedAt date-time Опциональное
template.__name string Опциональное
template.__updatedAt date-time Опциональное
template.__updatedBy uuid Опциональное
template.code string Опциональное
template.context[] array Опциональное
template.context[].array boolean

Array

Опциональное
template.context[].calcByFormula boolean

Заполнение по формуле

Опциональное
template.context[].code string

Код

Опциональное
template.context[].data object

Дополнительные атрибуты поля

Опциональное
template.context[].defaultValue object

Значение по умолчанию

Опциональное
template.context[].deleted boolean

Признак удаления

Опциональное
template.context[].formula string

Формула

Опциональное
template.context[].indexed boolean

Поиск и сортировка

Опциональное
template.context[].required boolean

Обязательно для заполнения

Опциональное
template.context[].searchable boolean

Полнотекстовый поиск

Опциональное
template.context[].single boolean

Признак того, что в поле хранится единичное значение (если признак равен true - одно значение, если false - множество)

Опциональное
template.context[].type string

Тип

Возможные значения:

  • 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
Опциональное
template.namespace string Namespace - тип для пространства имен. Опциональное
template.process object

Процесс шаблона процесса

Опциональное
template.process.items object Опциональное
template.process.items.<key> map of object

Элемент процесса

Опциональное
template.process.items.<key>.id uuid Опциональное
template.process.items.<key>.name string Опциональное
template.process.items.<key>.settings object

Настройки элемента процесса

Опциональное
template.process.items.<key>.settings.formFields[] array Опциональное
template.process.items.<key>.settings.formFields[].code string Опциональное
template.process.items.<key>.settings.formFields[].display string Опциональное
template.process.items.<key>.settings.formFields[].name string Опциональное
template.process.items.<key>.settings.formFields[].readonly boolean Опциональное
template.process.items.<key>.settings.formFields[].required boolean Опциональное
template.process.items.<key>.settings.formFields[].tooltip string Опциональное
template.process.items.<key>.type string Опциональное
template.readonly boolean Опциональное
template.version uint64 Опциональное