OGSM API
Via de api-koppeling worden de data uit alle OGSM’s beschikbaar gesteld om in te lezen in het BI-systeem. Via unieke ID’s zijn de bestanden in de BI-software aan elkaar te koppelen. Elk bestand is opgebouwd uit rijen (de items) en kolommen (de velden).
De koppeling bestaat uit de volgende bestanden:
- Teams
- OGSM's
- Ambities
- Voortgangsrapportages ambities
- Doelstellingen
- Metingen doelstellingen
- Strategische keuzes
- Voortgangsrapportages strategische keuzes
- Indicatoren
- Metingen indicatoren
- Acties
- Voortgangsrapportages acties
Elk bestand bevat de data van alle OGSM’s op het platform. De bestanden kunnen direct een BI-systeem (bijv. Power BI) worden uitgelezen. Er is geen handmatige export nodig van de bestanden.
- De exportbestanden zijn toegankelijk via een unieke url die niet wijzigt.
- De exportbestanden zijn beveiligd met een gebruikersnaam en wachtwoord.
- Het formaat is JSON.
- De bestanden worden realtime bijgewerkt.
Hieronder staat per bestand welke kolommen ze bevatten.
Indeling bestanden
Lijst van objecten met naamattribuut: groen, oranje, rood
| Teams | ||
| /id | ID | Nummer |
| /name | Naam | Tekst |
| OGSM's | ||
| /team/id | ID van het team waarin de OGSM staat | Nummer |
| /id | ID | Nummer |
| /name | Naam | Tekst |
| Ambities | ||
| /id | ID | Nummer |
| /title | Titel | Tekst |
| /labels | Labels | Lijst van objecten met naamattribuut |
| /description | Omschrijving | Tekst (incl. HTML) |
| /assignee | Eigenaar | Object met naamattribuut |
| /ogsm_canvases/#/id | ID van de OGSM waarin de ambitie staat | Nummer |
| /ogsm_canvases/#/row_order | Volgorde | Nummer |
| /traffic_light | Verkeerslicht | Lijst van objecten met naamattribuut: groen, oranje, rood |
| /archived | Is de ambitie gearchiveerd | TRUE, FALSE |
| Voortgangsrapportages ambities | ||
| /id | ID van de rapportage | Nummer |
| /objective/id | ID van de gekoppelde ambitie | Nummer |
| /at | Datum van de rapportage | Datum: jjjj-mm-dd |
| /traffic_light | Verkeerslicht | Lijst van objecten met naamattribuut: groen, oranje, rood |
| /description | Omschrijving | Tekst (incl. HTML) |
| Doelstellingen | ||
| /id | ID van de doelstelling | Nummer |
| /title | Titel | Tekst |
| /labels/#/name | Labels | Tekst |
| /description | Omschrijving | Tekst (incl. HTML) |
| /target_unit | Eenheid | Tekst |
| /assignee | Eigenaar | Object met naamattribuut |
| /ogsm_canvases/#/id | ID van de OGSM waarin de doelstelling staat | Nummer |
| /ogsm_canvases/#/row_order | Volgorde van de doelstelling | Nummer |
| /traffic_light | Verkeerslicht | Lijst van objecten met naamattribuut: groen, oranje, rood |
| /archived | Is gearchiveerd | TRUE, FALSE |
| /labels | Labels | Lijst van objecten met naamattribuut |
| Metingen doelstellingen | ||
| /id | ID | Nummer |
| /goal/id | ID van de gekoppelde doelstelling | Nummer |
| /at | Datum van de meting | Datum: jjjj-mm-dd |
| /current_value | Huidige waarde | Tekst |
| /target_value | Streefwaarde | Tekst |
| /traffic_light | Verkeerslicht | Lijst van objecten met naamattribuut: groen, oranje, rood |
| /show_in_ogsm | Wordt altijd in OGSM getoond | TRUE, FALSE |
| Strategische keuzes | ||
| /id | ID | Nummer |
| /title | Titel | Tekst |
| /labels | Labels | Lijst van objecten met naamattribuut |
| /description | Omschrijving | Tekst (incl. HTML) |
| /assignee | Eigenaar | Object met naamattribuut |
| /ogsm_canvases/#/id | ID van gekoppelde OGSM | Nummer |
| /ogsm_canvases/#/row_order | Volgorde | Nummer |
| /traffic_light | Verkeerslicht | Lijst van objecten met naamattribuut: groen, oranje, rood |
| /archived | Is gearchiveerd | TRUE, FALSE |
| Voortgangsrapportages strategische keuzes | ||
| /id | ID | Nummer |
| /strategy/id | ID van gekoppelde strategische keuze | Nummer |
| /at | Datum | Datum: jjjj-mm-dd |
| /traffic_light | Verkeerslicht | Lijst van objecten met naamattribuut: groen, oranje, rood |
| /description | Omschrijving | Tekst (incl. HTML) |
| Indicatoren | ||
| /id | ID van de indicator | Nummer |
| /title | Titel | Tekst |
| /labels | Labels | Lijst van objecten met naamattribuut |
| /strategies | Gekoppelde strategische keuze | Lijst met objecten met ID-attribuut |
| /description | Omschrijving | Tekst (incl. HTML) |
| /target_unit | Eenheid | Tekst |
| /traffic_light | Verkeerslicht | Lijst van objecten met naamattribuut: groen, oranje, rood |
| /assignee | Eigenaar | Object met naamattribuut |
| /ogsm_canvases/#/id | ID van de OGSM waarin de indicator staat | Nummer |
| /ogsm_canvases/#/row_order | Volgorde van de indicator | Nummer |
| /archived | Is gearchiveerd | TRUE, FALSE |
| Metingen indicatoren | ||
| /id | ID | Nummer |
| /indicator/id | ID van de gekoppelde indicator | Nummer |
| /at | Datum van de meting | Datum: jjjj-mm-dd |
| /current_value | Huidige waarde | Tekst |
| /target_value | Streefwaarde | Tekst |
| /traffic_light | Verkeerslicht | Lijst van objecten met naamattribuut: groen, oranje, rood |
| /show_in_ogsm | Wordt altijd in OGSM getoond | TRUE, FALSE |
| Acties | ||
| /id | ID | Nummer |
| /title | Titel | Tekst |
| /labels | Labels | Lijst van objecten met naamattribuut |
| /strategies/#/id | ID van de gekoppelde strategische keuze | Nummer |
| /description | Omschrijving | Tekst (incl. HTML) |
| /assignee | Eigenaar | Object met naamattribuut |
| /involved | Betrokkenen | Lijst van objecten met naamattribuut en typeattribuut: team, user |
| /start | Startdatum | Datum: jjjj-mm-dd |
| /due | Deadline | Datum: jjjj-mm-dd |
| /status | Status | Lijst van objecten met naamattribuut: IJskast, Nog te doen, Mee bezig, Afgerond |
| /ogsm_canvases/#/id | ID van de OGSM waarin de actie staat | Nummer |
| /ogsm_canvases/#/row_order | Volgorde | Nummer |
| /traffic_light | Verkeerslicht | Lijst van objecten met naamattribuut: groen, oranje, rood |
| /progress | Voortgang | Nummer |
| /archived | Is gearchiveerd | TRUE, FALSE |
| Voortgangsrapportages acties | ||
| /id | ID | Nummer |
| /action/id | ID van de gekoppelde actie | Nummer |
| /at | Datum | Datum: jjjj-mm-dd |
| /traffic_light | Verkeerslicht | Lijst van objecten met naamattribuut: groen, oranje, rood |
| /description | Omschrijving | Tekst (incl. HTML) |
| /progress | Voortgangspercentage | Nummer |
| /status | Status | Lijst van objecten met naamattribuut: IJskast, Nog te doen, Mee bezig, Afgerond |
URL's naar de bestanden
Administrators van het platform kunnen de URL's vinden op de volgende pagina:
- Klik links in het menu op 'Instellingen'.
- Selecteer in het submenu 'API'.
Gebruikersnaam en wachtwoord instellen
- Klik op de pagina met het overzicht van de bestanden op het tandwieltje rechtsboven.
- Typ de gewenste gebruikersnaam en het gewenste wachtwoord.
- Klik op 'Opslaan' om de wijzigingen te bewaren.
Let op: het wachtwoord is nadat je deze hebt getypt niet (meer) zichtbaar.
Metingen van doelstellingen en indicatoren updaten via de API
Het is met de API ook mogelijk nieuwe metingen aan te maken bij doelstellingen en indicatoren. Neem contact op voor de instructie.