Использование API для конфигураций

Клиент configuration, содержащийся в пакете, позволяет работать с конфигурациями в системе, используя описанные ниже методы.

Методы API для работы с конфигурациями включают:

Создание конфигурации (create)
Получение списка конфигураций (list)
Получение конфигурации (get)
Изменение и обновление конфигурации (update)
Удаление конфигурации (delete)

Описания и примеры приведены для TypeScript (среда выполнения Deno) и Python.

Подготовка клиента для работы с переменными

Чтобы работать с переменными с помощью пакета SDK, импортируйте его:

Синтаксис импорта в TypeScript

import * as sdk from '@playbooks/sdk'
...
export async function main() {
...
  const v = await sdk.configuration.<method_name>(<arg_1>, <arg_2>, ..., <arg_m>)
  console.log(v)
...
}

Синтаксис импорта в Python

from playbooks.configuration import ConfigurationClient

...
def main():
...
    client = ConfigurationClient.initialize()
    v = client.<method_name>(<arg_1>, <arg_2>, ..., <arg_m>)
    print(v)
...

Здесь:

<method_name>: имя используемого метода;
<arg_N>: параметры метода.

Объект конфигурации

Методы, возвращающие конфигурации, предоставляют объект со следующими полями:

<id>: идентификатор конфигурации (строка).
<schemaVersion>: версия схемы конфигурации (строка).
<name>: имя конфигурации (строка).
<description> (необязательный): описание конфигурации (строка).
<status>: статус конфигурации:
- для TypeScript: enabled — включена или disabled — выключена (строка).
- для Python: True — включена или False — выключена (логическое значение).
<tenantId> — идентификатор тенанта (строка)
<data>: значения полей конфигурации. Структура каждого поля зависит от его типа.

Создание конфигурации (`create`)

Метод create используется для создания новой конфигурации.

Синтаксис create в TypeScript

create({
  sourceId: <source_id>, // string
  schemaId: <schema_id>, // string
  name: <name>, // string
  description: <description>, // string | undefined
  status: <status>, // Enum | undefined
  data:
    [
      {
        key: '<key>', // string
        value: <value> // any
      },
      ...
   ]
})

Синтаксис create в TypeScript

create(
    source_id=<source_id>, # str
    schema_id=<schema_id>, # str
    name=<name>, # str
    description=<description>, # str | None
    enabled=<status>, # bool
    data={ # Dict[str, Any]
        "<key>": <value>,
        ...
    }
)

Параметры метода включают в себя:

<source_id>: идентификатор конфигурации (строка).
<schema_id>: идентификатор схемы конфигурации (строка).
<name>: имя конфигурации (строка).
<description> (необязательный): описание конфигурации (строка).
<status>: статус конфигурации:
- для TypeScript: enabled — включена или disabled — выключена (строка).
- для Python: True — включена или False — выключена (логическое значение).
<key> — ключ поля конфигурации.
<value> — значение поля конфигурации. Структура поля зависит от его типа.

Метод возвращает идентификатор созданной конфигурации.

Получение конфигурации (`get`)

Метод используется для получения конфигурации по ее идентификатору.

Синтаксис get в TypeScript

get({
  id: <id> // string
})

Синтаксис get в Python

get(
    id=<id> # str
)

В методе используется параметр <id> — идентификатор конфигурации (строка).

Метод get возвращает объект конфигурации.

Получение списка конфигураций (`list`)

Метод используется для получения списка конфигураций по массиву их идентификаторов.

Синтаксис list в TypeScript

list({
  sourceIds: <source_ids> // string[]
})

Синтаксис list в Python

list(
    ids=<source_ids> # List[str]
)

Параметры метода включают в себя <source_ids> — список идентификаторов переменных, указанных при их создании (массив строк).

Метод list возвращает массив объектов конфигурации.

Изменение и обновление конфигурации (`update`)

Метод используется для изменения существующей конфигурации и обновления версии ее схемы.

Синтаксис update в TypeScript

update({
  sourceId: <source_id>, // string
  schemaId: <schema_id>, // string
  name: <name>, // string
  description: <description>, // string | undefined
  status: <status>, // Enum | undefined
  data:
    [
      {
        key: <key>, // string
        value: <value> // any
      },
      ...
   ],
  updateSchema: <update_schema_flag>
})

Синтаксис update в Python

update(
    source_id=<source_id>, # str
    schema_id=<schema_id>, # str
    name=<name>, # str
    description=<description>, # str | None
    enabled=<status>, # bool
    data={ # Dict[str, Any]
        "<key>": <value>,
        ...
    },
    update_schema: <update_schema_flag>
)

Параметры метода включают в себя:

<source_id>: идентификатор конфигурации (строка).
<schema_id>: идентификатор схемы конфигурации (строка).
<name>: имя конфигурации (строка).
<description> (необязательный): описание конфигурации (строка).
<status>: статус конфигурации:
- для TypeScript: enabled — включена или disabled — выключена (строка).
- для Python: True — включена или False — выключена (логическое значение).
<key> — ключ поля конфигурации.
<value> — значение поля конфигурации. Структура поля зависит от его типа.
<update_schema_flag> — переключатель обновления конфигурации до последней версии схемы (логическое значение).

Метод возвращает идентификатор измененной конфигурации.

Удаление конфигурации (`delete`)

Метод используется для удаления существующей конфигурации.

Синтаксис delete в TypeScript

delete({
  id: <source_id> // string
})

Синтаксис delete в Python

delete(
    id=<source_id> # str
)

В методе используется параметр <source_id> — идентификатор конфигурации, которую необходимо удалить (строка).

Метод возвращает идентификатор удаленной конфигурации.

Была ли полезна эта страница?

Обратная связь

Использование API для конфигураций

Подготовка клиента для работы с переменными

Объект конфигурации

Создание конфигурации (create)

Получение конфигурации (get)

Получение списка конфигураций (list)

Изменение и обновление конфигурации (update)

Удаление конфигурации (delete)

Создание конфигурации (`create`)

Получение конфигурации (`get`)

Получение списка конфигураций (`list`)

Изменение и обновление конфигурации (`update`)

Удаление конфигурации (`delete`)