Customization & tags

Attributes, attribute sets, rules and tags — extend Flowtly objects with your own fields.

Attribute

Endpoints

GET	/attributes	Retrieves the collection of Attribute resources.
POST	/attributes	Creates a Attribute resource.
GET	/attributes/{id}	Retrieves a Attribute resource.
PATCH	/attributes/{id}	Updates the Attribute resource.
DELETE	/attributes/{id}	Removes the Attribute resource.
POST	/attributes/{id}/cascade-weighing	Creates a Attribute resource.

Schema fields

Field	Type	Description
name*	string
type*	string
shift	integer
required	boolean
multiple	boolean
defaultValue	stringnull
formatPattern	stringnull

Tag

Endpoints

GET	/tags	Retrieves the collection of Tag resources.
POST	/tags	Creates a Tag resource.
GET	/tags/{id}	Retrieves a Tag resource.
DELETE	/tags/{id}	Removes the Tag resource.

Schema fields

Field	Type	Description
entityMapping	array
id	string
tagDefinition*	string (iri-reference)
relationName	string
relationId*	string
weight	string
createdAt	string (date-time)
updatedAt	string (date-time)
possibleRelationNames	string

Attribute Value

Endpoints

GET	/attribute-entity-values	Retrieves the collection of AttributeValue resources.
POST	/attribute-entity-values	Creates a AttributeValue resource.
GET	/attribute-entity-values/{id}	Retrieves a AttributeValue resource.
PATCH	/attribute-entity-values/{id}	Updates the AttributeValue resource.
DELETE	/attribute-entity-values/{id}	Removes the AttributeValue resource.
GET	/attribute-values	Retrieves the collection of AttributeValue resources.
POST	/attribute-values	Creates a AttributeValue resource.
GET	/attribute-values/{id}	Retrieves a AttributeValue resource.
PATCH	/attribute-values/{id}	Updates the AttributeValue resource.
DELETE	/attribute-values/{id}	Removes the AttributeValue resource.

Schema fields

Field	Type	Description
id	string
attribute*	string (iri-reference)
relationName	string
relationId*	string
value*	string
dateFrom	string,null (date-time)
dateTo	string,null (date-time)

Attribute Set

Endpoints

GET	/attribute-sets	Retrieves the collection of AttributeSet resources.
POST	/attribute-sets	Creates a AttributeSet resource.
GET	/attribute-sets/{id}	Retrieves a AttributeSet resource.
PATCH	/attribute-sets/{id}	Updates the AttributeSet resource.
DELETE	/attribute-sets/{id}	Removes the AttributeSet resource.

Schema fields

Field	Type	Description
name*	string
relationName*	string
icon	stringnull

Attribute Set Attribute

Endpoints

GET	/attribute-set-attributes	Retrieves the collection of AttributeSetAttribute resources.
POST	/attribute-set-attributes	Creates a AttributeSetAttribute resource.
GET	/attribute-set-attributes/{id}	Retrieves a AttributeSetAttribute resource.
PATCH	/attribute-set-attributes/{id}	Updates the AttributeSetAttribute resource.
DELETE	/attribute-set-attributes/{id}	Removes the AttributeSetAttribute resource.

Schema fields

Field	Type	Description
id	string
attributeSet*	object
attribute*	object
required	boolean
implicitUnitQuantity	boolean

Attribute Rule

Endpoints

GET	/attribute-rules	Retrieves the collection of AttributeRule resources.
POST	/attribute-rules	Creates a AttributeRule resource.
GET	/attribute-rules/{id}	Retrieves a AttributeRule resource.
PATCH	/attribute-rules/{id}	Updates the AttributeRule resource.
DELETE	/attribute-rules/{id}	Removes the AttributeRule resource.

Schema fields

Field	Type	Description
attributeSet*	string,null (iri-reference)
attribute	string,null (iri-reference)
name*	string

Attribute Price

Endpoints

GET	/attribute-prices	Retrieves the collection of AttributePrice resources.
POST	/attribute-prices	Creates a AttributePrice resource.
GET	/attribute-prices/{id}	Retrieves a AttributePrice resource.
PATCH	/attribute-prices/{id}	Updates the AttributePrice resource.
DELETE	/attribute-prices/{id}	Removes the AttributePrice resource.

Schema fields

Field	Type	Description
attributeRule*	string (iri-reference)
amount*	string
currency*	string (iri-reference)
dateFrom*	string,null (date-time)

Tag Definition

Endpoints

GET	/tag-definitions	Retrieves the collection of TagDefinition resources.
POST	/tag-definitions	Creates a TagDefinition resource.
GET	/tag-definitions/{id}	Retrieves a TagDefinition resource.
PATCH	/tag-definitions/{id}	Updates the TagDefinition resource.
DELETE	/tag-definitions/{id}	Removes the TagDefinition resource.
GET	/tag-definitions/autocomplete	Retrieves the collection of TagDefinition resources.

Schema fields

Field	Type	Description
id	string
name*	string
level*	integer
label	string
tagGroup*	string (iri-reference)
createdAt	string (date-time)
updatedAt	string (date-time)

Tag Group

Endpoints

GET	/tag-groups	Retrieves the collection of TagGroup resources.
POST	/tag-groups	Creates a TagGroup resource.
GET	/tag-groups/{id}	Retrieves a TagGroup resource.
PATCH	/tag-groups/{id}	Updates the TagGroup resource.

Schema fields

Field	Type	Description
id	string
name*	string
code	string
allowedRelations	arraynull

Condition

Endpoints

GET	/condition/{month}/contractor-groups	Retrieves the collection of Condition resources.
GET	/condition/{month}/contractors	Retrieves the collection of Condition resources.
GET	/condition/{month}/holidays	Retrieves the collection of Condition resources.
GET	/condition/{month}/projects	Retrieves the collection of Condition resources.

Policy

Endpoints

GET	/policies	Retrieves the collection of Policy resources.
POST	/policies	Creates a Policy resource.
GET	/policies/{id}	Retrieves a Policy resource.
PATCH	/policies/{id}	Updates the Policy resource.
DELETE	/policies/{id}	Removes the Policy resource.

Schema fields

Field	Type	Description
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.

Policy Version

Endpoints

GET	/policy-versions	Retrieves the collection of PolicyVersion resources.
POST	/policy-versions	Creates a PolicyVersion resource.
GET	/policy-versions/{id}	Retrieves a PolicyVersion resource.

Schema fields

Field	Type	Description
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.