Налаштування та теги

Атрибути, набори атрибутів, правила та теги — розширюйте об'єкти Flowtly власними полями.

Цей довідник згенеровано зі схеми API. Описи полів і будь-який текст, який ще не перекладено, показано англійською.

Атрибут

Endpoints

Атрибут: Endpoints
Метод	Шлях	Опис
GET	/attributes	Отримує колекцію ресурсів Attribute.
POST	/attributes	Створює ресурс Attribute.
GET	/attributes/{id}	Отримує ресурс Attribute.
PATCH	/attributes/{id}	Оновлює ресурс Attribute.
DELETE	/attributes/{id}	Видаляє ресурс Attribute.
POST	/attributes/{id}/cascade-weighing	Створює ресурс Attribute.

Поля схеми

Атрибут: Поля схеми
Поле	Тип	Опис
name*	string
type*	string
shift	integer
required	boolean
multiple	boolean
defaultValue	stringnull
formatPattern	stringnull

Тег

Endpoints

Тег: Endpoints
Метод	Шлях	Опис
GET	/tags	Отримує колекцію ресурсів Tag.
POST	/tags	Створює ресурс Tag.
GET	/tags/{id}	Отримує ресурс Tag.
DELETE	/tags/{id}	Видаляє ресурс Tag.

Поля схеми

Тег: Поля схеми
Поле	Тип	Опис
entityMapping	array
id	string
tagDefinition*	string (iri-reference)
relationName	string
relationId*	string
weight	string
createdAt	string (date-time)
updatedAt	string (date-time)
possibleRelationNames	string

Значення атрибута

Endpoints

Значення атрибута: Endpoints
Метод	Шлях	Опис
GET	/attribute-entity-values	Отримує колекцію ресурсів AttributeValue.
POST	/attribute-entity-values	Створює ресурс AttributeValue.
GET	/attribute-entity-values/{id}	Отримує ресурс AttributeValue.
PATCH	/attribute-entity-values/{id}	Оновлює ресурс AttributeValue.
DELETE	/attribute-entity-values/{id}	Видаляє ресурс AttributeValue.
GET	/attribute-values	Отримує колекцію ресурсів AttributeValue.
POST	/attribute-values	Створює ресурс AttributeValue.
GET	/attribute-values/{id}	Отримує ресурс AttributeValue.
PATCH	/attribute-values/{id}	Оновлює ресурс AttributeValue.
DELETE	/attribute-values/{id}	Видаляє ресурс AttributeValue.

Поля схеми

Значення атрибута: Поля схеми
Поле	Тип	Опис
id	string
attribute*	string (iri-reference)
relationName	string
relationId*	string
value*	string
dateFrom	string,null (date-time)
dateTo	string,null (date-time)

Набір атрибутів

Endpoints

Набір атрибутів: Endpoints
Метод	Шлях	Опис
GET	/attribute-sets	Отримує колекцію ресурсів AttributeSet.
POST	/attribute-sets	Створює ресурс AttributeSet.
GET	/attribute-sets/{id}	Отримує ресурс AttributeSet.
PATCH	/attribute-sets/{id}	Оновлює ресурс AttributeSet.
DELETE	/attribute-sets/{id}	Видаляє ресурс AttributeSet.

Поля схеми

Набір атрибутів: Поля схеми
Поле	Тип	Опис
name*	string
relationName*	string
icon	stringnull

Атрибут набору атрибутів

Endpoints

Атрибут набору атрибутів: Endpoints
Метод	Шлях	Опис
GET	/attribute-set-attributes	Отримує колекцію ресурсів AttributeSetAttribute.
POST	/attribute-set-attributes	Створює ресурс AttributeSetAttribute.
GET	/attribute-set-attributes/{id}	Отримує ресурс AttributeSetAttribute.
PATCH	/attribute-set-attributes/{id}	Оновлює ресурс AttributeSetAttribute.
DELETE	/attribute-set-attributes/{id}	Видаляє ресурс AttributeSetAttribute.

Поля схеми

Атрибут набору атрибутів: Поля схеми
Поле	Тип	Опис
id	string
attributeSet*	object
attribute*	object
required	boolean
implicitUnitQuantity	boolean

Правило атрибута

Endpoints

Правило атрибута: Endpoints
Метод	Шлях	Опис
GET	/attribute-rules	Отримує колекцію ресурсів AttributeRule.
POST	/attribute-rules	Створює ресурс AttributeRule.
GET	/attribute-rules/{id}	Отримує ресурс AttributeRule.
PATCH	/attribute-rules/{id}	Оновлює ресурс AttributeRule.
DELETE	/attribute-rules/{id}	Видаляє ресурс AttributeRule.

