Команда
Запрос
Дополнительные предварительные действия
start
"command": {
        "plm_type_code":${xls_export},
        "state":${start}
        "disable_sorting": bool,
		"export_format": string,
        "export_destination_type": string,
        "facts_precision": FactsPrecision,
        "measure_units": MeasureUnits
    }
}

export_destination_type:

  • "local" - на локальной машине
  • "remote" - на сервере

export_format: 

  • xls 
  • csv
  • json
  • ods

Структуру параметров FactsPrecision и MeasureUnits см. в таблице «Описание параметров» на странице «xls_export / Экспорт».

Команда
Ответ
Комментарии
response
"command" : {
                "plm_type_code" : ${xls_export}, 
                "state" : ${response}, // стандартный ответ
                "file_name" : string, // внутреннее название файла
                "file_name_hint" : string, // название файла, отображаемое пользователю
                "progress" : int, // показатель процесса загрузки файла
                "status" : {
                    "code" : int, // код состояния процесса
                    "message": string, // состояние процесса
                    "stacktrace": ""
}

"file_name" вернется тогда, когда будет окончен процесс на сервере


Атрибут "code": 0 параметра status без атрибутов "message"  и "stacktrace" возвращается при успешном выполнении запроса на экспорт.

Пара атрибутов параметра status "code" : 206 и "message" : "Running" возвращается, если уже существовал запущенный экспорт и поэтому новый не был запущен.

КодОшибкаОписание
276User have not permissions on any dimension or fact. У пользователя нет прав на какие-то размерности или факты
  • Нет меток