Anpassung & Tags

Attribute, Attributsets, Regeln und Tags — erweitern Sie Flowtly-Objekte um eigene Felder.

Attribute

Endpoints

GET	/attributes	Ruft die Sammlung der Attribute-Ressourcen ab.
POST	/attributes	Erstellt eine Attribute-Ressource.
GET	/attributes/{id}	Ruft eine Attribute-Ressource ab.
PATCH	/attributes/{id}	Aktualisiert die Attribute-Ressource.
DELETE	/attributes/{id}	Entfernt die Attribute-Ressource.
POST	/attributes/{id}/cascade-weighing	Erstellt eine Attribute-Ressource.

Schemafelder

Feld	Typ	Beschreibung
name*	string
type*	string
shift	integer
required	boolean
multiple	boolean
defaultValue	stringnull
formatPattern	stringnull

Tag

Endpoints

GET	/tags	Ruft die Sammlung der Tag-Ressourcen ab.
POST	/tags	Erstellt eine Tag-Ressource.
GET	/tags/{id}	Ruft eine Tag-Ressource ab.
DELETE	/tags/{id}	Entfernt die Tag-Ressource.

Schemafelder

Feld	Typ	Beschreibung
entityMapping	array
id	string
tagDefinition*	string (iri-reference)
relationName	string
relationId*	string
weight	string
createdAt	string (date-time)
updatedAt	string (date-time)
possibleRelationNames	string

Attributwert

Endpoints

GET	/attribute-entity-values	Ruft die Sammlung der AttributeValue-Ressourcen ab.
POST	/attribute-entity-values	Erstellt eine AttributeValue-Ressource.
GET	/attribute-entity-values/{id}	Ruft eine AttributeValue-Ressource ab.
PATCH	/attribute-entity-values/{id}	Aktualisiert die AttributeValue-Ressource.
DELETE	/attribute-entity-values/{id}	Entfernt die AttributeValue-Ressource.
GET	/attribute-values	Ruft die Sammlung der AttributeValue-Ressourcen ab.
POST	/attribute-values	Erstellt eine AttributeValue-Ressource.
GET	/attribute-values/{id}	Ruft eine AttributeValue-Ressource ab.
PATCH	/attribute-values/{id}	Aktualisiert die AttributeValue-Ressource.
DELETE	/attribute-values/{id}	Entfernt die AttributeValue-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
attribute*	string (iri-reference)
relationName	string
relationId*	string
value*	string
dateFrom	string,null (date-time)
dateTo	string,null (date-time)

Attributset

Endpoints

GET	/attribute-sets	Ruft die Sammlung der AttributeSet-Ressourcen ab.
POST	/attribute-sets	Erstellt eine AttributeSet-Ressource.
GET	/attribute-sets/{id}	Ruft eine AttributeSet-Ressource ab.
PATCH	/attribute-sets/{id}	Aktualisiert die AttributeSet-Ressource.
DELETE	/attribute-sets/{id}	Entfernt die AttributeSet-Ressource.

Schemafelder

Feld	Typ	Beschreibung
name*	string
relationName*	string
icon	stringnull

Attribut im Attributset

Endpoints

GET	/attribute-set-attributes	Ruft die Sammlung der AttributeSetAttribute-Ressourcen ab.
POST	/attribute-set-attributes	Erstellt eine AttributeSetAttribute-Ressource.
GET	/attribute-set-attributes/{id}	Ruft eine AttributeSetAttribute-Ressource ab.
PATCH	/attribute-set-attributes/{id}	Aktualisiert die AttributeSetAttribute-Ressource.
DELETE	/attribute-set-attributes/{id}	Entfernt die AttributeSetAttribute-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
attributeSet*	object
attribute*	object
required	boolean
implicitUnitQuantity	boolean

Attributregel

Endpoints

GET	/attribute-rules	Ruft die Sammlung der AttributeRule-Ressourcen ab.
POST	/attribute-rules	Erstellt eine AttributeRule-Ressource.
GET	/attribute-rules/{id}	Ruft eine AttributeRule-Ressource ab.
PATCH	/attribute-rules/{id}	Aktualisiert die AttributeRule-Ressource.
DELETE	/attribute-rules/{id}	Entfernt die AttributeRule-Ressource.

Schemafelder

Feld	Typ	Beschreibung
attributeSet*	string,null (iri-reference)
attribute	string,null (iri-reference)
name*	string

Attributpreis

Endpoints

GET	/attribute-prices	Ruft die Sammlung der AttributePrice-Ressourcen ab.
POST	/attribute-prices	Erstellt eine AttributePrice-Ressource.
GET	/attribute-prices/{id}	Ruft eine AttributePrice-Ressource ab.
PATCH	/attribute-prices/{id}	Aktualisiert die AttributePrice-Ressource.
DELETE	/attribute-prices/{id}	Entfernt die AttributePrice-Ressource.

Schemafelder

Feld	Typ	Beschreibung
attributeRule*	string (iri-reference)
amount*	string
currency*	string (iri-reference)
dateFrom*	string,null (date-time)

Tag-Definition

Endpoints

GET	/tag-definitions	Ruft die Sammlung der TagDefinition-Ressourcen ab.
POST	/tag-definitions	Erstellt eine TagDefinition-Ressource.
GET	/tag-definitions/{id}	Ruft eine TagDefinition-Ressource ab.
PATCH	/tag-definitions/{id}	Aktualisiert die TagDefinition-Ressource.
DELETE	/tag-definitions/{id}	Entfernt die TagDefinition-Ressource.
GET	/tag-definitions/autocomplete	Ruft die Sammlung der TagDefinition-Ressourcen ab.

Schemafelder

Feld	Typ	Beschreibung
id	string
name*	string
level*	integer
label	string
tagGroup*	string (iri-reference)
createdAt	string (date-time)
updatedAt	string (date-time)

Tag-Gruppe

Endpoints

GET	/tag-groups	Ruft die Sammlung der TagGroup-Ressourcen ab.
POST	/tag-groups	Erstellt eine TagGroup-Ressource.
GET	/tag-groups/{id}	Ruft eine TagGroup-Ressource ab.
PATCH	/tag-groups/{id}	Aktualisiert die TagGroup-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
name*	string
code	string
allowedRelations	arraynull

Bedingung

Endpoints

GET	/condition/{month}/contractor-groups	Ruft die Sammlung der Condition-Ressourcen ab.
GET	/condition/{month}/contractors	Ruft die Sammlung der Condition-Ressourcen ab.
GET	/condition/{month}/holidays	Ruft die Sammlung der Condition-Ressourcen ab.
GET	/condition/{month}/projects	Ruft die Sammlung der Condition-Ressourcen ab.

Richtlinie

Endpoints

GET	/policies	Ruft die Sammlung der Policy-Ressourcen ab.
POST	/policies	Erstellt eine Policy-Ressource.
GET	/policies/{id}	Ruft eine Policy-Ressource ab.
PATCH	/policies/{id}	Aktualisiert die Policy-Ressource.
DELETE	/policies/{id}	Entfernt die Policy-Ressource.

Schemafelder

Feld	Typ	Beschreibung
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.

Richtlinienversion

Endpoints

GET	/policy-versions	Ruft die Sammlung der PolicyVersion-Ressourcen ab.
POST	/policy-versions	Erstellt eine PolicyVersion-Ressource.
GET	/policy-versions/{id}	Ruft eine PolicyVersion-Ressource ab.

Schemafelder

Feld	Typ	Beschreibung
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.