Concept: REST-API voor Adaptive Planning

Een client roept een API-aanroep aan door een HTTP POST-aanvraag te verzenden naar het hoofdeindpunt van Adaptive Planning-webservices. Het eindpunt bevat een versienummer dat aangeeft welke API-versie wordt gebruikt. De huidige versie van de Adaptive Planning-API is v40. Als uw instance gebruikmaakt van niet op de VS gebaseerde regionale verificatie, verschillen uw autorisatie-URL's en API-eindpunten per regio. Zie Referentie: regionale verificatie-URL's.

API-versies worden over het algemeen bijgewerkt met nieuwe Adaptive Planning-productreleases, maar niet alle productreleases resulteren in een nieuwe API-versie. Workday ondersteunt de huidige versie gedurende ten minste één jaar na de release van de volgende API-versie.

Zie voor een geschiedenis van API-wijzigingen API-wijzigingen op release.

De HTTP POST-aanvraag bevat postgegevens in een XML-document. Dit XML-document bevat standaardsecties die aanwezig zijn in elke API-methodeaanroep en secties die specifiek zijn voor elke API-methodeaanroep. De Adaptive Planning-server verwerkt de API-methodeaanroep en retourneert de resultaten als een ander XML-document. Net als de aanvraag bevat het XML-antwoorddocument secties die hetzelfde zijn voor elke API-methode en secties die specifiek zijn voor elke API-methode.

Bij het ophalen van gegevens wordt een zoekopdracht gebruikt. De aanroeper geeft criteria op voor een aantal elementen en de server antwoordt met een lijst met metagegevensentiteiten of -gegevens die overeenkomen met de criteria. Voor het maken en bijwerken van gegevens worden gegevens in bulk geüpload, die ook worden verzonden via een POST-instructie.

Alle API-aanvragen zijn versleuteld omdat ze het HTTPS-webprotocol moeten gebruiken. De verificatiereferenties van de gebruiker worden naar Adaptive Planning verzonden als onderdeel van de hoofdtekst van de aanvraag voor webservices. Dit betekent dat de weblaag de aanmeld-ID en het wachtwoord van een gebruiker versleutelt voordat deze de computer verlaat die de webservicesaanvraag genereert, en alleen wordt ontsleuteld wanneer de doelserver deze ontvangt.

Als u een gebruiker verifieert in een API-aanvraag, wordt er geen permanente sessie voor die gebruiker gemaakt. voor elke afzonderlijke webserviceaanroep moet de gebruiker afzonderlijk worden geverifieerd.

Bovendien beperken de webservicemethoden de uitvoer van elke aanroep tot de gegevensset die zichtbaar is voor de gebruiker die de aanvraag doet. Voorbeeld: de webservicemethode exportData beperkt de geretourneerde gegevens tot de gegevens op de niveaus waarvan de aanroepende gebruiker eigenaar is.