Поля схеми

Правило атрибута: Поля схеми
Поле	Тип	Опис
attributeSet*	string,null (iri-reference)
attribute	string,null (iri-reference)
name*	string

Ціна атрибута

Endpoints

Ціна атрибута: Endpoints
Метод	Шлях	Опис
GET	/attribute-prices	Отримує колекцію ресурсів AttributePrice.
POST	/attribute-prices	Створює ресурс AttributePrice.
GET	/attribute-prices/{id}	Отримує ресурс AttributePrice.
PATCH	/attribute-prices/{id}	Оновлює ресурс AttributePrice.
DELETE	/attribute-prices/{id}	Видаляє ресурс AttributePrice.

Поля схеми

Ціна атрибута: Поля схеми
Поле	Тип	Опис
attributeRule*	string (iri-reference)
amount*	string
currency*	string (iri-reference)
dateFrom*	string,null (date-time)

Визначення тега

Endpoints

Визначення тега: Endpoints
Метод	Шлях	Опис
GET	/tag-definitions	Отримує колекцію ресурсів TagDefinition.
POST	/tag-definitions	Створює ресурс TagDefinition.
GET	/tag-definitions/{id}	Отримує ресурс TagDefinition.
PATCH	/tag-definitions/{id}	Оновлює ресурс TagDefinition.
DELETE	/tag-definitions/{id}	Видаляє ресурс TagDefinition.
GET	/tag-definitions/autocomplete	Отримує колекцію ресурсів TagDefinition.

Поля схеми

Визначення тега: Поля схеми
Поле	Тип	Опис
id	string
name*	string
level*	integer
label	string
tagGroup*	string (iri-reference)
createdAt	string (date-time)
updatedAt	string (date-time)

Група тегів

Endpoints

Група тегів: Endpoints
Метод	Шлях	Опис
GET	/tag-groups	Отримує колекцію ресурсів TagGroup.
POST	/tag-groups	Створює ресурс TagGroup.
GET	/tag-groups/{id}	Отримує ресурс TagGroup.
PATCH	/tag-groups/{id}	Оновлює ресурс TagGroup.

Поля схеми

Група тегів: Поля схеми
Поле	Тип	Опис
id	string
name*	string
code	string
allowedRelations	arraynull

Умова

Endpoints

Умова: Endpoints
Метод	Шлях	Опис
GET	/condition/{month}/contractor-groups	Отримує колекцію ресурсів Condition.
GET	/condition/{month}/contractors	Отримує колекцію ресурсів Condition.
GET	/condition/{month}/holidays	Отримує колекцію ресурсів Condition.
GET	/condition/{month}/projects	Отримує колекцію ресурсів Condition.

Політика

Endpoints

Політика: Endpoints
Метод	Шлях	Опис
GET	/policies	Отримує колекцію ресурсів Policy.
POST	/policies	Створює ресурс Policy.
GET	/policies/{id}	Отримує ресурс Policy.
PATCH	/policies/{id}	Оновлює ресурс Policy.
DELETE	/policies/{id}	Видаляє ресурс Policy.

Поля схеми

Політика: Поля схеми
Поле	Тип	Опис
id	integer
slug*	string	The cross-link target. `[[urlop-na-zadanie]]` in any policy body resolves to the policy holding this slug, which is why it is immutable in practice even though nothing stops a PATCH: renaming it breaks every link pointing at it, and the pages that link are not tracked in reverse.
title*	string
versions	array	Newest first, so the collection reads as a history and `[0]` is the most recently dated version — NOT necessarily the one in force, which is the newest whose effectiveFrom has arrived. Resolving that is PolicyVersionResolver's job, and the distinction is the point: a version can be published today to take effect next month.
createdAt	string (date-time)
updatedAt	string (date-time)
deletedAt	string,null (date-time)
deleted	boolean	Check if the entity has been soft deleted.

Версія політики

Endpoints

Версія політики: Endpoints
Метод	Шлях	Опис
GET	/policy-versions	Отримує колекцію ресурсів PolicyVersion.
POST	/policy-versions	Створює ресурс PolicyVersion.
GET	/policy-versions/{id}	Отримує ресурс PolicyVersion.

Поля схеми

Версія політики: Поля схеми
Поле	Тип	Опис
id	integer
policy*	string (iri-reference)
body*	string	Markdown, stored raw. Cross-links are `[[slug]]` and are NOT resolved on write: a policy may legitimately reference one that has not been written yet, which is how a wiki is drafted. PolicyLinkExtractor reads them back out so a reader can be shown which targets do not exist, instead of the writer being blocked at save time.
effectiveFrom*	string (date-time)	The date the wording starts applying. Not the date it was written.