Сведения об операции OperationInfo
(v2 API)
Тип данных OperationInfo
описывает информацию о результате выполнения операции
при использовании v2 API.
Поле | Тип | Описание |
---|---|---|
Id | string | Идентификатор операции. |
Result | Объект | Результат выполнения операции |
Status | string OperationStatus | Статус операции. |
Error | string | Код ошибки выполнения операции. |
ErrorDescription | string | Описание ошибки выполнения операции. |
ExpirationDate | ulong | Выполнить операцию до (UTC) |
Данную структуру возращают методы, который могут быть выполнены с подтверждением вторым фактором аутентификации.
Имя | Код | Описание |
---|---|---|
SignDocument | 2 | Подпись документа или пакета документов |
DecryptDocument | 8 | Расшифрование докумета |
CreateRequest | 16 | Создание запроса на сертификат |
ChangePin | 32 | Смена ПИН-кода на закрытый ключ сертификата |
RenewCertificate | 64 | Перевыпуск сертификата |
RevokeCertificate | 128 | Аннулирование сертификата |
HoldCertificate | 256 | Приостановление действия сертификата |
UnholdCertificate | 512 | Возобновление действия сертификата |
DeleteCertificate | 1024 | Удаление сертификата |
Если значение поля Status равно Created
, то операция должна
быть выполнена с подтверждением вторым фактором. В данном случае поле Result не заполняется.
Для подтверждения операции вторым фактором аутентификации пользователь должен обратиться на конечную точку
/v2/confirmation. В вызове метода /v2/confirmation
необходимо указать идентификатор созданной операции Id.
Подробнее см. раздел Подтверждение операций.
После успешного подтверждения операции вторым фактором аутентификации необходимо завершить операцию
вызвав соответствующий метод Сервиса Подписи.
Если значение поля Status равно Completed
, то операция выполнена успешно.
Результат операции записан в поле Result.
Если значение поля Status равно Error
, то операция завершилась с ошибкой.
В данном случае поле Result может быть не заполнено. Код ошибки и описание ошибки
будут записаны в поля Error, ErrorDescription.
Поля Id, ExpirationDate заполняются только в случае Status равного Created
.
Ниже приведено соответствие типа операции и типа результат операции
Тип операции | Код операции | Тип результата |
---|---|---|
SignDocument | 2 | BinaryOperationResult - результат подписи документов. |
DecryptDocument | 8 | BinaryOperationResult - результат расшифрования документов. |
CreateRequest | 16 | DSSCertRequest - Созданный запрос на сертификат |
ChangePin | 32 | Не имеет возвращаемого результата |
RenewCertificate | 64 | |
RevokeCertificate | 128 | Не имеет возвращаемого результата |
HoldCertificate | 256 | Не имеет возвращаемого результата |
UnholdCertificate | 512 | Не имеет возвращаемого результата |
DeleteCertificate | 1024 | Не имеет возвращаемого результата |