Catalogue.Catalogue

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/catalogue`	Lister les enregistrements
`POST`	`/v2/catalogue`	Créer l'enregistrement
`PUT`	`/v2/catalogue`	Mettre à jour l'enregistrement
`DELETE`	`/v2/catalogue`	Supprimer l'enregistrement
`GET`	`/v2/catalogue/count`	Compter les enregistrements
`POST`	`/v2/catalogue/count`	Compter les enregistrements
`POST`	`/v2/catalogue/recherche`	Rechercher des enregistrements
`POST`	`/v2/catalogue/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/catalogue`

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/catalogue?sort=<sort>&where=<where>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`POST /v2/catalogue`

Créer l'enregistrement.

Corps de la requête (application/json)

Schéma CatalogueDto - 7 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/catalogue" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"id": 0, "intitule": "…", "code": "…"}'

`PUT /v2/catalogue`

Mettre à jour l'enregistrement.

Corps de la requête (application/json)

Schéma CatalogueDto - 7 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/catalogue" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"id": 0, "intitule": "…", "code": "…"}'

`DELETE /v2/catalogue`

Supprimer l'enregistrement.

Corps de la requête (application/json)

Schéma CatalogueDto - 7 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/catalogue" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"id": 0, "intitule": "…", "code": "…"}'

`GET /v2/catalogue/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/catalogue/count?where=<where>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`POST /v2/catalogue/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/catalogue/count" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`POST /v2/catalogue/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/catalogue/recherche" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`POST /v2/catalogue/save`

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

Corps de la requête (application/json)

Schéma CatalogueDto - 7 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/catalogue/save" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"id": 0, "intitule": "…", "code": "…"}'

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.

CatalogueDto

CatalogueDto - 7 propriétés

Propriété	Type	Notes
`id`	`integer` (int32)	Numéro interne du catalogue (CL_No).
`intitule`	`string`	nullable, Intitulé du catalogue (35 caractères max).
`code`	`string`	nullable, Code catalogue (3 caractères max).
`suiviStock`	`boolean`	Suivi en gestion de stock.
`numeroParent`	`integer` (int32)	Numéro interne du catalogue parent (CL_NoParent ; 0 si racine). Lecture.
`niveau`	`integer` (int32)	Niveau dans la hiérarchie (CL_Niveau). Lecture seule.
`intituleParent`	`string`	nullable, Intitulé du catalogue parent à rattacher (écriture). Non mappé en SQL ; résolu via FactoryProduit.ReadIntitule lors du Create/Edit.

Voir aussi

Écrans qui utilisent ce groupe

Articles et familles