Запрос метаданных

После авторизации клиент может запросить метаданные по всем справочникам Системы и по отдельному справочнику.

Запрос справочников

Для запроса информации о всех справочниках Системы клиент должен направить GET-запрос вида

https://budgetform.appspot.com/x?command=analytics

Система вернёт xml-документ с перечнем справочников. Состав справочников и их названия могут отличаться в различных базах в зависимости от конфигурации.

Вариант (сокращённый) результата:

<analytics> <item key='agpidWRnZXRmb3JtclwLEgROb2RlIiQyMTg5MGUwYi1iNjJmLTQwYjAtODc2Mi00YTM5YTY2OTE3OGQMCxIETm9kZSIkMjBmN2UzODEtM2VmYy00NTc0LTg3NmQtOWQ5ZTFlNjJhNDEyDA' name='Валюты'/> <item key='agpidWRnZXRmb3JtclwLEgROb2RlIiQyMTg5MGUwYi1iNjJmLTQwYjAtODc2Mi00YTM5YTY2OTE3OGQMCxIETm9kZSIkNTA1MWY0NmItMDBjMy00ZjhkLTkwY2YtZTViNTk4YmFiOTQyDA' name='Юридические лица'/> <item key='agpidWRnZXRmb3JtclwLEgROb2RlIiQyMTg5MGUwYi1iNjJmLTQwYjAtODc2Mi00YTM5YTY2OTE3OGQMCxIETm9kZSIkMjQxMTE2ZjQtZTE0Ny00OWE5LThmNTQtMWQzMTM3OWY3MTcwDA' name='Контрагенты'/> <item key='agpidWRnZXRmb3JtclwLEgROb2RlIiQyMTg5MGUwYi1iNjJmLTQwYjAtODc2Mi00YTM5YTY2OTE3OGQMCxIETm9kZSIkM2E1NmFlMjctMDIwYy00NjJhLWJiZTAtZWEyNGRkOWQ4OWZhDA' name='Компании группы'/> <item key='agpidWRnZXRmb3JtclwLEgROb2RlIiQyMTg5MGUwYi1iNjJmLTQwYjAtODc2Mi00YTM5YTY2OTE3OGQMCxIETm9kZSIkNTVkMGU1MGQtNTUwMy00ZWUzLWIyODQtMGU0ZTFlNmViMjc0DA' name='Счета'/> <item key='agpidWRnZXRmb3JtclwLEgROb2RlIiQyMTg5MGUwYi1iNjJmLTQwYjAtODc2Mi00YTM5YTY2OTE3OGQMCxIETm9kZSIkYTk0ZmY1NzItZmJhMy00YjMyLTg1ZjYtNzA3Nzg4YzA2NTQ5DA' name='Статьи бюджета'/> <item key='agpidWRnZXRmb3JtclwLEgROb2RlIiQyMTg5MGUwYi1iNjJmLTQwYjAtODc2Mi00YTM5YTY2OTE3OGQMCxIETm9kZSIkYzc2NzQyNDEtM2Y2ZS00ZGZhLTliOTAtMzg0ZTBhM2QzNzkwDA' name='Периоды'/> <item key='agpidWRnZXRmb3JtclwLEgROb2RlIiQyMTg5MGUwYi1iNjJmLTQwYjAtODc2Mi00YTM5YTY2OTE3OGQMCxIETm9kZSIkZjVhYTU2M2YtZjc4Yy00Nzc5LTgyOWMtY2ZmNTU2NTIwNGFjDA' name='Проекты'/> </analytics>

Для каждого списка (аналитики) указывается идентификатор (ключ; key) и наименование (name). Ключ аналитики может использоваться как идентифиатор поля в связанных справочниках или в проводках.

Запрос стуктуры справочника

Для определения внутренней структуры справочника нужно выполнить GET-запрос следующего вида:

https://budgetform.appspot.com/x?command=fields&analytics=XXX, где XXX — ключ справочника.

Пример результата:

<fields> <field id='name' name='Название' required='yes'/> <field id='area' list='agpidWRnZXRmb3JtclwLEgROb2RlIiQyMTg5MGUwYi1iNjJmLTQwYjAtODc2Mi00YTM5YTY2OTE3OGQMCxIETm9kZSIkZTViNTczODMtN2EwZC00YTBkLWE2N2YtY2YzOGFiYzdiYTcxDA' name='Бизнес-направление' required='no'/> <field id='desc' name='Описание' required='no'/> <field id='visible' name='Открыт' required='no'/> <field id='sortCode' name='Порядок' required='no'/> <field id='attachment' name='Вложения' required='no'/> </fields>

Для каждого поля справочника указываются:

• идентификатор (id)
• наименование (name)
• связанный список (list), если значения поля являются элементами другого списка
• реквизит обязательности (required)

Запрос типов документов

Для получения перечня доступных для экспорта документов и их представлений, нужно выполнить GET-запрос следующего вида:

https://budgetform.appspot.com/x?command=documents

Process Insight вернёт xml-документ с перечнем доступных документов. Для каждого документа выводятся следующие атрибуты:

1. process – ключ процесса, определяющего обработку документа
2. form – ключ представления, определяющего вид документа
3. history – ключ формы-представления истории согласования/ изменения документа (Запрос истории согласования документа)
4. наименование процесса.

Пример:

<documents><document><document form='agxzfmJXXX' process='agxzfmJ1ZGXXX'>Заявка на оплату</document></documents>

Ключи процесса необходимы для получения списка соответствующих документов.