Position API verte : Listes

Modifié le Lun, 24 Nov. à 12:44 H

Une liste dans l'API est une liste exportée depuis Position Green. La documentation relative aux points de terminaison liés aux listes est détaillée ci-dessous. Pour tester les points de terminaison, rendez-vous sur notre page Swagger UI.

Listes de requêtes

GET/listes

paramètres de requête
premier	entier (int32)
après	chaîne nullable

Réponse
Succès
Corps
totalCount	entier nullable (int64)
pageInfo	External.API.V1.Controllers.PageInfo (objet)
articles	tableau nullable de External.API.V1.Controllers.Item`1[External.API.V1.Controllers.List.List] (objet)

Demande

const response = await fetch('/lists', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Réponse

{
  "totalCount": 0,
  "pageInfo": {
    "hasNextPage": false,
    "startCursor": "text",
    "endCursor": "text"
  },
  "items": [
    {
      "cursor": "text",
      "node":{
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "prettyId": "text",
        "source": "text",
        "createdAt": "2025-01-27T12:06:27.881Z"
      }
    }
  ]
}

Cette API renverra les métadonnées de chaque liste et non son contenu. Le contenu d'une liste spécifique peut être récupéré à partir de https://api.positiongreen.com/v1/lists/{id}/items

Exemple de réponse

{
    "totalCount": 1,
    "pageInfo": {
        "hasNextPage": false,
        "startCursor": "aWs41zA=",
        "endCursor": "aWs41zA="
    },
    "items": [
        {
            "cursor": « aWs41zA= »,
            « node » : {
                « id » : « 1f1ec12f-edb6-425a-a2d4-o03bddg1d3c5 »,
                « name » : « Business »,
                « prettyId » : « business »,
                « createdAt » : « 2022-03-22T11:18:58.237+00:00 »
            }
        }
    ]
}

Éléments de la liste de requêtes

GET /lists/{id}/items

Paramètres de chemin

Nom	Type	Description
id*	chaîne

Paramètres de requête

Nom	Type	Description
après	chaîne
maxListItemValues	entier
premier	entier
développer	tableau	Options disponibles : Valeurs

{
    // voir ci-dessous
}

Cette API renverra les données d'une liste spécifique. Un paramètre de requête facultatif « expand » peut être fourni pour récupérer davantage de données sur des propriétés spécifiques.

Exemple de réponse avec « expand » défini sur « Values ».

{
  "totalCount": 1,
  "pageInfo": {
    "hasNextPage": false,
    "startCursor": "aWR4OzA=",
    "endCursor": "aWR4OzA="
  },
  "items": [
    {
      "cursor": « aWR4OzA= »,
      « node » : {
        « id » : « c951196e-827f-426e-b9c1-6de65519bf3d »,
        « name » : « Train régional, électricité verte »,
        « prettyId » : « Regional_train_Green_electricity »,
        « externalId » : « »,
        « createdAt » : « 2022-01-24T12:25:07.5438379+02:00 »,
        « listItemValues » : [
          {
            « id » : « 2e0ea5ac-bc44-468d-8336-7c2fa240a3c0 »,
            « value » : « {\"factor_scope_3\":1E-17,\"unit\":\"ton CO2e/p.km\",\"source\":\"NTM (2018)\"}",
            "validFrom": "2022-01-01T00:00:00+00:00",
            "createdAt": "2022-03-24T12:25:07.5438379+02:00"
          }
        ]
      }
    }
  ]
}
```