1.Получение контента
Получение контента осуществляется с помощью функциии:
await getContents(
{
...args
})
В качестве аргументов функция getContent может получать:
- _id: 'id контента' - (string | array[string]),
- authorId: 'id автора' - (string | array[string]),
- contentTypeId: 'id типов материалов' - (string | array[string]),
- searchFields (object) - это объект, который используется для настройки поиска по определенным полям в базе данных или другом источнике данных. Поиск по полям может быть полезен, когда вы хотите ограничить результаты поиска только теми записями, которые содержат определенное значение в конкретном поле.
Пример поиска по полям:
searchFields: {
field_name: {
value: 'Значение'
}
}
2.Получение зависимого контента
По аналогии с получением контента получить зависимый контент позволяет:
await getDependentContents(
{
...args
})
В качестве аргументов могут выступать:
- _id: 'id контента' - (string | array[string]),
- authorId: 'id автора' - (string | array[string]),
- contentTypeId: 'id типов материалов' - (string | array[string]),
- searchFields - поиск по полям (object)
- relatedFieldId: 'id поля родительского типа материала, с которым связан зависимый контент' - (array[string])
3.Создание контента
Создание контента осуществляется командой:
await createContent(
{
...args
})
Обязательными аргументами функции являются
-
fields - поля типа материала:
"fields": { "field_name": value }Отдельные поля указываются, как машинные имена полей.
-
contentTypeId: 'id типа материала'.
4.Обновление контента
Обновление контента осуществляется командой:
await updateContent(
{
...args
})
В отличие от создания контента contentTypeId не является обязательным аргументом при обновлении данных. Поэтому при обновлении контента достаточно будет указать обновляемые поля - fields:
`"fields": {
"field_name": value
}`
5.Удаление контента
Удаление контента осуществляется посредством функции:
await deleteManyContents(
{
...args
})
Внутри функции указывается id типа материала или массив данных, которые должны удаляться:
_id: 'id [типа материала](/ru/home/tables)' | [id1, id2, id3]
6.Создание зависимого контента
Создание зависимого контента осуществляется командой:
await createDependentContent(
{
}
- fields {...} - поля создаваемого контента
- contentTypeId: 'id типа материала' (string)
- relatedContentId: 'ID родительского типа материала' (string)
- relatedFieldId: 'ID поля родительского типа материала, с которым связан зависимый контент' (string)
7.Запись в журнал
Для настройки отображения записи событий журнал используется функция:
{
writeLog(data)
}
Данные, указанные в качестве переменной отображаются в поле результат в журнале.
8.Уведомления
Для настройки уведомлений используется сервис:
notify(
{
name: 'Наименование уведомления',
message: data,
type: 'task',
userId: 'id пользователя',
authorId: 'id автора',
projectId: 'id проекта'
}
)
message - это текст сообщения в уведомлении. Можно настроить текстовое сообщение 'сообщение' или указать путь к данным об авторе сообщения или чате с автором;
type - тип уведомления
userId - Id пользователя, которому будет отправлено уведомление;
authorId - Id автора уведомления. Автоматически проставляется в соответствии с API ключом, указанным при создании скрипта. Так, authorId соответствует Id автора скрипта. Автором действий, произведенных скриптом, будет автор скрипта;
projectId - Id проекта, связанного с задачей;