Получить документы

Получить список документов

Ручка

GET /lawyer/v1/document/fetch

Полный адрес в сети

Среда	URL
🧪 Dev	https://gateway.devterra.ru/admin/lawyer/v1/document/fetch
🚀 Prod	https://mobile-api.terraprod.ru/admin/lawyer/v1/document/fetch

Описание

Возвращает список документов. По умолчанию — все документы (всех версий и статусов).

Query-параметры

Параметр	Тип	Описание	Обязательность	Пример
onlyActive	bool	Вернуть только активные документы	❌	true

Пример тела ответа

{
    "items": [
        {
            "uuid": "8a87d1a5-5bce-4361-a2e6-8b5517c81212",
            "documentType": 0,
            "documentTypeName": "OFFER_AGREEMENT",
            "title": "Оферта",
            "version": 2,
            "isActive": true,
            "requiresReaccept": false,
            "urlWeb": "https://example.com/offer.pdf",
            "urlApp": null,
            "publishedAt": "2024-11-06T19:30:00+03:00",
            "createdAt": "2024-11-06T19:30:00+03:00",
            "updatedAt": "2024-12-06T19:30:00+03:00",
            "role": null
        }
    ]
}

Поле	Тип	Описание
items	[]object	Список документов

items

Поле	Тип	Описание	Пример
uuid	string	Уникальный идентификатор документа	"8a87d1a5-5bce-4361-a2e6-8b5517c81212"
documentType	int32	Тип документа (см. перечисления)	0
documentTypeName	string	Название типа документа	"OFFER_AGREEMENT"
title	string	Заголовок документа	"Оферта"
version	int32	Версия документа	2
isActive	bool	Флаг активности документа	true
requiresReaccept	bool	Требует ли повторного подписания при обновлении	false
urlWeb	string	Ссылка на документ для веб	"https://example.com/offer.pdf"
urlApp	string?	Ссылка на документ для приложения (может быть null)	null
publishedAt	string	Дата публикации документа	"2024-11-06T19:30:00+03:00"
createdAt	string	Дата создания документа	"2024-11-06T19:30:00+03:00"
updatedAt	string	Дата последнего обновления документа	"2024-12-06T19:30:00+03:00"
role	int32?	ID роли, для которой предназначен документ	null