Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Administrator Guide
Zuletzt aktualisiert: 2026-03-13
Referenz: WQL REST-API

Referenz: WQL REST-API

Verwenden Sie die WQL- REST-API, um Folgendes zurückzugeben:
  • Eine Liste der Datenquellen und Datenquelle .
  • Details zu einer bestimmten Datenquelle:
  • Die primären Geschäftsobjekte für eine bestimmte Datenquelle:
  • Felder in einer Datenquelle: .
  • Das zugehöriges Geschäftsobjekt für ein bestimmtes Feld.
Sie können die Informationen aus der Antwort verwenden, um eine WQL- Anforderung; Antrag wie folgt zu erstellen:
  • Die
    query
     Parameter von "".
    GET /data
     Endpunkt.
  • Der Anforderung; Antrag von
    POST /data
     Endpunkt.
Bevor Sie Ihre Anforderung; Antrag erstellen, können Sie den/die "" aufrufen
GET /dataSources/
 und
GET /dataSources/{ID}
 Endpunkte, um die richtigen Alias zu verifizieren.
Beide mandantendefiniert Hosts und das API (Application Programming Interface) Gateway (WCP) von Workday Cloud Platform unterstützen WQL-Anforderungen. Je nachdem, von wo aus Sie WQL-Anforderungen stellen, unterscheidet sich die von Ihnen verwendete Basis-URL.
WQL-Anforderungsquelle
Zu verwendende Basis-URL
Von Workday mandantendefiniert Host
https://{hostname}/api/wql/{version}/{tenant}
WCP API (Application Programming Interface) Gateway
https://api.workday.com/wql/{version}

GET /data

Gibt die Daten aus einer WQL-Abfrage zurück. Verwenden Sie diese Anforderung; Antrag für Abfragen mit weniger als 2.048 Zeichen. Sie können nur Daten anzeigen, auf die Sie Sicherheitszugriff haben. Sie führen WQL mit aus
query
 Parameter
Syntax:
{baseURL}/data?query={myquery}
Beispielabfrage:
{baseURL}/data?query=SELECT location, max(yearsOfService) FROM allWorkers GROUP BY location
JSON Antwort:
{
"total": 152,
"data": [
    {
        "location": {
            "descriptor": "Academic Location WATS 1",
            "id": "5403216f5ef810381796f3bb216504f5"
        },
        "max(yearsOfService)": "20"
    },
    ...
]
}
Workday löscht im Cache gespeicherte WQL-Abfrageergebnisse nach 30 Minuten. Um den Cache manuell zu löschen, können Sie hinzufügen
offset=0
 zu Ihrer Abfrage. Beispiel:
{baseURL}/data?offset=0&query=SELECT firstName, location FROM allWorkers

POST /Daten

Gibt die Daten aus einer WQL-Abfrage zurück. Verwenden Sie diese Anforderung; Antrag für Abfragen mit zwischen 2.048 und 16.000 Zeichen. Sie können nur Daten anzeigen, auf die Sie Sicherheitszugriff haben. Sie führen WQL mit aus
query
 Parameter Platzieren Sie die
query
 Parameter und Abfrage im Anforderung; Antrag des API (Application Programming Interface) Aufrufs.
Syntax:
{baseURL}/data/
Beispiel für Anforderung; Antrag :

{
"query" : "
SELECT location, max(yearsOfService) FROM allWorkers GROUP BY location
"
}
JSON Antwort: 
{
"total": 152,
"data": [
    {
        "location": {
            "descriptor": "Academic Location WATS 1",
            "id": "5403216f5ef810381796f3bb216504f5"
        },
        "max(yearsOfService)": "20"
    },
    ...
]
}

GET /dataSources

Gibt Folgendes zurück:
  • Eine Sammlung von Datenquellen zur Verwendung in einer WQL-Abfrage.
  • Das primäres Geschäftsobjekt für die Datenquellen.
  • Indizierungsinformationen der Datenquellen.
Syntax:
{baseURL}/dataSources/
Beispielabfrage:
{baseURL}/dataSources
JSON Antwort:
{
  "total": 1722,
  "data": [
    {
      "id": "aae24a47e36110000a37dcb7628d000d",
      "descriptor": "Indexed In Progress ~Worker~ Calibration Placements",
      "alias": "indexedInProgressWorkerCalibrationPlacements",
      "description": "Accesses a ~worker's~ in progress ~worker~ calibration event as the primary business object and the ~worker's~ attributes as the secondary business object. Returns the calibrated values specific to a ~worker~ for an in progress Calibration event.",
      "primaryBusinessObject": {
        "descriptor": "Indexed In Progress ~Worker~ Calibration Placements",
        "id": "aae24a47e36110000a37dd177601000e"
      },
     "dataSourceIndexType": "Indexed"
    },
  ……
  ]
}
Beispielabfrage mit optionalem Filter "". Gibt indizierte Datenquellen zurück, wenn der Filter "SourceIndexType" = Indexed verwendet wird.:
{baseURL}/dataSources?SourceIndexType=Indexed
JSON Antwort:
{
  "total": 35,
  "data": [
    {
      "id": "aae24a47e36110000a37dcb7628d000d",
      "descriptor": "Indexed In Progress ~Worker~ Calibration Placements",
      "alias": "indexedInProgressWorkerCalibrationPlacements",
      "description": "Accesses a ~worker's~ in progress ~worker~ calibration event as the primary business object and the ~worker's~ attributes as the secondary business object. Returns the calibrated values specific to a ~worker~ for an in progress Calibration event.",
      "primaryBusinessObject": {
        "descriptor": "Indexed In Progress ~Worker~ Calibration Placements",
        "id": "aae24a47e36110000a37dd177601000e"
      },
     "dataSourceIndexType": "Indexed"
    },
  ……
  ]
}

