AIHW MyHospitals (независимый издатель) (предварительная версия)
Национальная платформа отчетности MyHospitals позволяет пользователям изучить информацию о своей локальной больнице и локальной сети больницы (LHN), а также тенденции по всей Австралии
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Пол Калмси |
| URL | https://www.sevensigma.com.au |
| Адрес электронной почты | paul.culmsee@sevensigma.com.au |
| Метаданные соединителя | |
|---|---|
| Publisher | Пол Калмси |
| Веб-сайт | https://www.aihw.gov.au/reports-data/myhospitals/content/api |
| Privacy Policy (Политика конфиденциальности) | https://www.aihw.gov.au/privacy-policy |
| Категории | Данные |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Получение доступных кодов таблицы единиц отчетов |
Получает словарь, индексированные кодом таблицы, из всех доступных кодов и описаний таблицы единиц отчетов, которые можно использовать в вызове API скачивания единиц отчетов. |
| Получение доступных простых скачиваемых файлов |
Получает словарь, индексированные простым кодом скачивания, из всех доступных простых кодов и описаний загрузки, которые можно использовать в простом вызове API скачивания. |
| Получение доступных скачиваемой меры |
Получает словарь, индексированные кодом загрузки мер, из всех доступных кодов скачивания мер и описаний, которые можно использовать в вызове API скачивания мер. |
| Получение единиц отчетов |
Возвращает список всех единиц отчетов, при необходимости отфильтрованных с помощью логического отсчета (OR) по списку кодов типов единиц отчетов. |
| Получение единиц отчетов, доступных для измерения |
Возвращает список всех единиц отчетов, имеющих данные, доступные для указанной меры. |
| Получение единого блока отчетов |
Возвращает единую единицу отчетов, соответствующую предоставленному коду единицы отчетности. |
| Получение загрузки мер |
Получает скачивание меры в формате XLSX для предоставленного кода скачивания мер. |
| Получение категории одномерных мер |
Возвращает одну категорию мер, соответствующую заданному коду категории мер. |
| Получение категорий мер |
Возвращает список категорий мер. |
| Получение категорий сообщаемой меры |
Возвращает список всех доступных категорий сообщаемых мер. |
| Получение категорий сообщаемой меры для кода категорий мер |
Возвращает список зарегистрированных категорий мер, соответствующих заданным кодам категорий мер. ПРИМЕЧАНИЕ. Указанные коды мер не ограничены уникальными в системе. |
| Получение кодов кирпича для единицы отчетности |
Возвращает список всех кодов кирпича, доступных для указанной единицы отчетности. |
| Получение мер |
Возвращает список всех мер, необязательно отфильтрованных с помощью логического дисъюнкции (OR), по списку кодов категорий мер. |
| Получение мер для категории мер |
Возвращает список мер для указанного кода категории мер. |
| Получение мер с данными, доступными для единицы отчетов |
Получите список всех мер, имеющих данные, доступные для указанной единицы отчетности. |
| Получение меры по скачиванию единиц отчетов |
Получает меру в формате XLSX для указанного кода скачивания единицы отчетности. |
| Получение наборов данных |
Возвращает список наборов данных, при необходимости отфильтрованный по списку мер и сообщаемых кодов мер. Сопоставление в каждом фильтре выполняется путем логического отсоединения (OR) и сопоставления между фильтрами по логическому сочетанию (AND). |
| Получение неструктурированных данных |
Получает данные в плоской структуре с каждым элементом, соответствующим одной точке данных. Данные ограничены одной категорией мер и могут быть при необходимости отфильтрованы по мере, типу единиц отчетов и датам отчетности. Сопоставление в каждом фильтре выполняется путем логического отсоединения (OR) и сопоставления между фильтрами по логическому сочетанию (AND). ПРИМЕЧАНИЕ. В настоящее время существует ограничение на страницы для этого запроса, которое ограничивает запросы не более 1000 результатов. Используйте пропуск и сверху, чтобы управлять этой разбивкой на страницы. Сортировка в настоящее время недоступна. |
| Получение неструктурированных данных |
Получает форматированные данные в плоской структуре с каждым элементом, соответствующим одной точке данных. Данные ограничены одной категорией мер и могут быть при необходимости отфильтрованы по мере, коду единицы отчетов, типу единиц отчетов и датам отчетности. Сопоставление в каждом фильтре выполняется путем логического отсоединения (OR) и сопоставления между фильтрами по логическому сочетанию (AND). ПРИМЕЧАНИЕ. В настоящее время существует ограничение на страницы для этого запроса, которое ограничивает запросы не более 1000 результатов. Используйте пропуск и сверху, чтобы управлять этой разбивкой на страницы. Сортировка в настоящее время недоступна. |
| Получение одного набора данных |
Возвращает один набор данных, соответствующий указанному идентификатору набора данных. |
| Получение одного предостережения |
Возвращает предостережение, соответствующее предоставленному коду предостережения. |
| Получение одного типа единицы отчетов |
Возвращает один тип единицы отчетности, соответствующий предоставленному коду типа единиц отчетов. |
| Получение одной меры |
Возвращает единую меру, соответствующую заданному коду меры. |
| Получение одной сообщаемой меры |
Возвращает одну сообщаемую меру. |
| Получение отчетов о мерах для категории сообщаемой меры |
Возвращает список всех сообщаемых мер для указанного кода категории меры. |
| Получение предостережения |
Возвращает список предостережения. |
| Получение простого скачивания |
Получает простую загрузку в формате XLSX для предоставленного кода скачивания. |
| Получение скачивания данных единиц отчетов |
Возвращает скачивание данных единицы отчетности в формате XLSX для предоставленного кода единицы отчетности и кода таблицы. |
| Получение словаря кодов единиц отчетов и доступных кирпичей |
Получает словарь кодов единиц отчетов и их доступных кирпичей для указанного типа единицы отчетности. |
| Получение сообщаемые меры |
Возвращает список сообщаемых мер, при необходимости отфильтрованный по списку кодов мер. |
| Получение типов единиц отчетов |
Возвращает список типов единиц отчетов. |
| Получение элементов данных для единицы отчетов |
Возвращает список всех элементов данных для указанной единицы отчетности. |
| Получение элементов данных для измерения |
Возвращает список всех элементов данных для указанной меры. |
| Получение элементов данных для сообщаемой меры |
Возвращает список всех элементов данных для указанной меры. |
| Получение элементов набора данных |
Возвращает список элементов данных для набора данных, при необходимости отфильтрованный с помощью логического отсечения (OR) по списку кодов единиц отчетов. |
| Скачивание сопоставления единиц отчетов |
Возвращает скачивание сопоставления единиц отчетов в формате XLSX. |
Получение доступных кодов таблицы единиц отчетов
Получает словарь, индексированные кодом таблицы, из всех доступных кодов и описаний таблицы единиц отчетов, которые можно использовать в вызове API скачивания единиц отчетов.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | ||
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение доступных простых скачиваемых файлов
Получает словарь, индексированные простым кодом скачивания, из всех доступных простых кодов и описаний загрузки, которые можно использовать в простом вызове API скачивания.
Получение доступных скачиваемой меры
Получает словарь, индексированные кодом загрузки мер, из всех доступных кодов скачивания мер и описаний, которые можно использовать в вызове API скачивания мер.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
results
|
results | array of object |
results |
|
Имя
|
results.Name | string |
Имя |
|
Сведения
|
results.Details | array of DatasheetConfigurationSummaryModel |
Сведения |
Получение единиц отчетов
Возвращает список всех единиц отчетов, при необходимости отфильтрованных с помощью логического отсчета (OR) по списку кодов типов единиц отчетов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Коды типов единиц отчетов
|
reporting_unit_type_code | string |
Коды типов единиц отчетов. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of ReportingUnitModel |
результат |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение единиц отчетов, доступных для измерения
Возвращает список всех единиц отчетов, имеющих данные, доступные для указанной меры.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Коды мер
|
measure-code | True | string |
Коды мер. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of ReportingUnitSummaryModel |
результат |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение единого блока отчетов
Возвращает единую единицу отчетов, соответствующую предоставленному коду единицы отчетности.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код единицы отчетности
|
reporting-unit-code | True | string |
Код единицы отчетности. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | ReportingUnitModel |
ReportingUnit указывает, какая единица анализа соответствует определенному значению данных (часто географической или иначе пограничной области). |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение загрузки мер
Получает скачивание меры в формате XLSX для предоставленного кода скачивания мер.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код загрузки меры
|
measure-download-code | True | string |
Код загрузки меры. |
Получение категории одномерных мер
Возвращает одну категорию мер, соответствующую заданному коду категории мер.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код категории мер
|
measure-category-code | True | string |
Код категории мер. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | MeasureCategoryModel |
МераCategory используется для группировки мер. |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение категорий мер
Возвращает список категорий мер.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of MeasureCategoryModel |
результат |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение категорий сообщаемой меры
Возвращает список всех доступных категорий сообщаемых мер.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of ReportedMeasureCategoryModel |
результат |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение категорий сообщаемой меры для кода категорий мер
Возвращает список зарегистрированных категорий мер, соответствующих заданным кодам категорий мер. ПРИМЕЧАНИЕ. Указанные коды мер не ограничены уникальными в системе.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код категории сообщаемой меры
|
reported-measure-category-code | True | string |
Код категории сообщаемой меры. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | ReportedMeasureCategoryModel |
ОтчетMeasureCategory предоставляет метод для разбиения определенной меры, а также позволяет группировать СообщаетMeasures. |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение кодов кирпича для единицы отчетности
Возвращает список всех кодов кирпича, доступных для указанной единицы отчетности.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код единицы отчетности
|
reporting-unit-code | True | string |
Код единицы отчетности. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of string |
результат |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение мер
Возвращает список всех мер, необязательно отфильтрованных с помощью логического дисъюнкции (OR), по списку кодов категорий мер.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Коды категорий мер
|
measure_category_code | string |
Коды категорий мер. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of object |
результат |
|
measure_categories
|
result.measure_categories | array of MeasureCategoryModel |
measure_categories |
|
measure_code
|
result.measure_code | string |
measure_code |
|
measure_name
|
result.measure_name | string |
measure_name |
|
meta_tags
|
result.meta_tags | array of MetaTagModel |
Список метаданных, применимых к этой мере. Этот список будет пустым, если метаданные отсутствуют. |
|
Единиц
|
result.units | UnitsModel |
Единицы указывают, как должны быть выражены значения данных для меры. |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение мер для категории мер
Возвращает список мер для указанного кода категории мер.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код категории мер.
|
measure-category-code | True | string |
Код категории мер. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of MeasureModel |
результат |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение мер с данными, доступными для единицы отчетов
Получите список всех мер, имеющих данные, доступные для указанной единицы отчетности.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код единицы отчетности
|
reporting-unit-code | True | string |
Код единицы отчетности |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of MeasureSummaryModel | |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение меры по скачиванию единиц отчетов
Получает меру в формате XLSX для указанного кода скачивания единицы отчетности.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код загрузки меры
|
measure-download-code | True | string |
Код загрузки меры. |
Получение наборов данных
Возвращает список наборов данных, при необходимости отфильтрованный по списку мер и сообщаемых кодов мер. Сопоставление в каждом фильтре выполняется путем логического отсоединения (OR) и сопоставления между фильтрами по логическому сочетанию (AND).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Коды мер
|
measure_code | string |
Коды мер. |
|
|
Коды сообщаемой меры
|
reported_measure_code | string |
Коды сообщаемой меры. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of DatasetModel |
Получение неструктурированных данных
Получает данные в плоской структуре с каждым элементом, соответствующим одной точке данных. Данные ограничены одной категорией мер и могут быть при необходимости отфильтрованы по мере, типу единиц отчетов и датам отчетности. Сопоставление в каждом фильтре выполняется путем логического отсоединения (OR) и сопоставления между фильтрами по логическому сочетанию (AND). ПРИМЕЧАНИЕ. В настоящее время существует ограничение на страницы для этого запроса, которое ограничивает запросы не более 1000 результатов. Используйте пропуск и сверху, чтобы управлять этой разбивкой на страницы. Сортировка в настоящее время недоступна.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код категории мер
|
measure-category-code | True | string |
Указывает код категории мер, к которому должны принадлежать данные. |
|
Меры
|
measure_code | string |
Включают только данные, соответствующие указанным мерам. |
|
|
Тип единицы отчетов
|
reporting_unit_type_code | string |
Включают только данные для указанных типов единиц отчетов. |
|
|
Отчетная единица измерения
|
reporting_unit_code | string |
Включают только данные для указанных единиц отчетности. |
|
|
Количество записей для пропуска
|
skip | True | integer |
Количество пропускаемых записей. Это используется в разбивке на страницы результатов данных, чтобы определить, откуда начать принимать результаты. |
|
Количество записей, которые требуется принять
|
top | True | integer |
Количество записей, которые требуется принять. Это используется в разбивке на страницы результатов данных, чтобы определить, сколько результатов извлекаются. Это значение должно быть от 1 до 1000. |
|
Начальная дата
|
start_date | string |
startDate может быть датой формы гггг, гггг, гггг-ММ или гггг-ММ или гггг-ММ-дд. Если указан только год, период поиска начинается в начале года, когда указан год и месяц, период поиска начинается в начале месяца. |
|
|
Дата окончания
|
end_date | string |
EndDate может быть датой формы гггг, гггг-ММ или гггг-ММ или гггг-ММ-дд. Если указан только год, период поиска заканчивается в конце года, когда указан год и месяц, период поиска заканчивается в конце месяца. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | PaginatedFormattedDataExtractModel |
Набор результатов с разбивкой на страницы, содержащий список элементов FormattedDataExtract и сведения о разбиении на страницы для запроса. |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение неструктурированных данных
Получает форматированные данные в плоской структуре с каждым элементом, соответствующим одной точке данных. Данные ограничены одной категорией мер и могут быть при необходимости отфильтрованы по мере, коду единицы отчетов, типу единиц отчетов и датам отчетности. Сопоставление в каждом фильтре выполняется путем логического отсоединения (OR) и сопоставления между фильтрами по логическому сочетанию (AND). ПРИМЕЧАНИЕ. В настоящее время существует ограничение на страницы для этого запроса, которое ограничивает запросы не более 1000 результатов. Используйте пропуск и сверху, чтобы управлять этой разбивкой на страницы. Сортировка в настоящее время недоступна.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код категории мер
|
measure-category-code | True | string |
Указывает код категории мер, к которому должны принадлежать данные. |
|
Меры
|
measure_code | string |
Включают только данные, соответствующие указанным мерам. |
|
|
Тип единицы отчетов
|
reporting_unit_type_code | string |
Включают только данные для указанных типов единиц отчетов. |
|
|
Отчетная единица измерения
|
reporting_unit_code | string |
Включают только данные для указанных единиц отчетности. |
|
|
Количество записей для пропуска
|
skip | True | integer |
Количество пропускаемых записей. Это используется в разбивке на страницы результатов данных, чтобы определить, откуда начать принимать результаты. |
|
Количество записей, которые требуется принять
|
top | True | integer |
Количество записей, которые требуется принять. Это используется в разбивке на страницы результатов данных, чтобы определить, сколько результатов извлекаются. Это значение должно быть от 1 до 1000. |
|
Начальная дата
|
start_date | string |
startDate может быть датой формы гггг, гггг, гггг-ММ или гггг-ММ или гггг-ММ-дд. Если указан только год, период поиска начинается в начале года, когда указан год и месяц, период поиска начинается в начале месяца. |
|
|
Дата окончания
|
end_date | string |
EndDate может быть датой формы гггг, гггг-ММ или гггг-ММ или гггг-ММ-дд. Если указан только год, период поиска заканчивается в конце года, когда указан год и месяц, период поиска заканчивается в конце месяца. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | PaginatedFormattedDataExtractModel |
Набор результатов с разбивкой на страницы, содержащий список элементов FormattedDataExtract и сведения о разбиении на страницы для запроса. |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение одного набора данных
Возвращает один набор данных, соответствующий указанному идентификатору набора данных.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор набора данных
|
dataset-id | True | integer |
Идентификатор набора данных. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | DatasetModel | |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение одного предостережения
Возвращает предостережение, соответствующее предоставленному коду предостережения.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код предостережения
|
caveat-code | True | string |
Код предостережения |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | CaveatModel |
Предостережение — это сноска или подавление, используемое для применения или вместо значения данных. |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение одного типа единицы отчетов
Возвращает один тип единицы отчетности, соответствующий предоставленному коду типа единиц отчетов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код типа единицы отчетности.
|
reporting-unit-type-code | True | string |
Код типа единицы отчетности. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | ReportingUnitType |
Отчет ReportingUnitType указывает тип для ReportingUnit и используется для группировки ReportingUnits. |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение одной меры
Возвращает единую меру, соответствующую заданному коду меры.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Коды категорий мер
|
measure-code | True | string |
Коды категорий мер. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
measure_categories
|
result.measure_categories | array of MeasureCategoryModel |
measure_categories |
|
measure_code
|
result.measure_code | string |
measure_code |
|
measure_name
|
result.measure_name | string |
measure_name |
|
meta_tags
|
result.meta_tags | array of MetaTagModel |
Список метаданных, применимых к этой мере. Этот список будет пустым, если метаданные отсутствуют. |
|
Единиц
|
result.units | UnitsModel |
Единицы указывают, как должны быть выражены значения данных для меры. |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение одной сообщаемой меры
Возвращает одну сообщаемую меру.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Сообщаемые коды категорий мер.
|
reported-measure-code | True | string |
Коды категорий сообщаемой меры. |
Возвращаемое значение
ОтчетMeasure является разбиение определенной меры. Это разбиение обозначается 1 или более Отчетными категориями.
- Тело
- ReportedMeasureModel
Получение отчетов о мерах для категории сообщаемой меры
Возвращает список всех сообщаемых мер для указанного кода категории меры.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Категория сообщаемой меры.
|
reported-measure-category-code | True | string |
Категория сообщаемой меры. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of ReportedMeasureModel | |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение предостережения
Возвращает список предостережения.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of CaveatModel | |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение простого скачивания
Получает простую загрузку в формате XLSX для предоставленного кода скачивания.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код скачивания.
|
download-code | True | string |
Код скачивания. |
Получение скачивания данных единиц отчетов
Возвращает скачивание данных единицы отчетности в формате XLSX для предоставленного кода единицы отчетности и кода таблицы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код таблицы
|
datasheet-code | True | string |
Код таблицы |
|
Код единицы отчетности
|
reporting-unit-code | True | string |
Код единицы отчетности |
Получение словаря кодов единиц отчетов и доступных кирпичей
Получает словарь кодов единиц отчетов и их доступных кирпичей для указанного типа единицы отчетности.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код типа единицы отчетности.
|
reporting-unit-type-code | True | string |
Код типа единицы отчетности. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение сообщаемые меры
Возвращает список сообщаемых мер, при необходимости отфильтрованный по списку кодов мер.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Коды мер
|
measure_code | string |
Коды мер |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of ReportedMeasureModel |
результат |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение типов единиц отчетов
Возвращает список типов единиц отчетов.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of ReportingUnitType |
результат |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение элементов данных для единицы отчетов
Возвращает список всех элементов данных для указанной единицы отчетности.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код единицы отчетности.
|
reporting-unit-code | True | string |
Код единицы отчетности. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of DataItemModel |
результат |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение элементов данных для измерения
Возвращает список всех элементов данных для указанной меры.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код меры
|
measure-code | True | string |
Код меры. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of DataItemModel |
результат |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение элементов данных для сообщаемой меры
Возвращает список всех элементов данных для указанной меры.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Сообщаемые коды категорий мер.
|
reported-measure-code | True | string |
Коды категорий сообщаемой меры. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of DataItemModel |
результат |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Получение элементов набора данных
Возвращает список элементов данных для набора данных, при необходимости отфильтрованный с помощью логического отсечения (OR) по списку кодов единиц отчетов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор набора данных
|
dataset-id | True | string |
Идентификатор набора данных. |
|
Коды единиц отчетов
|
reporting_unit_code | string |
Коды единиц отчетности. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
результат
|
result | array of DataItemModel |
результат |
|
version_information
|
version_information | VersionInformation |
Сведения о версии API |
Скачивание сопоставления единиц отчетов
Возвращает скачивание сопоставления единиц отчетов в формате XLSX.
Определения
Предостережение
Предостережение — это сноска или подавление, используемое для применения или вместо значения данных.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код предостережения
|
caveat_code | string |
Код соответствующего предостережения. |
|
Отображаемое значение предостережения
|
caveat_display_value | string |
Отображаемое значение или символ для соответствующего кавыка. Если у кавыка нет символа, это поле будет иметь значение NULL. |
|
Предостережение сносок
|
caveat_footnote | string |
Текст сноски и объяснения соответствующего предостережения. Если у кавыка нет текста, это поле будет иметь значение NULL. |
|
Имя предостережения
|
caveat_name | string |
Имя соответствующего предостережения. |
MeasureModel
Мера — это статистика, используемая для измерения чего-то. Некоторые меры — это показатели производительности (например, время ожидания выборной операции) и некоторые обеспечивают контекст для этих показателей (например, количество выборных операций).
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
measure_categories
|
measure_categories | array of MeasureCategoryModel |
Список категорий мер, применимых к этой мере. |
|
measure_code
|
measure_code | string |
Код соответствующего измерения. |
|
measure_name
|
measure_name | string |
Имя соответствующего измерения. |
|
meta_tags
|
meta_tags | array of MetaTagModel |
Список метаданных, применимых к этой мере. Этот список будет пустым, если метаданные отсутствуют. |
|
Единиц
|
units | UnitsModel |
Единицы указывают, как должны быть выражены значения данных для меры. |
MeasureCategoryModel
МераCategory используется для группировки мер.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
measure_category_code
|
measure_category_code | string |
Код соответствующего measureCategory. |
|
measure_category_name
|
measure_category_name | string |
Имя соответствующего объекта MeasureCategory. |
ОтчетMeasureCategoryTypeModel
Модель типа категории сообщаемых мер.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
reported_measure_category_type_code
|
reported_measure_category_type_code | string |
Код соответствующего объекта ReportedMeasureCategoryType |
|
reported_measure_category_type_name
|
reported_measure_category_type_name | string |
Имя соответствующего объекта ReportedMeasureCategoryType. |
ОтчетMeasureCategoryModel
ОтчетMeasureCategory предоставляет метод для разбиения определенной меры, а также позволяет группировать СообщаетMeasures.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
reported_measure_category_code
|
reported_measure_category_code | string |
Код, представляющий ОтчетMeasureCategory. |
|
reported_measure_category_name
|
reported_measure_category_name | string |
Отображаемый текст для СообщенияMeasureCategory. |
|
reported_measure_category_type
|
reported_measure_category_type | ReportedMeasureCategoryTypeModel |
Модель типа категории сообщаемых мер. |
ReportingUnitSummaryModel
Отчет ReportingUnitSummary содержит сведения о коде и имени ReportingUnit, включая сводку по связанному отчету ReportingUnitType.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код единицы отчетности
|
reporting_unit_code | string |
Код соответствующего ReportingUnit. |
|
Имя единицы отчетов
|
reporting_unit_name | string |
Имя соответствующего ReportingUnit. |
|
reporting_unit_type
|
reporting_unit_type | ReportingUnitType |
Отчет ReportingUnitType указывает тип для ReportingUnit и используется для группировки ReportingUnits. |
ReportingUnitType
Отчет ReportingUnitType указывает тип для ReportingUnit и используется для группировки ReportingUnits.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код типа единицы отчетов
|
reporting_unit_type_code | string |
Код соответствующего ReportingUnitType. |
|
Имя типа единицы отчетов
|
reporting_unit_type_name | string |
Имя соответствующего ReportingUnitType. |
ReportingUnitModel
ReportingUnit указывает, какая единица анализа соответствует определенному значению данных (часто географической или иначе пограничной области).
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
alternative_names
|
alternative_names | array of |
Список альтернативных имен для этого ReportingUnit. Если нет альтернативных имен, этот список будет пустым. |
|
ReportingUnit закрыт
|
closed | boolean |
Указывает, закрыт ли этот отчет ReportingUnit. |
|
ReportingUnit является частным
|
private | boolean |
Указывает, является ли этот ReportingUnit частным, например частной больницей. |
|
Широта ReportingUnit
|
latitude | float |
Широта для ReportingUnit. Это поле может иметь значение NULL, если для ReportingUnit нет географической точки. |
|
Долгота ReportingUnit
|
longitude | float |
Долгота для ReportingUnit. Это поле может иметь значение NULL, если для ReportingUnit нет географической точки. |
|
mapped_reporting_units
|
mapped_reporting_units | MappedReportingUnitModel |
Список сопоставленных reportingUnits, применимых к этому отчету ReportingUnit. Этот список будет пустым, если нет сопоставлений. |
|
meta_tags
|
meta_tags | array of MetaTagModel |
Список метаданных, применимых к этой единице отчетности. Этот список будет пустым, если метаданные отсутствуют. |
|
reporting_unit_code
|
reporting_unit_code | string |
Код соответствующего ReportingUnit. |
|
reporting_unit_name
|
reporting_unit_name | string |
Имя соответствующего ReportingUnit. |
|
reporting_unit_type
|
reporting_unit_type | ReportingUnitType |
Отчет ReportingUnitType указывает тип для ReportingUnit и используется для группировки ReportingUnits. |
ОтчетMeasureModel
ОтчетMeasure является разбиение определенной меры. Это разбиение обозначается 1 или более Отчетными категориями.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
мера
|
measure | MeasureModel |
Мера — это статистика, используемая для измерения чего-то. Некоторые меры — это показатели производительности (например, время ожидания выборной операции) и некоторые обеспечивают контекст для этих показателей (например, количество выборных операций). |
|
meta_tags
|
meta_tags | array of MetaTagModel |
Список метаданных, применимых к этой мере. Этот список будет пустым, если метаданные отсутствуют. |
|
reported_measure_categories
|
reported_measure_categories | array of ReportedMeasureCategoryModel |
Список категорий ReportedMeasure, применимых к этому ОтчетуMeasure. |
|
reported_measure_code
|
reported_measure_code | string |
Код соответствующего отчетногоMeasure. |
|
reported_measure_name
|
reported_measure_name | string |
Имя соответствующего объекта ReportedMeasure. |
MappedReportingUnitModel
Список сопоставленных reportingUnits, применимых к этому отчету ReportingUnit. Этот список будет пустым, если нет сопоставлений.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
mapped_reporting_unit
|
mapped_reporting_unit | ReportingUnitSummaryModel |
Отчет ReportingUnitSummary содержит сведения о коде и имени ReportingUnit, включая сводку по связанному отчету ReportingUnitType. |
|
Сопоставленный код единицы отчетности
|
map_type.mapped_reporting_unit_code | string |
Код соответствующего mappedReportingUnitType |
|
Сопоставленное имя единицы отчетов
|
map_type.mapped_reporting_unit_name | string |
Имя соответствующего mappedReportingUnitType. |
UnitsModel
Единицы указывают, как должны быть выражены значения данных для меры.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
decimal_places
|
decimal_places | integer |
Число десятичных разрядов, к которым могут быть выражены данные. |
|
units_are_prefix
|
units_are_prefix | boolean |
Следует ли применять единицы в качестве префикса или суффикса к значению данных. Например, $ (префикс) и % (суффикс). |
|
units_display
|
units_display | string |
Символ отображения или текст для единиц. Для единиц без символа это значение равно NULL. |
|
units_name
|
units_name | string |
Имя соответствующих единиц. |
MetaTagTypeModel
MetaTagType указывает тип для ряда метатаг и выступает в качестве группирования MetaTag.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код типа мета тега
|
meta_tag_type_code | string |
Код соответствующего MetaTagType. |
|
Код типа мета тега
|
meta_tag_type_name | string |
Имя соответствующего MetaTagType. |
MetaTagModel
MetaTag — это категория группирования, которая может применяться к measure, ReportingMeasure, ReportingUnit или DataSet.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код мета тега
|
meta_tag_code | string |
Код, представляющий MetaTag. |
|
Имя тега метаданных
|
meta_tag_name | string |
Отображаемый текст для MetaTag. |
|
meta_tag_type
|
meta_tag_type | MetaTagTypeModel |
MetaTagType указывает тип для ряда метатаг и выступает в качестве группирования MetaTag. |
MeasureSummaryModel
Функция MeasureSummaryModel содержит только код и имя меры без дополнительных полей.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код измерения
|
measure_code | string |
Код соответствующего измерения. |
|
Имя меры
|
measure_name | string |
Имя соответствующего измерения. |
ОтчетMeasureSummaryModel
ОтчетMeasureSummary содержит сведения о коде и имени объекта ReportedMeasure, включая сводку связанной меры.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
measure_summary
|
measure_summary | MeasureSummaryModel |
Функция MeasureSummaryModel содержит только код и имя меры без дополнительных полей. |
|
Код сообщаемой меры
|
reported_measure_code | string |
Код соответствующего отчетногоMeasure. |
|
Имя сообщаемой меры
|
reported_measure_name | string |
Имя соответствующего объекта ReportedMeasure. |
DatasetModel
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Предостережения
|
caveats | array of CaveatModel |
Список предостережения, применимых к этому набору данных. Этот список будет пустым, если нет предостережения. |
|
Идентификатор набора данных
|
data_set_id | integer |
Идентификатор набора данных. |
|
Имя набора данных
|
data_set_name | string |
Отображаемое имя соответствующего набора данных. |
|
meta_tags
|
meta_tags | array of MetaTagModel |
Список метаданных, применимых к этому набору данных. Этот список будет пустым, если метаданные отсутствуют. |
|
reported_measure_summary
|
reported_measure_summary | ReportedMeasureSummaryModel |
ОтчетMeasureSummary содержит сведения о коде и имени объекта ReportedMeasure, включая сводку связанной меры. |
|
Дата окончания отчета
|
reporting_end_date | string |
Дата окончания периода данных DataSet. |
|
Дата начала отчетов
|
reporting_start_date | string |
Дата начала периода данных DataSet. |
ПодавлениеModel
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Код подавления
|
suppression_code | string |
Код соответствующего подавления |
|
Отображаемое значение подавления
|
suppression_display_value | string |
Отображаемое значение или символ для соответствующего подавления. Если подавление не имеет символа, это поле будет иметь значение NULL. |
|
Сноска подавления
|
suppression_footnote | string |
Текст сноски и объяснения соответствующего подавления. Если подавление не содержит текста, это поле будет иметь значение NULL. |
|
Имя подавления
|
suppression_name | string |
Имя соответствующего подавления. |
FormattedDataExtractModel
Элемент FormattedDataExtract — это неструктурированная структура, которая инкапсулирует один Объект DataItem и включает форматированное отображаемое значение и связанные атрибуты DataItem.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
предостережение
|
caveat | string |
Символы предостережения, применимые к этому DataItem. Это значение равно null, если нет предостережения. |
|
caveat_codes
|
caveat_codes | string |
Разделенный запятой список кодов кавыка, применимых к этому DataItem. Это значение равно null, если нет предостережения. |
|
caveat_footnotes
|
caveat_footnotes | string |
Разделенный запятой список символов предостережения и их пояснительные сноски, применимые к этому DataItem. Это значение равно null, если нет предостережения. |
|
data_set_caveat
|
data_set_caveat | string |
Символы предостережения, применимые к соответствующему набору данных. Это значение равно null, если нет предостережения. |
|
data_set_caveat_codes
|
data_set_caveat_codes | string |
Разделенный запятой список кодов предостережения, применимых к соответствующему набору данных. Это значение равно null, если нет предостережения. |
|
data_set_caveat_footnotes
|
data_set_caveat_footnotes | string |
Разделенный запятой список символов предостережения и их пояснительные сноски, применимые к соответствующему набору данных. Это значение равно null, если нет предостережения. |
|
data_period
|
data_period | string |
Отформатированный вывод периода данных, включая даты начала и окончания. |
|
data_period_type
|
data_period_type | string |
Описание типа периода данных, например FinancialYear. |
|
data_set_id
|
data_set_id | integer |
Идентификатор соответствующего набора данных. |
|
data_set_meta_tag_codes
|
data_set_meta_tag_codes | string |
Разделенный запятой список кодов метатегов для соответствующего набора данных. Это значение будет иметь значение NULL, если метаданные набора данных отсутствуют. |
|
data_set_meta_tags
|
data_set_meta_tags | string |
Разделенный запятой список значений MetaTag для соответствующего набора данных. Это значение будет иметь значение NULL, если метаданные набора данных отсутствуют. |
|
data_set_meta_tags_with_type
|
data_set_meta_tags_with_type | string |
Разделенный запятой список значений MetaTag для соответствующего набора данных. Каждое значение MetaTag соответствует шаблону MetaTagTypeCode|MetaTagValue. Это значение будет иметь значение NULL, если метаданные набора данных отсутствуют. |
|
formatted_peer_value
|
formatted_peer_value | string |
Отформатированный отображение значения одноранговых данных, включая любые предупреждения и единицы. Это значение равно null, если одноранговый узел отсутствует. |
|
formatted_value
|
formatted_value | string |
Отформатированный вывод значения данных, включая любые предупреждения и единицы. |
|
group_number
|
group_number | string |
Указывает квинтил, декиль или другое число группирования для значения данных. Это значение равно NULL, если оно не применимо. |
|
частный
|
private | boolean |
Указывает, является ли этот ReportingUnit частным, например частной больницей. |
|
mapped_local_hospital_network
|
mapped_local_hospital_network | string |
Имя LHN для соответствующего связанного LHN reportingUnit. Это значение равно null, если в ReportingUnit нет сопоставленного LHN. |
|
mapped_primary_health_network
|
mapped_primary_health_network | string |
Имя PHN для соответствующего связанного phN ReportingUnit. Это значение будет иметь значение NULL, если в ReportingUnit нет сопоставленного PHN. |
|
mapped_state
|
mapped_state | string |
Сокращение состояния соответствующего состояния ReportingUnit. |
|
measure_category_code
|
measure_category_code | string |
Код связанного measureCategory. |
|
measure_category_name
|
measure_category_name | string |
Имя связанного объекта MeasureCategory. |
|
measure_code
|
measure_code | string |
Код связанной меры. |
|
measure_meta_tag_codes
|
measure_meta_tag_codes | string |
Разделенный запятой список кодов метатегов для соответствующей меры. Это значение будет иметь значение NULL, если метаданные мер отсутствуют. |
|
measure_meta_tags
|
measure_meta_tags | string |
Разделенный запятой список значений MetaTag для соответствующей меры. Это значение будет иметь значение NULL, если метаданные мер отсутствуют. |
|
measure_meta_tags_with_type
|
measure_meta_tags_with_type | string |
Разделенный запятой список значений MetaTag для соответствующей меры. Каждое значение MetaTag соответствует шаблону MetaTagTypeCode|MetaTagValue. Это значение будет иметь значение NULL, если метаданные мер отсутствуют. |
|
measure_name
|
measure_name | string |
Имя связанной меры. |
|
peer_group_code
|
peer_group_code | string |
Код связанной одноранговой группы. Это значение равно null, если одноранговый узел отсутствует. |
|
peer_group_name
|
peer_group_name | string |
Имя связанной одноранговой группы. Это значение равно null, если одноранговый узел отсутствует. |
|
proxy_reporting_unit_name
|
proxy_reporting_unit_name | string |
Имя единицы отчетов прокси-сервера, которая сообщает от имени связанного reportingUnit. Это значение будет иметь значение NULL, если нет отчетов прокси-сервера. |
|
raw_lower_value
|
raw_lower_value |
Представляет меньшее значение данных, если этот DataItem является диапазоном данных или имеет доверительный интервал, в противном случае это значение равно NULL. |
|
|
raw_peer_value
|
raw_peer_value |
Значение одноранговых данных для этого DataItem. Это может быть null, если одноранговые данные подавляются или нет однорангового узла. |
|
|
raw_upper_value
|
raw_upper_value |
Представляет верхнее значение данных, если этот dataItem является диапазоном данных или имеет доверительный интервал, в противном случае это значение равно NULL. |
|
|
raw_value
|
raw_value | double |
Значение данных для этого элемента. Это значение данных может иметь значение NULL, если данные подавляются, в этом случае в списке предостережения будет присутствовать предостережение. |
|
reported_measure_category_code
|
reported_measure_category_code | string |
Код для первой категории ReportedMeasure. |
|
reported_measure_category_name
|
reported_measure_category_name | string |
Имя первой категории ReportedMeasure |
|
reported_measure_category_three_code
|
reported_measure_category_three_code | string |
Код третьей категории ReportedMeasure. Это значение будет иметь значение NULL, если в ОтчетеMeasure нет 3 категории. |
|
reported_measure_category_three_name
|
reported_measure_category_three_name | string |
Имя третьей категории ReportedMeasure. Это значение будет иметь значение NULL, если в ОтчетеMeasure нет 3 категории. |
|
reported_measure_category_two_code
|
reported_measure_category_two_code | string |
Код для второй категории ReportedMeasure. Это значение будет иметь значение NULL, если в ОтчетеMeasure нет двух категорий. |
|
reported_measure_category_two_name
|
reported_measure_category_two_name | string |
Имя второй категории ReportedMeasure. Это значение будет иметь значение NULL, если в ОтчетеMeasure нет двух категорий. |
|
reported_measure_category_type_code
|
reported_measure_category_type_code | string |
Код для первой категории ReportedMeasure. |
|
reported_measure_category_type_name
|
reported_measure_category_type_name | string |
Имя первого типа категории ReportedMeasure. |
|
reported_measure_category_three_type_code
|
reported_measure_category_three_type_code | string |
Код для третьего типа категории ReportedMeasure. Это значение будет иметь значение NULL, если в ОтчетеMeasure нет 3 категории. |
|
reported_measure_category_three_type_name
|
reported_measure_category_three_type_name | string |
Имя третьего типа категории ReportedMeasure. Это значение будет иметь значение NULL, если в ОтчетеMeasure нет 3 категории. |
|
reported_measure_category_two_type_code
|
reported_measure_category_two_type_code | string |
Код второго типа категории ReportedMeasure. Это значение будет иметь значение NULL, если в ОтчетеMeasure нет двух категорий. |
|
reported_measure_category_two_type_name
|
reported_measure_category_two_type_name | string |
Имя второго типа категории ReportedMeasure. Это значение будет иметь значение NULL, если в ОтчетеMeasure нет двух категорий. |
|
reported_measure_code
|
reported_measure_code | string |
Код для связанного СообщенияMeasure. |
|
reported_measure_meta_tag_codes
|
reported_measure_meta_tag_codes | string |
Разделенный запятой список кодов MetaTag для соответствующего объекта ReportedMeasure. Это значение будет иметь значение NULL, если нет метаданных ReportedMeasure. |
|
reported_measure_meta_tags
|
reported_measure_meta_tags | string |
Разделенный запятой список значений MetaTag для соответствующего объекта ReportedMeasure. Это значение будет иметь значение NULL, если нет метаданных ReportedMeasure. |
|
reported_measure_meta_tags_with_type
|
reported_measure_meta_tags_with_type | string |
Разделенный запятой список значений MetaTag для соответствующего объекта ReportedMeasure. Каждое значение MetaTag соответствует шаблону MetaTagTypeCode|MetaTagValue. Это значение будет иметь значение NULL, если нет метаданных ReportedMeasure. |
|
reported_measure_name
|
reported_measure_name | string |
Имя связанного объекта ReportedMeasure. |
|
reporting_end_date
|
reporting_end_date | string |
Дата окончания периода данных DataSet. |
|
reporting_start_date
|
reporting_start_date | string |
Дата начала периода данных DataSet. |
|
reporting_unit_code
|
reporting_unit_code | string |
Код для связанного ReportingUnit. |
|
reporting_unit_meta_tag_codes
|
reporting_unit_meta_tag_codes | string |
Разделенный запятой список кодов Метатег для соответствующего отчета ReportingUnit. Это значение будет иметь значение NULL, если метаданные ReportingUnit отсутствуют. |
|
reporting_unit_meta_tags
|
reporting_unit_meta_tags | string |
Разделенный запятой список значений MetaTag для соответствующего отчета ReportingUnit. Это значение будет иметь значение NULL, если метаданные ReportingUnit отсутствуют. |
|
reporting_unit_meta_tags_with_type
|
reporting_unit_meta_tags_with_type | string |
Разделенный запятой список значений MetaTag для соответствующего отчета ReportingUnit. Каждое значение MetaTag соответствует шаблону MetaTagTypeCode|MetaTagValue. Это значение будет иметь значение NULL, если метаданные ReportingUnit отсутствуют. |
|
reporting_unit_name
|
reporting_unit_name | string |
Имя связанного reportingUnit. |
|
reporting_unit_type_code
|
reporting_unit_type_code | string |
Код для связанного объекта ReportingUnitType. |
|
reporting_unit_type_name
|
reporting_unit_type_name | string |
Имя связанного объекта ReportingUnitType. |
|
подавление
|
suppression | string |
Символы подавления, применимые к этому DataItem. Это значение будет иметь значение NULL, если нет подавления |
|
suppression_codes
|
suppression_codes | string |
Разделенный запятой список кодов подавления, применимых к этому DataItem. Это значение будет иметь значение NULL, если нет подавлений. |
DataExtractPagination
Предоставляет сведения о разбивке на страницы для набора результатов с разбивкой на страницы.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
results_returned
|
results_returned | integer |
Количество результатов, возвращаемых в этом ответе. |
|
starting_result_index
|
starting_result_index | integer |
Индекс начального результата в этом списке. Это соответствует пропуску + 1 из запроса на разбиение на страницы. |
|
total_results_available
|
total_results_available | integer |
Общее количество результатов, доступных с помощью разбиения на страницы. |
PaginatedFormattedDataExtractModel
Набор результатов с разбивкой на страницы, содержащий список элементов FormattedDataExtract и сведения о разбиении на страницы для запроса.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные
|
data | array of FormattedDataExtractModel |
Список элементов FormattedDataExtract. |
|
Разбивка на страницы
|
pagination | DataExtractPagination |
Предоставляет сведения о разбивке на страницы для набора результатов с разбивкой на страницы. |
DatasheetConfigurationSummaryModel
DatasheetConfigurationSummary содержит сведения о доступных таблицах для создания.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
datasheet_code
|
datasheet_code | string |
Код, используемый для указания скачивания таблицы. |
|
datasheet_description
|
datasheet_description | string |
Описание таблицы, которая будет создана с помощью этого кода. |
|
datasheet_type
|
datasheet_type | string |
Тип таблицы, которая будет создана с помощью этого кода. |
DataItemModel
DataItem инкапсулирует значение данных для определенного блока (ReportingUnit), охватывающего определенный период данных (DataSet).
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Предостережения
|
caveats | array of CaveatModel |
Список предостережения, применимых к этому DataItem. Этот список будет пустым, если нет предостережения. |
|
data_set_id
|
data_set_id | integer |
Идентификатор связанного набора данных. |
|
group_number
|
group_number | integer |
Указывает квинтил, декиль или другое число группирования для значения данных. Это значение равно NULL, если оно не применимо. |
|
lower_value
|
lower_value |
Представляет меньшее значение данных, если этот DataItem является диапазоном данных или имеет доверительный интервал, в противном случае это значение равно NULL. |
|
|
measure_code
|
measure_code | string |
Код связанной меры. |
|
peer_group_summary
|
peer_group_summary | ReportingUnitSummaryModel |
Отчет ReportingUnitSummary содержит сведения о коде и имени ReportingUnit, включая сводку по связанному отчету ReportingUnitType. |
|
proxy_reporting_unit_summary
|
proxy_reporting_unit_summary | ReportingUnitSummaryModel |
Отчет ReportingUnitSummary содержит сведения о коде и имени ReportingUnit, включая сводку по связанному отчету ReportingUnitType. |
|
reported_measure_code
|
reported_measure_code | string |
Код для связанного СообщенияMeasure |
|
reporting_unit_summary
|
reporting_unit_summary | ReportingUnitSummaryModel |
Отчет ReportingUnitSummary содержит сведения о коде и имени ReportingUnit, включая сводку по связанному отчету ReportingUnitType. |
|
suppressions
|
suppressions | array of SuppressionModel |
Возвращает или задает подавление. |
|
Верхнее значение
|
upper_value | double |
Представляет верхнее значение данных, если этот dataItem является диапазоном данных или имеет доверительный интервал, в противном случае это значение равно NULL. |
|
value
|
value | double |
Значение данных для этого DataItem. Это значение данных может иметь значение NULL, если данные подавляются, в этом случае в списке предостережения будет присутствовать предостережение. |
VersionInformation
Сведения о версии API
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Версия API
|
api_version | string |
Версия API |
|
Версия данных
|
data_version | integer |
Версия данных |
|
Дата отправки
|
date_uploaded | string |
Дата отправки данных |
|
Запрошенная метка времени
|
requested_time_stamp | string |
Метка времени запроса |