Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Purpose

This WS allows to get rule engine field set for Rule engine rules configurator in Administration panel.

Key points

  1. This is a graphQl query method used in Administration panel only.

  2. Only authenticated and authorized NHS employee with can get rule engine field set.

Specification

Page Properties
idAPI_Specification

Link

API paragraph not found

Посилання на Apiary або Swagger

Resource

API paragraph not found

Посилання на ресурс, наприклад: /api/persons/create

Scope

API paragraph not found

Scope для доступу

Components

API paragraph not found

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

API paragraph not found

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

API paragraph not found

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

API paragraph not found

Метод є синхронним чи асинхронним?

Public/Private/Internal

Private

Потрібно зазначити тип методу за ступенем доступності

Expand
Code Block
"Reads a single `RuleEngineFieldSet`."
  ruleEngineFieldSet: JSON

Logic

  1. Create response with following fields:

...

3. Render a response according to schema.

Request structure

API paragraph not found

Autorize

API paragraph not found

Headers

  API paragraph not found

Request data validation

API paragraph not found

Processing

  API paragraph not found

Response structure

  API paragraph not found

Post-processing processes

  API paragraph not found

HTTP status codes

  API paragraph not found