Skip to main content
Documentatie
Documentatie
Administrator Guide
Laatst bijgewerkt: 2026-03-13
Referentie: WQL REST-API

Referentie: WQL REST-API

Gebruik de WQL- REST-API om het volgende te retourneren:
  • Een lijst met gegevensbronnen en gegevensbron .
  • Details over een specifieke gegevensbron.
  • De primaire bedrijfsobjecten voor een specifieke gegevensbron ().
  • Velden in een gegevensbron ''.
  • Het gerelateerd bedrijfsobject voor een specifiek veld.
U kunt de informatie uit het antwoord gebruiken om een WQL- aanvraag te maken in:
  • The
    query
     parameter van de
    GET /data
     eindpunt.
  • De hoofdtekst van de aanvraag van
    POST /data
     eindpunt.
Voordat u uw aanvraag maakt, kunt u aanroepen met de
GET /dataSources/
 and
GET /dataSources/{ID}
 eindpunten om de juiste alias te controleren die moeten worden gebruikt.
Zowel tenanted hosts als de API gateway van het Workday Cloud Platform (WCP) ondersteunen WQL-aanvragen. De basis-URL die u gebruikt, verschilt afhankelijk van waar u WQL-aanvragen indient.
WQL-aanvraagbron
Te gebruiken basis-URL
tenanted Workday host
https://{hostname}/api/wql/{version}/{tenant}
API gateway WCP
https://api.workday.com/wql/{version}

GET /data

Retourneert de gegevens van een WQL-query. Gebruik deze aanvraag voor query's met minder dan 2048 tekens. U kunt alleen gegevens weergeven waartoe u toegangsrechten hebt. U voert WQL uit met de
query
 parameter.
Syntaxis:
{baseURL}/data?query={myquery}
Voorbeeldquery:
{baseURL}/data?query=SELECT location, max(yearsOfService) FROM allWorkers GROUP BY location
Voorbeeld van JSON antwoord:
{
"total": 152,
"data": [
    {
        "location": {
            "descriptor": "Academic Location WATS 1",
            "id": "5403216f5ef810381796f3bb216504f5"
        },
        "max(yearsOfService)": "20"
    },
    ...
]
}
De in de cache opgeslagen WQL-queryresultaten worden na 30 minuten gewist. Als u de cache handmatig wilt wissen, kunt u toevoegen:
offset=0
 aan uw query. Voorbeeld:
{baseURL}/data?offset=0&query=SELECT firstName, location FROM allWorkers

POST /data

Retourneert de gegevens van een WQL-query. Gebruik deze aanvraag voor query's tussen 2.048 en 16.000 tekens. U kunt alleen gegevens weergeven waartoe u toegangsrechten hebt. U voert WQL uit met de
query
 parameter. Plaats de
query
 en query in de hoofdtekst van de aanvraag van de API aanroep.
Syntaxis:
{baseURL}/data/
Hoofdtekst van aanvraag :

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

GET /dataSources

Retourneert:
  • Een verzameling gegevensbronnen voor gebruik in een WQL-query.
  • Het primair bedrijfsobject voor de gegevensbronnen.
  • Indexeringsgegevens van de gegevensbronnen.
Syntax:
{baseURL}/dataSources/
Voorbeeldquery:
{baseURL}/dataSources
Voorbeeld van JSON antwoord:
{
  "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"
    },
  ……
  ]
}
Voorbeeldquery met optioneel filter ''. Retourneert geïndexeerde gegevensbronnen wanneer het filter 'SourceIndexType' = Indexed wordt gebruikt.:
{baseURL}/dataSources?SourceIndexType=Indexed
Voorbeeld van JSON antwoord:
{
  "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}

Retourneert een gegevensbron voor de opgegeven ID voor gebruik in een WQL-query. De aanvraag retourneert ook het primair bedrijfsobject voor de gegevensbron ''.
Syntax:
{baseURL}/dataSources/‹datasource_wid›
Voorbeeldquery: 

{baseURL}/dataSources/aae24a47e36110000a37dcb7628d000d
Voorbeeld van JSON antwoord:
{
  "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

Retourneert de velden van een specifieke gegevensbron voor gebruik in een WQL-query. De aanvraag retourneert ook het gerelateerd bedrijfsobject voor elk veld.
Syntaxis:
{baseURL}/dataSources/‹datasource_wid›/fields
Voorbeeldquery: 
{baseURL}/datasources/aae24a47e36110000a37dcb7628d000d/fields
Voorbeeld van JSON antwoord:
{
 "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}

Retourneert details voor een bepaald veld wanneer de ID voor het veld is opgegeven als ''
{subresourceID}
 . De aanvraag retourneert ook het gerelateerd bedrijfsobject voor elk veld.
Syntaxis:
{baseURL}/dataSources/‹datasource_wid›/fields/{subresourceID}
Voorbeeldquery:
{baseURL}/dataSources/7884e9fbf68c10000b2b632e6e0100f1/fields/bb4ed38524451000419c823f09ba1587
Voorbeeld van JSON antwoord:
{
  "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

Retourneert de gegevensbron voor een specifieke gegevensbron voor gebruik in een WQL-query.
Syntaxis:
{baseURL}/dataSources/‹datasource_wid›/dataSourceFilters
Voorbeeldquery: 
{baseURL}/dataSources/6d34556ff015100012a60a4bb1ce0b92/dataSourceFilters
Voorbeeld van JSON antwoord:
{
"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"
    },
    ...
]
}