DocumentRouterTemplateRepository

Документация для класса DocumentRouterTemplateRepository.

Методы

getSuperAdminDocumentRouterTemplates

Описание

Получение списка шаблонов маршрута документа

HTTP метод: GET

URL: /api-admin/v1/workflow-templates

Параметры:

Имя	Тип	Описание
payload	IGetSuperAdminDocumentRouterTemplatesPayload

Возвращает: Promise<IPaginationShell<IDocumentRouteTemplate[]>>

---

activate

Описание

Активация шаблона

HTTP метод: GET

URL: /api-admin/v1/workflow-templates/{param}/activate

Параметры:

Имя	Тип	Описание
templateId	IDocumentRouteTemplate['id']

Возвращает: Promise<void>

---

deactivate

Описание

Деактивация шаблона

HTTP метод: GET

URL: /api-admin/v1/workflow-templates/{param}/deactivate

Параметры:

Имя	Тип	Описание
templateId	IDocumentRouteTemplate['id']

Возвращает: Promise<void>

---

createSuperAdminDocumentRouterTemplate

Описание

Создание шаблона маршрута документа

HTTP метод: POST

URL: /api-admin/v1/workflow-templates/create

Параметры:

Имя	Тип	Описание
payload	IDocumentRouteTemplateEditor

Возвращает: Promise<IPaginationPayload>

---

getSuperAdminDocumentRouterTemplateById

Описание

Получение шаблона маршрута документа по ID

HTTP метод: GET

URL: /api-admin/v1/workflow-templates/{param}

Параметры:

Имя	Тип	Описание
routerTemplateId	IDocumentRouteTemplate['id']

Возвращает: Promise<IDocumentRouteTemplate>

---

updateSuperAdminDocumentRouterTemplateById

Описание

Обновление данных шаблона маршрута документа по ID

HTTP метод: POST

URL: /api-admin/v1/workflow-templates/{param}/update

Параметры:

Имя	Тип	Описание
routerTemplateId	IDocumentRouteTemplate['id']
payload	IDocumentRouteTemplateEditor

Возвращает: Promise<IDocumentRouteTemplate>

---

getDocumentRouterTemplates

Описание

Получение шаблонов маршрута

HTTP метод: GET

URL: /api-admin/v1/workflow-templates

Параметры:

Имя	Тип	Описание
payload	IGetDocumentRouterTemplatesPayload

Возвращает: Promise<IDocumentRouteTemplate[]>

Определения типов

Определения интерфейсов, перечислений и псевдонимов типов, используемых в методах этого репозитория.

IDocumentRouterTemplateRepository

Интерфейс не содержит собственных свойств и не наследует другие локальные интерфейсы.

---

IDocumentRouteTemplate

Свойство	Тип	Описание
id	number
name	string
is_active	boolean
created_at	RefSystemDateTime
updated_at	RefSystemDateTime
stages	IDocumentRouteTemplateStage[]
document_type	RefEntityShell
subject	Pick<ISubject, 'id' | 'parent_id' | 'name'>

---

IDocumentRouteTemplateEditor

Свойство	Тип	Описание
document_type_id	EDocumentTypeIds | null
subject_id	ISubject['id'] | null
name	string
is_active (опц.)	boolean
stages	stagesT

---

IDocumentRouteTemplateStage

Свойство	Тип	Описание
id	number
stage_type_id	EDocumentStageTypeIds
tasks	`{

    id: ITask['id']
    executors: IUser['id'][]
}[]` |  |

---

IGetDocumentRouterTemplatesPayload

Свойство	Тип	Описание
name (опц.)	string
document_type_id (опц.)	EDocumentTypeIds
sys_subjects_id (опц.)	ISubject['id']
sort (опц.)	'id' | 'ref_document_types_id' | 'sys_subjects_id' | 'name' | 'is_active' | 'created_at' | 'updated_at'
order (опц.)	'asc' | 'desc'
is_active (опц.)	boolean

---

IGetSuperAdminDocumentRouterTemplatesPayload

Наследует: IPaginationPayload

Свойство	Тип	Описание
name (опц.)	IDocumentRouteTemplate['name']
document_type_id (опц.)	IDocumentRouteTemplate['document_type']['id'] | null
sys_subjects_id (опц.)	IDocumentRouteTemplate['subject']['id'] | null

---

IPaginationLinks

Свойство	Тип	Описание
first	string | null
last	string | null
next	string | null
prev	string | null

---

IPaginationMeta

Свойство	Тип	Описание
path	string
current_page	number
per_page	number
to	number
from	number
total	number
links	IPaginationMetaLink[]
last_page	number

---

IPaginationMetaLink

Свойство	Тип	Описание
active	boolean
label	string
url	string | null

---

IPaginationPayload

Свойство	Тип	Описание
page	number
per_page	number

---

IPaginationShell

Свойство	Тип	Описание
links	IPaginationLinks[]
meta	IPaginationMeta
data	list

---

RefEntityShell

Свойство	Тип	Описание
id	id
alias	alias
name	string