Customização e Tags

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

Esta referência é gerada a partir do esquema da API. As descrições dos campos e qualquer texto ainda não traduzido são apresentados em inglês.

Atributo

Endpoints

Atributo: Endpoints
MétodoCaminho
GET/attributes
POST/attributes
GET/attributes/{id}
PATCH/attributes/{id}
DELETE/attributes/{id}
POST/attributes/{id}/cascade-weighing

Campos de schema

Atributo: Campos de schema
CampoTipo
name*string
type*string
shiftinteger
requiredboolean
multipleboolean
defaultValuestringnull
formatPatternstringnull

Tag

Endpoints

Tag: Endpoints
MétodoCaminho
GET/tags
POST/tags
GET/tags/{id}
DELETE/tags/{id}

Campos de schema

Tag: Campos de schema
CampoTipo
entityMappingarray
idstring
tagDefinition*string (iri-reference)
relationNamestring
relationId*string
weightstring
createdAtstring (date-time)
updatedAtstring (date-time)
possibleRelationNamesstring

Valor do Atributo

Endpoints

Valor do Atributo: Endpoints
MétodoCaminho
GET/attribute-entity-values
POST/attribute-entity-values
GET/attribute-entity-values/{id}
PATCH/attribute-entity-values/{id}
DELETE/attribute-entity-values/{id}
GET/attribute-values
POST/attribute-values
GET/attribute-values/{id}
PATCH/attribute-values/{id}
DELETE/attribute-values/{id}

Campos de schema

Valor do Atributo: Campos de schema
CampoTipo
idstring
attribute*string (iri-reference)
relationNamestring
relationId*string
value*string
dateFromstring,null (date-time)
dateTostring,null (date-time)

Conjunto de Atributos

Endpoints

Conjunto de Atributos: Endpoints
MétodoCaminho
GET/attribute-sets
POST/attribute-sets
GET/attribute-sets/{id}
PATCH/attribute-sets/{id}
DELETE/attribute-sets/{id}

Campos de schema

Conjunto de Atributos: Campos de schema
CampoTipo
name*string
relationName*string
iconstringnull

Atributo do Conjunto de Atributos

Endpoints

Atributo do Conjunto de Atributos: Endpoints
MétodoCaminho
GET/attribute-set-attributes
POST/attribute-set-attributes
GET/attribute-set-attributes/{id}
PATCH/attribute-set-attributes/{id}
DELETE/attribute-set-attributes/{id}

Campos de schema

Atributo do Conjunto de Atributos: Campos de schema
CampoTipo
idstring
attributeSet*object
attribute*object
requiredboolean
implicitUnitQuantityboolean

Regra de Atributo

Endpoints

Regra de Atributo: Endpoints
MétodoCaminho
GET/attribute-rules
POST/attribute-rules
GET/attribute-rules/{id}
PATCH/attribute-rules/{id}
DELETE/attribute-rules/{id}

Campos de schema

Regra de Atributo: Campos de schema
CampoTipo
attributeSet*string,null (iri-reference)
attributestring,null (iri-reference)
name*string

Preço do Atributo

Endpoints

Preço do Atributo: Endpoints
MétodoCaminho
GET/attribute-prices
POST/attribute-prices
GET/attribute-prices/{id}
PATCH/attribute-prices/{id}
DELETE/attribute-prices/{id}

Campos de schema

Preço do Atributo: Campos de schema
CampoTipo
attributeRule*string (iri-reference)
amount*string
currency*string (iri-reference)
dateFrom*string,null (date-time)

Definição de Etiqueta

Endpoints

Definição de Etiqueta: Endpoints
MétodoCaminho
GET/tag-definitions
POST/tag-definitions
GET/tag-definitions/{id}
PATCH/tag-definitions/{id}
DELETE/tag-definitions/{id}
GET/tag-definitions/autocomplete

Campos de schema

Definição de Etiqueta: Campos de schema
CampoTipo
idstring
name*string
level*integer
labelstring
tagGroup*string (iri-reference)
createdAtstring (date-time)
updatedAtstring (date-time)

Grupo de Etiquetas

Endpoints

Grupo de Etiquetas: Endpoints
MétodoCaminho
GET/tag-groups
POST/tag-groups
GET/tag-groups/{id}
PATCH/tag-groups/{id}

Campos de schema

Grupo de Etiquetas: Campos de schema
CampoTipo
idstring
name*string
codestring
allowedRelationsarraynull

Condição

Endpoints

Condição: Endpoints
MétodoCaminho
GET/condition/{month}/contractor-groups
GET/condition/{month}/contractors
GET/condition/{month}/holidays
GET/condition/{month}/projects

Política

Endpoints

Política: Endpoints
MétodoCaminho
GET/policies
POST/policies
GET/policies/{id}
PATCH/policies/{id}
DELETE/policies/{id}

Campos de schema

Política: Campos de schema
CampoTipo
idinteger
slug*string
title*string
versionsarray
createdAtstring (date-time)
updatedAtstring (date-time)
deletedAtstring,null (date-time)
deletedboolean

Versão da política

Endpoints

Versão da política: Endpoints
MétodoCaminho
GET/policy-versions
POST/policy-versions
GET/policy-versions/{id}

Campos de schema

Versão da política: Campos de schema
CampoTipo
idinteger
policy*string (iri-reference)
body*string
effectiveFrom*string (date-time)