83. Запит: зібрати контекст платформи

При великій кількості (сотні або тисячі) оброблених наборів даних (наприклад, «SatelliteImage», «AsAppliedDataset», «YieldDataset», «SoilDataset» тощо) завжди є потреба розуміти статус обробки кожного набору даних та збирати підсумки обробки. Ці деталі надаються за допомогою getPlatformContext запиту.

Поширені випадки:

• Відстеження прогресу обробки

• Збір підсумків та статистики обробки

• Спостереження помилок та попереджень під час обробки для подальшого глибшого дослідження уражених наборів даних

query CollectPlatformContext {
 getPlatformContext(input: {
   userUuids: ["<placeholder_of_user_uuid>"],
   statuses: [Start, Done, Warning, Error, Ignored],
   dateFrom: "2023-05-25T12:49:00.000Z", 
   dateTo: "2023-05-30T06:35:00.000Z", 
 }) {
   events {
     fieldUuid
     subFieldUuid
     subFieldType
     operationId
     status 
     executionDate
     messageKey
     optional
   }
 }
}

Підтримувані вхідні фільтри:

• dateFrom як datetime у форматі ISO 8601 (наприклад: "2023-05-25T12:49:00.000Z")

• dateTo як datetime у форматі ISO 8601 (наприклад: "2023-05-30T06:35:00.000Z")

• operationIds як масив ідентифікаторів операцій (Строки)

• statuses як масив значень із ContextEventStatus перелічення з усіма статусами обробки, включно з проміжними; рекомендовано використовувати ключові [Start, Done, Warning, Error, Ignored]

• subFieldTypes як масив значень типів TreeNodeEntity перелічення з усіма сутностями GeoPard

• subFieldUuids як масив UUID, пов’язаних з обраними сутностями в subFieldTypes

• userUuids як масив UUID користувачів для пошуку

Повинно бути ініціалізовано принаймні один із наступних фільтрів: userUuids, fieldUuids, subFieldUuids, або operationIds.

Якщо dateFrom та dateTo не вказані, тривалість запиту за замовчуванням встановлюється на 12 годин. Максимально рекомендований проміжок часу для отримання даних — 24 години.

Існує обмеження на максимум 10 000 рядків, що повертаються.

Щоб переглянути всі доступні останні значення перерахувань (наприклад: TreeNodeEntity, ContextEventStatus, ContextMessageKey), рекомендовано використовувати Altair.

Вихідний об’єкт включає такі атрибути:

• fieldUuid представляє UUID пов’язаного поля

• subFieldUuid позначає UUID пов’язаного обробленого набору даних (наприклад «SatelliteImage», «AsAppliedDataset», «YieldDataset», «SoilDataset» тощо)

• subFieldType як перелічення, пов’язане з TreeNodeEntity

• operationId як рядок, що містить ідентифікатор операції; він залишається сталим у всіх пов’язаних ланцюжках обробки, рекомендовано групувати за цим ідентифікатором для відстеження усіх етапів обробки

• status як перелічення, пов’язане з ContextEventStatus

• executionDate як рядок у форматі ISO 8601, що позначає момент виконання

• messageKey як перелічення, пов’язане з ContextMessageKey який описує результат виконання

• optional як рядок, що надає технічний опис (якщо є), використовується головним чином для налагодження та повідомлення про помилки