метод REST scope: sign.b2e, crm

sign.b2e.document.get

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

Кто может выполнять: пользователь с правом просмотра документов КЭДО

Описание

Метод sign.b2e.document.get возвращает информацию о документе и участниках подписания.

Метод работает только в контексте авторизации приложения.

Параметры

uid string необязательный

Уникальный идентификатор документа

language string необязательный

Язык локализации статусов в ответе.

По умолчанию en

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"uid":"b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sign.b2e.document.get

Ответ

HTTP-статус: 200

{
    "result": {
        "uid": "b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c",
        "state": {
            "code": "in_progress",
            "name": "В процессе"
        },
        "members": [
            {
                "uid": "f1c2d3e4",
                "role": "signer",
                "party": 0,
                "user": {
                    "employeeCode": "EMP-001",
                    "employeeId": 123,
                    "userId": 25
                },
                "state": {
                    "code": "signed",
                    "name": "Подписано"
                }
            }
        ]
    },
    "time": {
        "start": 1739860000.123,
        "finish": 1739860000.456,
        "duration": 0.333,
        "processing": 0.111,
        "date_start": "2025-02-18T09:19:34+03:00",
        "date_finish": "2025-02-18T09:19:34+03:00",
        "operating_reset_at": 1739860600,
        "operating": 0
    }
}

Возвращаемые данные

result object

Информация о документе и участниках подписания

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 200

{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied!"
}
Код Описание Значение
ACCESS_DENIED Access denied! Недостаточно прав
WRONG_AUTH_TYPE Current authorization type is denied for this method Вызов не из контекста приложения
INTERNAL_ERROR Internal error Ошибка при формировании ответа
Document UID is required Не передан параметр uid
Document not found Документ с указанным uid не найден

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.