Aller au contenu

Parametres.General.InfosLibres

En bref

8 opérations sur 4 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).

Opérations

Méthode Chemin Rôle
GET /v2/infoslibres Lister les enregistrements
POST /v2/infoslibres Créer l'enregistrement
PUT /v2/infoslibres Mettre à jour l'enregistrement
DELETE /v2/infoslibres Supprimer l'enregistrement
GET /v2/infoslibres/count Compter les enregistrements
POST /v2/infoslibres/count Compter les enregistrements
POST /v2/infoslibres/recherche Rechercher des enregistrements
POST /v2/infoslibres/save Créer ou mettre à jour l'enregistrement (upsert)

Rôle déduit

La spécification ne porte ni summary ni description d'opération : la colonne Rôle est déduite mécaniquement de la méthode HTTP et du chemin.

Détail

GET /v2/infoslibres

Lister les enregistrements.

Paramètres

Nom Emplacement Type Obligatoire Description
sort query string non -
where query string non -

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/infoslibres?sort=<sort>&where=<where>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/infoslibres

Créer l'enregistrement.

Corps de la requête (application/json)

Schéma InfosLibresDto - 8 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/infoslibres" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"table": "…", "nom": "…", "position": 0}'

PUT /v2/infoslibres

Mettre à jour l'enregistrement.

Corps de la requête (application/json)

Schéma InfosLibresDto - 8 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X PUT "https://<votre-connecteur>/v2/infoslibres" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"table": "…", "nom": "…", "position": 0}'

DELETE /v2/infoslibres

Supprimer l'enregistrement.

Corps de la requête (application/json)

Schéma InfosLibresDto - 8 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X DELETE "https://<votre-connecteur>/v2/infoslibres" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"table": "…", "nom": "…", "position": 0}'

GET /v2/infoslibres/count

Compter les enregistrements.

Paramètres

Nom Emplacement Type Obligatoire Description
where query string non -

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/infoslibres/count?where=<where>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/infoslibres/count

Compter les enregistrements.

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/infoslibres/count" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/infoslibres/recherche

Rechercher des enregistrements.

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/infoslibres/recherche" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/infoslibres/save

Créer ou mettre à jour l'enregistrement (upsert).

Corps de la requête (application/json)

Schéma InfosLibresDto - 8 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code Description Schéma de data
200 OK -
401 Unauthorized -
403 Forbidden -

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/infoslibres/save" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"table": "…", "nom": "…", "position": 0}'

Schémas

Schémas résolus à un niveau : les propriétés qui référencent un autre schéma sont citées par leur nom, sans être dépliées.

InfosLibresDto

InfosLibresDto - 8 propriétés
Propriété Type Notes
table string nullable, Nom de la table concernée (CB_File).
nom string nullable, Nom du champ d’information libre (CB_Name).
position integer (int32) Position du champ dans la table principale (CB_Pos).
type integer (int32) Type de la donnée (CB_Type).
taille integer (int32) Longueur de la colonne (CB_Len)
flag integer (int32) nullable, Flag de la colonne (CB_Flag)
formule string nullable, Formule de calcul de l'info libre (CB_Formule)
createur string nullable, Application dans laquelle l'information libre a été créée

Voir aussi

Écrans qui utilisent ce groupe

Documentation de SenSaaS v2. Chaque page est écrite à partir du produit livré ; ce qui reste à vérifier y est signalé.