ГІПЕРПОСИЛАННЯ НА ЗАДАНІ НАБОРИ ДАНИХ ТА ЇХ РЕСУРСИ

Усі гіперпосилання, описувані в даному розділі, вказуються індивідуально в паспорті кожного опублікованого на порталі набору даних у наступних полях:

  1. Гіперпосилання на ресурси набору даних
  2. Гіперпосилання на паспорт та опис ресурсу набору даних

1) Гіперпосилання на ресурси набору даних для їхнього завантаження чи вибірки за допомогою server-side Web АРI

За допомогою цього гіперпосилання здійснюється вибірка інформації з заданих критеріїв із зазначеного ресурсу, що знаходитися в тім чи іншому наборі даних.

Гіперпосилання може містити, як параметри запиту, так і словник, що визначає номенклатуру, обсяги і специфіку об'єднання декількох ресурсів при поверненні значень за результатами зробленої вибірки.

Параметри запиту:

  • resource_id (змішаний формат) - ідентифікаційний номер, по якому здійснюється пошук необхідного набору даних (ресурсу)
  • filters (змішаний формат) - масив чи рядок, відповідно до якого формується вибірка даних з відповідного ресурсу в наборі даних
  • q (рядок) –  рядок для пошуку по тексту, завдяки якому формується вибірка зі співпадаючих з цим рядком рядків ресурсу в наборі даних*
  • offset (ціле) – кількість рядків, які потрібно пропустити в результаті запиту
  • limit (ціле) - максимальна кількість рядків, що повертаються, у результаті запиту (за замовчуванням: 100)
  • fields ( масив чи рядок найменувань полів, розділених комами) – поля, що будуть повернуті в результаті запиту (за замовчуванням повертаються всі поля в такому ж порядку, як вони представлені в ресурсі)
  • sort (рядок) – розділені комами найменування полів, за якими буде проводитися впорядковування в результаті запиту
  • join (масив) - масив найменувань полів з різних таблиць (ресурсів), що у результаті запиту повинні об'єднатися в єдину таблицю

Ключі словника при поверненні значень за результатами зробленої вибірки:

  • fields (список полів) - поля / колонки та метадані
  • offset (ціле) – значення зсуву запитів
  • limit (ціле) - граничне значення обсягу запиту
  • count (INT) - загальна кількість оброблюваних записів при формуванні запиту
  • records (список словників) - список результатів зіставлення

Нижче приведений приклад гіперпосилання, котрий виводить опис ресурсу, що входить у набір даних “Загальноосвітні навчальні заклади Одеської області” за рахунок зазначення в цьому гіперпосиланні ідентифікаційного номера відповідного ресурсу:

http://data.ngorg.od.ua/api/action/datastore/search.json?resource_id=9a747130-1c6b-46ba-ba99-9d8af72a6884

2) Гіперпосилання на паспорт і опис ресурсу набору даних

Дане гіперпосилання виводить паспорт і опис ресурсів для заданого набору даних. Це гіперпосилання має один єдиний параметр id, що вказує або на ідентифікаційний номер, або на найменування набору даних. Значення для цього параметра записується у форматі рядка.

Нижче приведений приклад гіперпосилання, котрий виводить паспорт і опис ресурсів для набору даних “Загальноосвітні навчальні заклади Одеської області” за рахунок зазначення в цьому гіперпосиланні ідентифікаційного номера цього набору даних:

http://data.ngorg.od.ua/api/3/action/package_show?id=f16110a5-acdd-43f9-a7c7-055f766d671e