Ga naar hoofdinhoud
Versie: Versie 22

Connector

Introductie​

Een connector is een enkele OData-koppeling naar FCC-data, met eigen toegangsbeheer en authenticatiesleutels. Open een connector vanuit het Connectors-overzicht om deze te beheren. Dit artikel beschrijft de connectorpagina en de queryopties van de OData-feed.

De connectorpagina​

De connectorpagina toont:

  • OData Link: de URL die externe tools gebruiken om de data op te halen. Kopieer deze met de kopieerknop.
  • Members: wie toegang heeft tot deze connector.
  • Authentication Keys: de sleutels die toegang tot de feed verlenen. Voeg een sleutel toe met + Key (met een omschrijving en een vervaldatum). De sleutelwaarde wordt eenmalig getoond en daarna gemaskeerd. Verwijder een sleutel met Delete.

Let op: Sleutels verlopen op de ingestelde datum. Plan het rouleren van sleutels vóór het verlopen, anders vernieuwen rapporten niet meer. Behandel sleutels als geheimen.

De OData-feed bevragen​

Er zijn endpoints beschikbaar voor de verschillende objecten (bijvoorbeeld Project, Portfolio). Gebruik het rootniveau van de OData-link om de beschikbare endpoints op te halen, en /$metadata om de beschikbare velden te zien.

Relevante kolommen selecteren​

Gebruik de queryparameter $select om de relevante kolommen te selecteren:

$select=Name,Portfolio

Relevante rijen selecteren​

Gebruik de queryparameter $filter om relevante rijen te selecteren, bijvoorbeeld projecten uit een specifiek portfolio:

$filter=Portfolio eq 12368613

Een filter op SystemModificationDate haalt alleen objecten op die sinds een bepaalde datum zijn gewijzigd, nuttig voor incrementele loads.

Paginering​

De endpoints gebruiken server-driven paging met een maximale paginagrootte van 1000 records per request, ook wanneer de client met $top meer records opvraagt.

  • Bij $top=1500 retourneert de eerste request 1000 records, en bevat de response een @odata.nextLink voor de resterende 500.
  • Gebruik $skip om vanaf een ander punt te lezen. Gebruik voor de beste performance $skip in veelvouden van de paginagrootte (1000, 2000, ...).
  • Wanneer $skip het totaal aantal records overschrijdt, retourneert de response een lege array zonder @odata.nextLink.

Gearchiveerde items​

Gearchiveerde items worden standaard uitgesloten. Om ze op te nemen:

$filter=_archived eq 1 or _archived eq 0

Het totaal aantal rijen ophalen​

$inlinecount=allpages

Entry endpoints​

Er zijn drie speciale endpoints beschikbaar voor boekingen: /CostEntry, /HourEntry en /ObjectiveEntry.

  • $filter ondersteunt basisoperatoren zoals eq, gt, lt en ne.
  • $select: de geselecteerde kolommen worden gebruikt om de geretourneerde waarden te groeperen en aggregeren. De standaardwaarden zijn Startdate, Type en het waardeveld. Groeperen op waardevelden (bijvoorbeeld Actual, Allocation, Reserved) heeft geen effect, omdat deze groepering standaard wordt toegepast. Bij het selecteren van een weergavewaarde of sleutelkolom worden beide waarden geretourneerd.
  • Parameters voor de timeline-horizon:
    • scale: Days, Weeks, Months, Quarters of Years (standaard: Months).
    • startdate: notatie YYYY-MM-DD (standaard: 1 januari van het huidige jaar).
    • horizon: positief geheel getal, de duur in maanden (standaard: 12).
    • Ongeldige waarden resulteren in een foutresponse.

Voorbeeld:

.../BiConnectivityOdataConnector/<id>/HourEntry?$select=Portfolio,Portfolio_Item&$filter=Type eq 'Capacity'&$inlinecount=allpages&scale=Quarters&startdate=2026-01-01&horizon=24

Meer hulp nodig?​

Neem voor stapsgewijze instructies of hulp bij problemen contact op met je Fortes Change Cloud-beheerder of raadpleeg de in-app help.