Polska firma — tworzymy w Polsce

Dostosowanie i tagi

Atrybuty, zestawy atrybutów, reguły i tagi — rozszerzaj obiekty Flowtly o własne pola.

Ta dokumentacja jest generowana ze schematu API. Opisy pól oraz wszelkie teksty, które nie zostały jeszcze przetłumaczone, są wyświetlane po angielsku.

Atrybut

Endpoints

Atrybut: Endpoints
Metoda	Ścieżka	Opis
GET	/attributes	Pobiera kolekcję zasobów Attribute.
POST	/attributes	Tworzy zasób Attribute.
GET	/attributes/{id}	Pobiera zasób Attribute.
PATCH	/attributes/{id}	Aktualizuje zasób Attribute.
DELETE	/attributes/{id}	Usuwa zasób Attribute.
POST	/attributes/{id}/cascade-weighing	Tworzy zasób Attribute.

Pola schematu

Atrybut: Pola schematu
Pole	Typ	Opis
name*	string
type*	string
shift	integer
required	boolean
multiple	boolean
defaultValue	stringnull
formatPattern	stringnull

Tag

Endpoints

Tag: Endpoints
Metoda	Ścieżka	Opis
GET	/tags	Pobiera kolekcję zasobów Tag.
POST	/tags	Tworzy zasób Tag.
GET	/tags/{id}	Pobiera zasób Tag.
DELETE	/tags/{id}	Usuwa zasób Tag.

Pola schematu

Tag: Pola schematu
Pole	Typ	Opis
entityMapping	array
id	string
tagDefinition*	string (iri-reference)
relationName	string
relationId*	string
weight	string
createdAt	string (date-time)
updatedAt	string (date-time)
possibleRelationNames	string

Wartość atrybutu

Endpoints

Wartość atrybutu: Endpoints
Metoda	Ścieżka	Opis
GET	/attribute-entity-values	Pobiera kolekcję zasobów AttributeValue.
POST	/attribute-entity-values	Tworzy zasób AttributeValue.
GET	/attribute-entity-values/{id}	Pobiera zasób AttributeValue.
PATCH	/attribute-entity-values/{id}	Aktualizuje zasób AttributeValue.
DELETE	/attribute-entity-values/{id}	Usuwa zasób AttributeValue.
GET	/attribute-values	Pobiera kolekcję zasobów AttributeValue.
POST	/attribute-values	Tworzy zasób AttributeValue.
GET	/attribute-values/{id}	Pobiera zasób AttributeValue.
PATCH	/attribute-values/{id}	Aktualizuje zasób AttributeValue.
DELETE	/attribute-values/{id}	Usuwa zasób AttributeValue.

Pola schematu

Wartość atrybutu: Pola schematu
Pole	Typ	Opis
id	string
attribute*	string (iri-reference)
relationName	string
relationId*	string
value*	string
dateFrom	string,null (date-time)
dateTo	string,null (date-time)

Zestaw atrybutów

Endpoints

Zestaw atrybutów: Endpoints
Metoda	Ścieżka	Opis
GET	/attribute-sets	Pobiera kolekcję zasobów AttributeSet.
POST	/attribute-sets	Tworzy zasób AttributeSet.
GET	/attribute-sets/{id}	Pobiera zasób AttributeSet.
PATCH	/attribute-sets/{id}	Aktualizuje zasób AttributeSet.
DELETE	/attribute-sets/{id}	Usuwa zasób AttributeSet.

Pola schematu

Zestaw atrybutów: Pola schematu
Pole	Typ	Opis
name*	string
relationName*	string
icon	stringnull

Atrybut zestawu atrybutów

Endpoints

Atrybut zestawu atrybutów: Endpoints
Metoda	Ścieżka	Opis
GET	/attribute-set-attributes	Pobiera kolekcję zasobów AttributeSetAttribute.
POST	/attribute-set-attributes	Tworzy zasób AttributeSetAttribute.
GET	/attribute-set-attributes/{id}	Pobiera zasób AttributeSetAttribute.
PATCH	/attribute-set-attributes/{id}	Aktualizuje zasób AttributeSetAttribute.
DELETE	/attribute-set-attributes/{id}	Usuwa zasób AttributeSetAttribute.

Pola schematu

