Position Green API: Listen

Geändert am Mo, 7 Jul um 5:15 NACHMITTAGS

Eine Liste in der API ist eine exportierte Liste aus Position Green. Die Dokumentation für Endpunkte, die sich auf Listen beziehen, wird im Folgenden erläutert. Um die Endpunkte zu testen, besuchen Sie bitte unsere Swagger-UI-Seite.

Listen abfragen

GET/lists

Abfrageparameter
first	ganze Zahl (int32)
after	löschbare Zeichenkette

Antwort
Erfolgreich
Body
totalCount	löschbare ganze Zahl (int64)
pageInfo	External.API.V1.Controllers.PageInfo (Objekt)
items	löschbare Auflistung von External.API.V1.Controllers.Item`1[External.API.V1.Controllers.List.List] (Objekt)

Anfrage

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

Antwort

{
  "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"
      }
    }
  ]
}

Diese API liefert Metadaten für jede Liste, nicht jedoch für deren Inhalt. Der Inhalt einer bestimmten Liste kann über https://api.positiongreen.com/v1/lists/{id}/items abgerufen werden.

Beispiel für eine Antwort

{
    "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"
            }
        }
    ]
}

Listenelemente abfragen

GET /lists/{id}/items

Pfad-Parameter

Bezeichnung	Art	Beschreibung
id*	string

Abfrage-Parameter

Bezeichnung	Art	Beschreibung
after	string
maxListItemValues	ganze Zahl
first	ganze Zahl
expand	Auflistung	Verfügbare Optionen: Werte

{
    // siehe unten
}

Diese API gibt Daten für eine bestimmte Liste aus. Sie können einen optionalen Abfrageparameter "expand" angeben, um weitere Daten zu bestimmten Eigenschaften abzurufen.

Beispiel für eine Antwort, bei der "expand" auf "Werte" gesetzt ist.

{
  "totalCount": 1,
  "pageInfo": {
    "hasNextPage": false,
    "startCursor": "aWR4OzA=",
    "endCursor": "aWR4OzA="
  },
  "items": [
    {
      "cursor": "aWR4OzA=",
      "node": {
        "id": "c951196e-827f-426e-b9c1-6de65519bf3d",
        "name": "Regional train, Green electricity",
        "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"
          }
        ]
      }
    }
  ]
}
```