Konfigurationen zur Verwendung der Workday REST API

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 3 Minuten Lesedauer

    • Konfigurieren Sie Ihre Instanz ServiceNow, um Aktionen auszuführen, die die REST-API Workday verwenden.

    Vorbereitungen

    • Fordern Sie ein IntegrationHub -Abonnement an.
    • Aktivieren Sie die Spoke Workday HR.
    • Rufen Sie diese Werte aus Workday ab, und zeichnen Sie sie zur späteren Verwendung auf. Diese Werte sind erforderlich, um Ihren Client zu registrieren:
      • Client-ID
      • Geheimer Clientschlüssel
      • Workday REST-API-Endpunkt
      • Token-Endpunkt
      • Autorisierungsendpunkt
    • Erforderliche Rolle: admin

    Warum und wann dieser Vorgang ausgeführt wird

    Workday REST und die RAAS-API (Report-as-a-Service) arbeiten mit OAuth 2.0 zusammen, um den Zugriff auf Ressourcen in Ihrem Workday -Mandanten zu autorisieren. Um OAuth 2.0 zu verwenden, müssen Sie Ihren Client mithilfe der Aufgabe „API-Client registrieren“ im -Mandanten registrieren.

    Konfigurieren Sie Ihre Instanz ServiceNow für die Verwendung der REST-API Workday, wenn Sie die folgenden REST-basierten Spoke-Aktionen verwenden müssen:
    • Meine Berichtsstruktur abrufen
    • Benutzerdefinierte Objektfelder suchen
    • Benutzerdefinierte Objektfelder aktualisieren
    • Gehaltsabrechnung suchen
    • Sucht mithilfe des Berichts nach Gesamtprämien
    • Benutzerdefinierte Berichte suchen
    • Posteingangselemente suchen
    • Leistungs- und Leistungsplandetails eines Mitarbeiters suchen
    • Referenz-WID der Feiertagskalender eines Mitarbeiters suchen
    • Referenz-WID der Zeitplankalender eines Mitarbeiters suchen
    • Feiertagskalender eines Mitarbeiters suchen
    Hinweis:
    Diese Konfigurationen sind erforderlich, um die REST-basierten Spoke-Aktionen zu verwenden.

    Registrieren Sie Workday HR als OAuth-Provider

    Registrieren Sie die Instanz Workday HR als OAuth-Provider, damit die Instanz ServiceNow OAuth 2.0-Token anfordern kann.

    Vorbereitungen

    Erforderliche Rolle: admin

    Prozedur

    1. Navigieren zu Alle > System-OAuth > Applikationsregistrierung.
    2. Klicken Sie auf Neu.
      Das System zeigt die folgende Meldung an: Welche Art von OAuth-Anwendung?.
    3. Wählen Sie Verbindung zu einem fremden OAuth-Provider herstellen aus.
    4. Füllen Sie diese Werte im Formular aus.
      Tabelle : 1. Formular „Anwendungsregistrierungen“
      Feld Beschreibung
      Name Name zur eindeutigen Identifizierung des Datensatzes. Geben Sie beispielsweise Folgendes ein: Workday-HR-OAuth
      Anwendung Anwendung, in der der Datensatz anwendbar ist. Wählen Sie Workday HR-Spoke aus.
      Client-ID Client-ID, die bei der Registrierung Ihres Clients generiert wurde.
      Geheimer Clientschlüssel Geheimer Clientschlüssel, der bei der Registrierung Ihres Clients generiert wurde.
      Autorisierungs-URL Autorisierungsendpunkt, der bei der Registrierung Ihres Clients generiert wird.
      Token-URL Token-Endpunkt, der bei der Registrierung Ihres Clients generiert wird.
      Umleitungs-URL OAuth-Rückrufendpunkt in diesem Format: https://<instance> .service-now.com/oauth_redirect.do
      Standardgewährungstyp Zum Erstellen des Tokens verwendeter Gewährungstyp. Wählen Sie Autorisierungscode aus.
      Aktiv Option zur aktiven Verwendung der Anwendungsregistrierung.
    5. Klicken Sie mit der rechten Maustaste auf den Formularheader und wählen Sie Speichern aus.
      Ein OAuth-Entitätsprofil wird erstellt.

    Erstellen Sie einen Anmeldeinformationsdatensatz für die Spoke Workday HR .

    Erstellen Sie einen Anmeldeinformationsdatensatz für die Instanz Workday HR. Der Alias für Verbindungen und Anmeldeinformationen der Spoke Workday HR verwendet diese Anmeldeinformationen zum Autorisieren von Aktionen.

    Vorbereitungen

    Erforderliche Rolle: admin.

    Prozedur

    1. Navigieren zu Alle > Verbindungen und Anmeldeinformationen > Berechtigungen.
    2. Klicken Sie auf Neu.

      Das System zeigt die folgende Meldung an: Welche Art von Anmeldeinformationen möchten Sie erstellen?

    3. Wählen Sie OAuth 2.0-Anmeldeinformationen aus.
    4. Füllen Sie diese Werte im Formular aus.
      Tabelle : 2. Formular „OAuth 2.0-Anmeldeinformationen“
      Feld Beschreibung
      Name Name zur eindeutigen Identifizierung des Datensatzes. Beispiel: Workday HR-Anmeldeinformationen.
      Aktiv Option zur aktiven Verwendung des Anmeldeinformationsdatensatzes.
      OAuth-Einheitenprofil OAuth-Entitätsprofil, das während der Registrierung von Workday HR als OAuth-Provider erstellt wurde. Beispiel: OAuth-Profil.
    5. Klicken Sie mit der rechten Maustaste auf den Formularheader, und klicken Sie auf Absenden.
    6. Um das OAuth-Token zu generieren, klicken Sie auf den zugehörigen Link OAuth-Token abrufen.

    Erstellen Sie einen Verbindungsdatensatz für die Workday-HR-Spoke

    Erstellen Sie einen Verbindungsdatensatz für Ihre Workday HR -Instanz. Die Aliasse für Verbindungen und Anmeldeinformationen der Workday-HR-Spoke verwenden diese Verbindungen zum Ausführen von Aktionen in Workday HR.

    Vorbereitungen

    Erforderliche Rolle: admin.

    Prozedur

    1. Navigieren zu Alle > Verbindungen und Anmeldeinformationen > Aliasse für Verbindungen und Anmeldeinformationen.
    2. Öffnen Sie den Aliasdatensatz WorkdayHR.
    3. Klicken Sie auf der Registerkarte Verbindungen auf Neu.
    4. Füllen Sie die folgenden Felder im Formular aus.
      Hinweis:
      Stellen Sie sicher, dass Sie den Verbindungsdatensatz in der Anwendung Workday HR Spoke erstellen.
      Tabelle : 3. Formular „Verbindung“
      Feld Beschreibung
      Name Name zur eindeutigen Identifizierung des Datensatzes. Beispiel: Workday-HR-Verbindung.
      Anmeldeinformation Für die Workday-HR-Spokeerstellter Anmeldeinformationsdatensatz. Beispiel: Workday HR-Anmeldeinformationen.
      Verbindungsalias Alias-Datensatz, der dieser Verbindung zugeordnet ist.
      Verbindungs-URL URL für die Verbindung mit Ihrer Workday HR -Instanz.
      Aktiv Option zur aktiven Verwendung des Verbindungsdatensatzes.
    5. Geben Sie auf der Registerkarte Attribute diese Werte ein.
      Feld Wert
      Mandantenname Mandantenname Ihrer Anwendung Workday.
      Version v1
    6. Klicken Sie auf Absenden.