Получение результатов валидации дополнительных атрибутов заказа

Метод используется для получения результатов валидации дополнительных атрибутов (см. Получение списка дополнительных атрибутов заказа), указанных при оформлении заказа. Метод возвращает результаты валидации в виде информации об асинхронной операции, созданной в результате вызова метода Валидация дополнительных атрибутов заказа на том же языке.

GET {reseller_domain}/internal_api/async_tasks/{async_task_id}

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе и созданной асинхронной задачи
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
async_task_id	path	string	Обязательный	ID асинхронной операции

Модель ответа

Название					Тип данных	Описание
data					object	Данные ответа
	id				string	ID асинхронной операции
	type				string	Тип данных
	attributes				object	Информация об асинхронной операции
		status			string	Статус асинхронной операции: pending — создана. running — выполняется, идет процесс валидации. completed — завершена успешно. failed — завершена неуспешно из-за ошибки на стороне платформы.
		failure_message			string	Текст ошибки валидации на стороне платформы
		result			object	Результат валидации
			valid			Результат валидации дополнительных параметров: true — все дополнительные параметры валидны. false — один или несколько дополнительных параметров невалидны.
			errors		array of objects	Список ошибок валидации
				key	string	Ключ дополнительного атрибута заказа
				messages	array	Список текстов ошибок
				applied_to_resource_id	integer	ID ресурса, к которому применяется дополнительный атрибут заказа. Возвращается только для атрибутов на уровне ресурса
				ordering_resource_id	integer	ID ресурса, сгенерированный случайным образом на стороне UI для идентификации порядкового номера ресурса. Возвращается только для атрибутов на уровне ресурса
			application_attributes		object	Если при вызове метода Валидация дополнительных атрибутов заказа был указан `async_task_id` с ID ранее созданной асинхронной задачи, параметр включает значения дополнительных атрибутов, установленные в результате предыдущего вызова этого же метода, когда валидация дополнительных атрибутов заказа выполняется в несколько шагов
			resources_attributes		array of objects	Если при вызове метода Валидация дополнительных атрибутов заказа был указан `async_task_id` с ID ранее созданной асинхронной задачи, параметр включает значения дополнительных атрибутов, установленные в результате предыдущего вызова этого же метода, когда валидация дополнительных атрибутов заказа выполняется в несколько шагов. Возвращается только для атрибутов на уровне ресурса
			info_messages		array	Список информационных сообщений с промежуточными результатами провиженинга услуги
meta					object	Дополнительная информация
	server_current_time				string	Текущие дата и время сервера

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/async_tasks/829e4cf3-459f-4db4-8af8-6ee9bbf34e35' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample' \

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

JSON

{
    "data": {
        "id": "829e4cf3-459f-4db4-8af8-6ee9bbf34e35",
        "type": "async_tasks",
        "attributes": {
            "status": "completed",
            "failure_message": "",
            "result": {
                "valid": false,
                "errors": [
                    {
                        "key": "microsoft_customer_agreement",
                        "messages": [
                            "Microsoft Customer Agreement is not accepted"
                        ],
                        "applied_to_resource_id": null
                    }
                ],
                "application_attributes": {},
                "resources_attributes": [],
                "info_messages": []
            }
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}