Personnalisation & Étiquettes
Attributs, ensembles d'attributs, règles et tags — enrichissez les objets Flowtly avec vos propres champs.
Attribut
Points de terminaison
| GET | /attributes | Récupère la collection de ressources Attribute. |
| POST | /attributes | Crée une ressource Attribute. |
| GET | /attributes/{id} | Récupère une ressource Attribute. |
| PATCH | /attributes/{id} | Met à jour la ressource Attribute. |
| DELETE | /attributes/{id} | Supprime la ressource Attribute. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| name* | string | |
| type* | string | |
| shift | integer | |
| required | boolean | |
| multiple | boolean | |
| defaultValue | stringnull | |
| formatPattern | stringnull |
Étiquette
Points de terminaison
| GET | /tags | Récupère la collection de ressources Tag. |
| POST | /tags | Crée une ressource Tag. |
| GET | /tags/{id} | Récupère une ressource Tag. |
| DELETE | /tags/{id} | Supprime la ressource Tag. |
Champs de schéma
| Champ | 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 |
Valeur d'attribut
Points de terminaison
| GET | /attribute-entity-values | Récupère la collection de ressources AttributeValue. |
| POST | /attribute-entity-values | Crée une ressource AttributeValue. |
| GET | /attribute-entity-values/{id} | Récupère une ressource AttributeValue. |
| PATCH | /attribute-entity-values/{id} | Met à jour la ressource AttributeValue. |
| DELETE | /attribute-entity-values/{id} | Supprime la ressource AttributeValue. |
| GET | /attribute-values | Récupère la collection de ressources AttributeValue. |
| POST | /attribute-values | Crée une ressource AttributeValue. |
| GET | /attribute-values/{id} | Récupère une ressource AttributeValue. |
| PATCH | /attribute-values/{id} | Met à jour la ressource AttributeValue. |
| DELETE | /attribute-values/{id} | Supprime la ressource AttributeValue. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| id | string | |
| attribute* | string (iri-reference) | |
| relationName | string | |
| relationId* | string | |
| value* | string | |
| dateFrom | string,null (date-time) | |
| dateTo | string,null (date-time) |
Ensemble d'attributs
Points de terminaison
| GET | /attribute-sets | Récupère la collection de ressources AttributeSet. |
| POST | /attribute-sets | Crée une ressource AttributeSet. |
| GET | /attribute-sets/{id} | Récupère une ressource AttributeSet. |
| PATCH | /attribute-sets/{id} | Met à jour la ressource AttributeSet. |
| DELETE | /attribute-sets/{id} | Supprime la ressource AttributeSet. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| name* | string | |
| relationName* | string | |
| icon | stringnull |
Attribut d'un ensemble d'attributs
Points de terminaison
| GET | /attribute-set-attributes | Récupère la collection de ressources AttributeSetAttribute. |
| POST | /attribute-set-attributes | Crée une ressource AttributeSetAttribute. |
| GET | /attribute-set-attributes/{id} | Récupère une ressource AttributeSetAttribute. |
| PATCH | /attribute-set-attributes/{id} | Met à jour la ressource AttributeSetAttribute. |
| DELETE | /attribute-set-attributes/{id} | Supprime la ressource AttributeSetAttribute. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| id | string | |
| attributeSet* | object | |
| attribute* | object | |
| required | boolean | |
| implicitUnitQuantity | boolean |
Règle d'attribut
Points de terminaison
| GET | /attribute-rules | Récupère la collection de ressources AttributeRule. |
| POST | /attribute-rules | Crée une ressource AttributeRule. |
| GET | /attribute-rules/{id} | Récupère une ressource AttributeRule. |
| PATCH | /attribute-rules/{id} | Met à jour la ressource AttributeRule. |
| DELETE | /attribute-rules/{id} | Supprime la ressource AttributeRule. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| attributeSet* | string,null (iri-reference) | |
| attribute | string,null (iri-reference) | |
| name* | string |
Prix d'attribut
Points de terminaison
| GET | /attribute-prices | Récupère la collection de ressources AttributePrice. |
| POST | /attribute-prices | Crée une ressource AttributePrice. |
| GET | /attribute-prices/{id} | Récupère une ressource AttributePrice. |
| PATCH | /attribute-prices/{id} | Met à jour la ressource AttributePrice. |
| DELETE | /attribute-prices/{id} | Supprime la ressource AttributePrice. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| attributeRule* | string (iri-reference) | |
| amount* | string | |
| currency* | string (iri-reference) | |
| dateFrom* | string,null (date-time) |
Définition de tag
Points de terminaison
| GET | /tag-definitions | Récupère la collection de ressources TagDefinition. |
| POST | /tag-definitions | Crée une ressource TagDefinition. |
| GET | /tag-definitions/{id} | Récupère une ressource TagDefinition. |
| PATCH | /tag-definitions/{id} | Met à jour la ressource TagDefinition. |
| DELETE | /tag-definitions/{id} | Supprime la ressource TagDefinition. |
| GET | /tag-definitions/autocomplete | Récupère la collection de ressources TagDefinition. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| id | string | |
| name* | string | |
| level* | integer | |
| label | string | |
| tagGroup* | string (iri-reference) | |
| createdAt | string (date-time) | |
| updatedAt | string (date-time) |
Groupe de tags
Points de terminaison
| GET | /tag-groups | Récupère la collection de ressources TagGroup. |
| POST | /tag-groups | Crée une ressource TagGroup. |
| GET | /tag-groups/{id} | Récupère une ressource TagGroup. |
| PATCH | /tag-groups/{id} | Met à jour la ressource TagGroup. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| id | string | |
| name* | string | |
| code | string | |
| allowedRelations | arraynull |
Condition
Points de terminaison
| GET | /condition/{month}/contractor-groups | Récupère la collection de ressources Condition. |
| GET | /condition/{month}/contractors | Récupère la collection de ressources Condition. |
| GET | /condition/{month}/holidays | Récupère la collection de ressources Condition. |
| GET | /condition/{month}/projects | Récupère la collection de ressources Condition. |