Atrybut zestawu atrybutów: Pola schematu
Pole	Typ	Opis
id	string
attributeSet*	object
attribute*	object
required	boolean
implicitUnitQuantity	boolean

Reguła atrybutu

Endpoints

Reguła atrybutu: Endpoints
Metoda	Ścieżka	Opis
GET	/attribute-rules	Pobiera kolekcję zasobów AttributeRule.
POST	/attribute-rules	Tworzy zasób AttributeRule.
GET	/attribute-rules/{id}	Pobiera zasób AttributeRule.
PATCH	/attribute-rules/{id}	Aktualizuje zasób AttributeRule.
DELETE	/attribute-rules/{id}	Usuwa zasób AttributeRule.

Pola schematu

Reguła atrybutu: Pola schematu
Pole	Typ	Opis
attributeSet*	string,null (iri-reference)
attribute	string,null (iri-reference)
name*	string

Cena atrybutu

Endpoints

Cena atrybutu: Endpoints
Metoda	Ścieżka	Opis
GET	/attribute-prices	Pobiera kolekcję zasobów AttributePrice.
POST	/attribute-prices	Tworzy zasób AttributePrice.
GET	/attribute-prices/{id}	Pobiera zasób AttributePrice.
PATCH	/attribute-prices/{id}	Aktualizuje zasób AttributePrice.
DELETE	/attribute-prices/{id}	Usuwa zasób AttributePrice.

Pola schematu

Cena atrybutu: Pola schematu
Pole	Typ	Opis
attributeRule*	string (iri-reference)
amount*	string
currency*	string (iri-reference)
dateFrom*	string,null (date-time)

Definicja tagu

Endpoints

Definicja tagu: Endpoints
Metoda	Ścieżka	Opis
GET	/tag-definitions	Pobiera kolekcję zasobów TagDefinition.
POST	/tag-definitions	Tworzy zasób TagDefinition.
GET	/tag-definitions/{id}	Pobiera zasób TagDefinition.
PATCH	/tag-definitions/{id}	Aktualizuje zasób TagDefinition.
DELETE	/tag-definitions/{id}	Usuwa zasób TagDefinition.
GET	/tag-definitions/autocomplete	Pobiera kolekcję zasobów TagDefinition.

Pola schematu

Definicja tagu: Pola schematu
Pole	Typ	Opis
id	string
name*	string
level*	integer
label	string
tagGroup*	string (iri-reference)
createdAt	string (date-time)
updatedAt	string (date-time)

Grupa tagów

Endpoints

Grupa tagów: Endpoints
Metoda	Ścieżka	Opis
GET	/tag-groups	Pobiera kolekcję zasobów TagGroup.
POST	/tag-groups	Tworzy zasób TagGroup.
GET	/tag-groups/{id}	Pobiera zasób TagGroup.
PATCH	/tag-groups/{id}	Aktualizuje zasób TagGroup.

Pola schematu

Grupa tagów: Pola schematu
Pole	Typ	Opis
id	string
name*	string
code	string
allowedRelations	arraynull

Warunek

Endpoints

Warunek: Endpoints
Metoda	Ścieżka	Opis
GET	/condition/{month}/contractor-groups	Pobiera kolekcję zasobów Condition.
GET	/condition/{month}/contractors	Pobiera kolekcję zasobów Condition.
GET	/condition/{month}/holidays	Pobiera kolekcję zasobów Condition.
GET	/condition/{month}/projects	Pobiera kolekcję zasobów Condition.

Polityka

Endpoints

Polityka: Endpoints
Metoda	Ścieżka	Opis
GET	/policies	Pobiera kolekcję zasobów Policy.
POST	/policies	Tworzy zasób Policy.
GET	/policies/{id}	Pobiera zasób Policy.
PATCH	/policies/{id}	Aktualizuje zasób Policy.
DELETE	/policies/{id}	Usuwa zasób Policy.

Pola schematu

Polityka: Pola schematu
Pole	Typ	Opis
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.

Wersja polityki

Endpoints

Wersja polityki: Endpoints
Metoda	Ścieżka	Opis
GET	/policy-versions	Pobiera kolekcję zasobów PolicyVersion.
POST	/policy-versions	Tworzy zasób PolicyVersion.
GET	/policy-versions/{id}	Pobiera zasób PolicyVersion.

Pola schematu

Wersja polityki: Pola schematu
Pole	Typ	Opis
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.