Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Administrator Guide
Zuletzt aktualisiert: 2024-11-15
Referenz: WQL-REST-API

Referenz: WQL-REST-API

Verwenden Sie die WQL-REST-API, um Folgendes zurückzugeben:
  • Eine Liste der Datenquellen und Datenquellenfilter.
  • Details zu einer bestimmten Datenquelle
  • Die primären Geschäftsobjekte für eine bestimmte Datenquelle.
  • Felder in einer Datenquelle.
  • Das zugehörige Geschäftsobjekt für ein bestimmtes Feld.
Sie können die Informationen aus der Antwort verwenden, um eine WQL-Anforderung zu erstellen:
  • Die
    query
     Parameter von
    GET /data
     Endpunkt.
  • Der Anforderungstext von
    POST /data
     Endpunkt.
Bevor Sie Ihre Anforderung erstellen, können Sie mit aufrufen
GET /dataSources/
 und
GET /dataSources/{ID}
 -Endpunkte, um zu überprüfen, ob die richtigen Aliasnamen verwendet werden sollen.
Sowohl mandantendefinierte Hosts als auch das API-Gateway für die Workday Cloud Platform (WCP) unterstützen WQL-Anforderungen. Je nachdem, von wo aus Sie WQL-Anforderungen stellen, ist die von Ihnen verwendete Basis-URL unterschiedlich.
WQL-Anforderungsquelle
Zu verwendende Basis-URL
Mandantendefinierter Workday-Host
https://{hostname}/api/wql/{version}/{tenant}
WCP-API-Gateway
https://api.workday.com/wql/{version}

GET /data

Gibt die Daten aus einer WQL-Abfrage zurück. Verwenden Sie diese Anforderung für Abfragen mit weniger als 2.048 Zeichen. Sie können nur Daten anzeigen, für 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-Beispielantwort:
{
"total": 152,
"data": [
    {
        "location": {
            "descriptor": "Academic Location WATS 1",
            "id": "5403216f5ef810381796f3bb216504f5"
        },
        "max(yearsOfService)": "20"
    },
    ...
]
}
Workday löscht im Cache gespeicherte WQL-Abfrageergebnisse nach 15 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 /data

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

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

GET /dataSources

Gibt eine Sammlung von Datenquellen zur Verwendung in einer WQL-Abfrage zurück. Die Anforderung gibt auch das primäre Geschäftsobjekt für die Datenquellen zurück.
Syntax:
{baseURL}/dataSources/
Beispielabfrage:
{baseURL}/dataSources
JSON-Beispielantwort:
{
"total": 1722,
"data": [
    {
        "id": "6d34556ff015100012a60a4bb1ce0b92",
        "descriptor": "Student Applications",
        "alias": "studentApplications",
        "description": "Accesses the Student Application object and returns one row for each application. Includes data source filters with built-in prompts. You can use this data source to list student applications and related data."
        "primaryBusinessObject":  {
               "Descriptor": "Student Application",
               "id": "8b7dc084c617100028ff0f3bdbf000ac"
        },
    },
    ...
]
}

GET /dataSources/{ID}

Gibt eine Datenquelle für die angegebene ID zur Verwendung in einer WQL-Abfrage zurück. Die Anforderung gibt auch das primäre Geschäftsobjekt für die Datenquelle zurück.
Syntax:
{baseURL}/dataSources/‹datasource_wid›
Beispielabfrage: 
{baseURL}/dataSources/aae24a47e36110000a37dcb7628d000d
JSON-Beispielantwort:
{
"id": "aae24a47e36110000a37dcb7628d000d",
"descriptor": "Indexed In Progress ~Worker~ Calibration Placements",
"primaryBusinessObject": {
  "descriptor": "Indexed In Progress ~Worker~ Calibration Placements",
  "id": "aae24a47e36110000a37dd177601000e"
},
"requiredParameters": [...],
"filterIsRequired": false,
"optionalParameters": [...],
"supportsEntryDate": false,
"alias": "indexedInProgressWorkerCalibrationPlacements",
"supportsEffectiveDate": 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."
}

GET /dataSources/{ID}/fields

Gibt die Felder einer bestimmten Datenquelle zur Verwendung in einer WQL-Abfrage zurück. Die Anforderung gibt auch das zugehörige Geschäftsobjekt für jedes Feld zurück.
Syntax:
{baseURL}/dataSources/‹datasource_wid›/fields
Beispielabfrage: 
{baseURL}/datasources/aae24a47e36110000a37dcb7628d000d/fields
JSON-Beispielantwort:
{
 "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 als angegeben ist
{subresourceID}
. Die Anforderung gibt auch das zugehörige Geschäftsobjekt für jedes Feld zurück.
Syntax:
{baseURL}/dataSources/‹datasource_wid›/fields/{subresourceID}
Beispielabfrage: 
{baseURL}/dataSources/aae24a47e36110000a37dcb7628d000d/fields/09d50672a44001ea5d41efcfd6419a00
JSON-Beispielantwort:
{
 "id": "09d50672a44001ea5d41efcfd6419a00",
 "descriptor": "Trended Worker Org for Cost Center_Current_QA (tenant setup)",
 "relatedFields":[...]
 "relatedBusinessObject": {
   "descriptor": "Position Set",
   "id": "373872302e7e4afe96aa37c0dd93e53e"
 },
 "type": "Single instance",
 "alias": "cf_TrendedWorkerOrgForCostCenter_Current_QATenantSetup"
}

GET /dataSources/{ID}/dataSourceFilters

Gibt die Datenquellenfilter für eine bestimmte Datenquelle zur Verwendung in einer WQL-Abfrage zurück.
Syntax:
{baseURL}/dataSources/‹datasource_wid›/dataSourceFilters
Beispielabfrage: 
{baseURL}/dataSources/6d34556ff015100012a60a4bb1ce0b92/dataSourceFilters
JSON-Beispielantwort:
{
"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"
    },
    ...
]
}