Customização e Tags

Atributos, conjuntos de atributos, regras e etiquetas — estenda os objetos Flowtly com os seus próprios campos.

Atributo

Endpoints

GET	/attributes	Recupera a coleção de recursos Attribute.
POST	/attributes	Cria um recurso Attribute.
GET	/attributes/{id}	Recupera um recurso Attribute.
PATCH	/attributes/{id}	Atualiza o recurso Attribute.
DELETE	/attributes/{id}	Remove o recurso Attribute.
POST	/attributes/{id}/cascade-weighing	Cria um recurso Attribute.

Campos de schema

Campo	Tipo	Descrição
name*	string
type*	string
shift	integer
required	boolean
multiple	boolean
defaultValue	stringnull
formatPattern	stringnull

Tag

Endpoints

GET	/tags	Recupera a coleção de recursos Tag.
POST	/tags	Cria um recurso Tag.
GET	/tags/{id}	Recupera um recurso Tag.
DELETE	/tags/{id}	Remove o recurso Tag.

Campos de schema

Campo	Tipo	Descrição
entityMapping	array
id	string
tagDefinition*	string (iri-reference)
relationName	string
relationId*	string
weight	string
createdAt	string (date-time)
updatedAt	string (date-time)
possibleRelationNames	string

Valor do Atributo

Endpoints

GET	/attribute-entity-values	Recupera a coleção de recursos AttributeValue.
POST	/attribute-entity-values	Cria um recurso AttributeValue.
GET	/attribute-entity-values/{id}	Recupera um recurso AttributeValue.
PATCH	/attribute-entity-values/{id}	Atualiza o recurso AttributeValue.
DELETE	/attribute-entity-values/{id}	Remove o recurso AttributeValue.
GET	/attribute-values	Recupera a coleção de recursos AttributeValue.
POST	/attribute-values	Cria um recurso AttributeValue.
GET	/attribute-values/{id}	Recupera um recurso AttributeValue.
PATCH	/attribute-values/{id}	Atualiza o recurso AttributeValue.
DELETE	/attribute-values/{id}	Remove o recurso AttributeValue.

Campos de schema

Campo	Tipo	Descrição
id	string
attribute*	string (iri-reference)
relationName	string
relationId*	string
value*	string
dateFrom	string,null (date-time)
dateTo	string,null (date-time)

Conjunto de Atributos

Endpoints

GET	/attribute-sets	Recupera a coleção de recursos AttributeSet.
POST	/attribute-sets	Cria um recurso AttributeSet.
GET	/attribute-sets/{id}	Recupera um recurso AttributeSet.
PATCH	/attribute-sets/{id}	Atualiza o recurso AttributeSet.
DELETE	/attribute-sets/{id}	Remove o recurso AttributeSet.

Campos de schema

Campo	Tipo	Descrição
name*	string
relationName*	string
icon	stringnull

Atributo do Conjunto de Atributos

Endpoints

GET	/attribute-set-attributes	Recupera a coleção de recursos AttributeSetAttribute.
POST	/attribute-set-attributes	Cria um recurso AttributeSetAttribute.
GET	/attribute-set-attributes/{id}	Recupera um recurso AttributeSetAttribute.
PATCH	/attribute-set-attributes/{id}	Atualiza o recurso AttributeSetAttribute.
DELETE	/attribute-set-attributes/{id}	Remove o recurso AttributeSetAttribute.

Campos de schema

Campo	Tipo	Descrição
id	string
attributeSet*	object
attribute*	object
required	boolean
implicitUnitQuantity	boolean

Regra de Atributo

Endpoints

GET	/attribute-rules	Recupera a coleção de recursos AttributeRule.
POST	/attribute-rules	Cria um recurso AttributeRule.
GET	/attribute-rules/{id}	Recupera um recurso AttributeRule.
PATCH	/attribute-rules/{id}	Atualiza o recurso AttributeRule.
DELETE	/attribute-rules/{id}	Remove o recurso AttributeRule.

Campos de schema

Campo	Tipo	Descrição
attributeSet*	string,null (iri-reference)
attribute	string,null (iri-reference)
name*	string

Preço do Atributo

Endpoints

GET	/attribute-prices	Recupera a coleção de recursos AttributePrice.
POST	/attribute-prices	Cria um recurso AttributePrice.
GET	/attribute-prices/{id}	Recupera um recurso AttributePrice.
PATCH	/attribute-prices/{id}	Atualiza o recurso AttributePrice.
DELETE	/attribute-prices/{id}	Remove o recurso AttributePrice.

Campos de schema

Campo	Tipo	Descrição
attributeRule*	string (iri-reference)
amount*	string
currency*	string (iri-reference)
dateFrom*	string,null (date-time)

Definição de Etiqueta

Endpoints

GET	/tag-definitions	Recupera a coleção de recursos TagDefinition.
POST	/tag-definitions	Cria um recurso TagDefinition.
GET	/tag-definitions/{id}	Recupera um recurso TagDefinition.
PATCH	/tag-definitions/{id}	Atualiza o recurso TagDefinition.
DELETE	/tag-definitions/{id}	Remove o recurso TagDefinition.
GET	/tag-definitions/autocomplete	Recupera a coleção de recursos TagDefinition.

Campos de schema

Campo	Tipo	Descrição
id	string
name*	string
level*	integer
label	string
tagGroup*	string (iri-reference)
createdAt	string (date-time)
updatedAt	string (date-time)

Grupo de Etiquetas

Endpoints

GET	/tag-groups	Recupera a coleção de recursos TagGroup.
POST	/tag-groups	Cria um recurso TagGroup.
GET	/tag-groups/{id}	Recupera um recurso TagGroup.
PATCH	/tag-groups/{id}	Atualiza o recurso TagGroup.

Campos de schema

Campo	Tipo	Descrição
id	string
name*	string
code	string
allowedRelations	arraynull

Condição

Endpoints

GET	/condition/{month}/contractor-groups	Recupera a coleção de recursos Condition.
GET	/condition/{month}/contractors	Recupera a coleção de recursos Condition.
GET	/condition/{month}/holidays	Recupera a coleção de recursos Condition.
GET	/condition/{month}/projects	Recupera a coleção de recursos Condition.

Política

Endpoints

GET	/policies	Recupera a coleção de recursos Policy.
POST	/policies	Cria um recurso Policy.
GET	/policies/{id}	Recupera um recurso Policy.
PATCH	/policies/{id}	Atualiza o recurso Policy.
DELETE	/policies/{id}	Remove o recurso Policy.

Campos de schema

Campo	Tipo	Descrição
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.

Versão da política

Endpoints

GET	/policy-versions	Recupera a coleção de recursos PolicyVersion.
POST	/policy-versions	Cria um recurso PolicyVersion.
GET	/policy-versions/{id}	Recupera um recurso PolicyVersion.

Campos de schema

Campo	Tipo	Descrição
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.