GET /dataSources/{ID}

Gibt eine Datenquelle für die angegebene ID zur Verwendung in einer WQL-Abfrage zurück. Die Anforderung; Antrag gibt auch das primäres Geschäftsobjekt für die Datenquelle zurück.
Syntax:
{baseURL}/dataSources/‹datasource_wid›
Beispielabfrage: 

{baseURL}/dataSources/aae24a47e36110000a37dcb7628d000d
JSON Antwort:
{
  "id": "aae24a47e36110000a37dcb7628d000d",
  "descriptor": "Indexed In Progress ~Worker~ Calibration Placements",
  "optionalParameters": [
    {
      "label": "Include ~Terminated~ ~Workers~",
      "alias": "includeTerminatedWorkers",
      "type": "Boolean"
    },
  ...
  ],
  "supportsEntryDate": false,
  "description": "Accesses a ~worker's~ in progress ~worker~ calibration event as the primary business object and the ~worker's~ attributes as the secondary business object. Returns the calibrated values specific to a ~worker~ for an in progress Calibration event.",
  "supportsEffectiveDate": false,
  "alias": "indexedInProgressWorkerCalibrationPlacements",
  "dataSourceIndexType": "Indexed",
  "requiredParameters": [
    {
      "label": "Calibration Node for nBox",
      "type": "Multi-instance",
      "alias": "calibrationNodeForNBox"
    }
  ],
  "fullAlias": "my::indexedInProgressWorkerCalibrationPlacements",
  "filterIsRequired": false,
  "primaryBusinessObject": {
    "descriptor": "Indexed In Progress ~Worker~ Calibration Placements",
    "id": "aae24a47e36110000a37dd177601000e"
  }
}

GET /dataSources/{ID}/fields

Gibt die Felder einer bestimmten Datenquelle zur Verwendung in einer WQL-Abfrage zurück. Die Anforderung; Antrag gibt außerdem für jedes Feld das zugehöriges Geschäftsobjekt zurück.
Syntax:
{baseURL}/dataSources/‹datasource_wid›/fields
Beispielabfrage: 
{baseURL}/datasources/aae24a47e36110000a37dcb7628d000d/fields
JSON Antwort:
{
 "total": 2967,
 "data": [
   {
     "id": "09d50672a44001ea5d41efcfd6419a00",
     "descriptor": "Trended Worker Org for Cost Center_Current_QA (tenant setup)",
     "alias": "cf_TrendedWorkerOrgForCostCenter_Current_QATenantSetup",
     "type": "Single instance",
     "relatedBusinessObject": {
       "descriptor": "Position Set",
       "id": "373872302e7e4afe96aa37c0dd93e53e"
     }
   },...
 ]
}

GET /dataSources/{ID}/fields/{subresourceID}

Gibt Details zu einem bestimmten Feld zurück, wenn die ID für das Feld "" angegeben ist
{subresourceID}
 . Die Anforderung; Antrag gibt außerdem für jedes Feld das zugehöriges Geschäftsobjekt zurück.
Syntax:
{baseURL}/dataSources/‹datasource_wid›/fields/{subresourceID}
Beispielabfrage:
{baseURL}/dataSources/7884e9fbf68c10000b2b632e6e0100f1/fields/bb4ed38524451000419c823f09ba1587
JSON Antwort:
{
  "id": "bb4ed38524451000419c823f09ba1587",
  "descriptor": "ACA IRS 1094-C Reporting - ~Worker~ Included in Full Time Count for September",
  "type": "Boolean",
  "alias": "ACAIRS1094_CReporting_WorkerIncludedInFullTimeCountForSeptember",
  "requiredParameters": [
    {
      "alias": "yearForIRSReporting",
      "label": "Year",
      "type": "Single Instance"
    },
    {
      "type": "Single Instance",
      "alias": "companyWith1094_CCountDataAvailableForYearSelection",
      "label": "Company with 1094-c Count Data Available for Year Selection"
    }
  ],
  "optionalParameters": [
    {
      "type": "Single Instance",
      "alias": "month",
      "label": "Month"
    }
  ]
}

GET /dataSources/{ID}/dataSourceFilters

Gibt die Datenquelle für eine bestimmte Datenquelle zurück zur Verwendung in einer WQL-Abfrage.
Syntax:
{baseURL}/dataSources/‹datasource_wid›/dataSourceFilters
Beispielabfrage: 
{baseURL}/dataSources/6d34556ff015100012a60a4bb1ce0b92/dataSourceFilters
JSON Antwort:
{
"total": 6,
"data": [
    {
        "id": "432abca0a751100008144ff171b8000a",
        "descriptor": "Student Applications for Admissions Cohort Finalize Decisions",
        "alias": "studentApplicationsForAdmissionsCohortFinalizeDecisions",
        "optionalParameters": [
            {
                "type": "Single Instance",
                "description": "The Application Grouping for this Student Application.",
                "alias": "applicationGrouping"
            }
        ],
        "description": "Return Applications that are valid for Publication with this Cohort\n- has an Admissions Decision\n- Decisions Published Status is Confidential - For Internal Use Only\n- No Inactive Status"
    },
    ...
]
}