Position Green API: Listor

Ändrad den Mån, 9 juni vid 3:56 E.M.

En lista i API:et är en exporterad lista från Position Green. Dokumentationen för slutpunkter som är relaterade till Listor beskrivs nedan. För att testa slutpunkterna, gå till vår Swagger UI-sida.

Frågelistor

GET/listor

Frågeparametrar
första	heltal (int32)
efter	nollställbar sträng

Respons
Lyckades
Organ
totalantal	nollställbart heltal (int64)
sidInfo	External.API.V1.Controllers.PageInfo (objekt)
föremål	nullable array av External.API.V1.Controllers.Item`1[External.API.V1.Controllers.List.List] (objekt)

Begäran

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

Respons

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

Detta API returnerar metadata för varje lista och inte dess innehåll. Innehåll för en viss lista kan hämtas från https://api.positiongreen.com/v1/lists/{id}/items

Exempel på ett svar

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

Fråga efter listobjekt

GET /lists/{id}/items

Parametrar för sökväg

Namn	Ämne	Beskrivning
id*	sträng

Parametrar för förfrågan

Namn	Ämne	Beskrivning
efter	sträng
maxListItemVärden	heltal
första	heltal
expandera	uppställning	Tillgängliga alternativ: Värden

{
    // se nedan
}

Detta API kommer att returnera data för en specifik lista. En valfri frågeparameter "expand" kan anges för att hämta mer information om specifika egenskaper.

Exempel på ett svar där "expand" är inställt på "Values".

{
  "totalCount": 1,
  "pageInfo": {
    "hasNextPage": false,
    "startCursor": "aWR4OzA=",
    "endCursor": "aWR4OzA="
  },
  "items": [
    {
      "cursor": "aWR4OzA=",
      "node": {
        "id": "c951196e-827f-426e-b9c1-6de65519bf3d",
        "name": "Regionaltåg, Grön electricitet",
        "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"
          }
        ]
      }
    }
  ]
}
```