Aller au contenu

Sous-références d’articles

Certains articles sont gérés avec des sous-références.

Une sous-référence permet de décliner un même article en plusieurs variantes.
Exemple : l’article "Cercueil" peut avoir des sous-références comme "Bois massif chêne", "Pin", "Acajou", etc.

Quand un article est concerné, le champ suivant est positionné à true :

  • article.hasSubReferences

Structure d’une sous-référence d’article

Une sous-référence d’article représente l’association :

  • d’un article (article)
  • d’un code de sous-référence (sousRef.codeSousRef)
Champ Description
article Article parent
article.codeArticle Code unique de l’article parent
article.libelle Libellé de l’article parent
article.hasSubReferences Indique que l’article est décliné en sous-références
sousRef.codeSousRef Code de la sous-référence (variante)
ordonnancementHaut2025 Ordonnancement haut
ordonnancementBas2025 Ordonnancement bas

Extrait d’exemple :

{
  "article": {
    "codeArticle": "URNE",
    "libelle": "Urne",
    "hasSubReferences": true
  },
  "sousRef": {
    "codeSousRef": "UCT-10 PAPILLON"
  }
}

Pagination

Les endpoints de lecture retournent une liste paginée.

Structure :

Champ Description
content Liste des associations (article + sous-référence)
totalPages Nombre total de pages
totalElements Nombre total d’éléments
pageable.pageNumber Numéro de la page courante
pageable.pageSize Nombre d’éléments par page

Exemple de réponse :

{
  "content": [
    {
      "article": {
        "codeArticle": "URNE",
        "libelle": "Urne",
        "hasSubReferences": true
      },
      "sousRef": { "codeSousRef": "UCT-10 PAPILLON" }
    },
    {
      "article": {
        "codeArticle": "PLAQUE",
        "libelle": "Plaque",
        "hasSubReferences": true
      },
      "sousRef": { "codeSousRef": "LCE0271PA" }
    }
  ],
  "totalPages": 159,
  "totalElements": 1590,
  "pageable": { "pageNumber": 0, "pageSize": 10 }
}

Liste des endpoints disponibles

GET /v1/sousref/all

Retourne la liste paginée de toutes les sous-références.

Paramètres :

Paramètre Type Obligatoire Description
codeBu string oui Code de la BU (société)
page integer oui Numéro de page (commence à 0)

Exemple :

GET /v1/sousref/all?codeBu={{codeBu}}&page=0

GET /v1/sousref/{codeSousRef}/article/{codeArticle}

Retourne une sous-référence précise pour un article donné.

Paramètres :

Path :

Paramètre Type Obligatoire Description
codeSousRef string oui Code de sous-référence
codeArticle string oui Code unique de l’article

Query :

Paramètre Type Obligatoire Description
codeBu string oui Code de la BU (société)

Exemple :

GET /v1/sousref/UCT-10%20PAPILLON/article/URNE?codeBu={{codeBu}}

GET /v1/sousref/latest

Retourne la liste paginée des sous-références créées ou modifiées depuis une date.

Paramètres :

Paramètre Type Obligatoire Description
codeBu string oui Code de la BU (société)
depuis string oui Date de début de synchronisation
page integer oui Numéro de page (commence à 0)

Format de la date :

dd/MM/yyyy HH:mm:ss

Exemple :

GET /v1/sousref/latest?codeBu={{codeBu}}&depuis=01/01/2026 00:00:00&page=0

GET /v1/sousref/delete/latest

Retourne la liste paginée des sous-références supprimées depuis une date.

Paramètres :

Paramètre Type Obligatoire Description
codeBu string oui Code de la BU (société)
depuis string oui Date de début de synchronisation
page integer oui Numéro de page (commence à 0)

Format de la date :

dd/MM/yyyy HH:mm:ss

Exemple :

GET /v1/sousref/delete/latest?codeBu={{codeBu}}&depuis=01/01/2026 00:00:00&page=0