Saltar al contenido principal
Documentación
Documentación
Administrator Guide
Última actualización: 2026-03-13
Referencia: API de REST de WQL

Referencia: API de REST de WQL

Utilice la API de REST de WQL para devolver:
  • Una lista de orígenes de datos y filtros de origen de datos .
  • Detalles sobre un origen de datos específico .
  • Los objetos de gestión principales de un origen de datos específico .
  • Campos en un origen de datos.
  • El objeto de gestión relacionado para un campo específico.
Puede usar la información de la respuesta para crear una solicitud de WQL en:
  • El
    query
     parámetro de la
    GET /data
     punto final
  • El cuerpo de la solicitud de la
    POST /data
     punto final
Antes de elaborar su solicitud, puede realizar llamadas con el
GET /dataSources/
 y
GET /dataSources/{ID}
 puntos finales para verificar los nombres de alias correctos que se van a utilizar.
Tanto los hosts definido por cliente como Workday Cloud Platform (WCP) interfaz de programación de aplicaciones (API) Gateway admiten solicitudes WQL. En función del lugar desde el que realice las solicitudes de WQL, la URL base que utilice será diferente.
Origen de solicitud de WQL
URL base para utilizar
anfitrión definido por cliente Workday
https://{hostname}/api/wql/{version}/{tenant}
Pasarela de interfaz de programación de aplicaciones (API) de WCP
https://api.workday.com/wql/{version}

GET /data

Devuelve los datos de una consulta de WQL. Utilice esta solicitud para consultas con menos de 2048 caracteres. Solo puede consultar los datos a los que tiene acceso de seguridad. Ejecuta WQL con el
query
 parámetro
Sintaxis:
{baseURL}/data?query={myquery}
Consulta de ejemplo:
{baseURL}/data?query=SELECT location, max(yearsOfService) FROM allWorkers GROUP BY location
Ejemplo de respuesta JSON :
{
"total": 152,
"data": [
    {
        "location": {
            "descriptor": "Academic Location WATS 1",
            "id": "5403216f5ef810381796f3bb216504f5"
        },
        "max(yearsOfService)": "20"
    },
    ...
]
}
Workday borra los resultados de consulta de WQL almacenados en caché después de 30 minutos. Para borrar la caché manualmente, puede añadir
offset=0
 a su consulta. Ejemplo:
{baseURL}/data?offset=0&query=SELECT firstName, location FROM allWorkers

POST /data

Devuelve los datos de una consulta de WQL. Utilice esta solicitud para consultas de entre 2048 y 16 000 caracteres. Solo puede consultar los datos a los que tiene acceso de seguridad. Ejecuta WQL con el
query
 parámetro Coloque el
query
 El parámetro y la consulta en el cuerpo de la solicitud de la llamada interfaz de programación de aplicaciones (API) .
Sintaxis:
{baseURL}/data/
Ejemplo de cuerpo de solicitud:

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

GET /dataSources

Presenta:
  • Una colección de orígenes de datos para su uso en una consulta de WQL.
  • El objeto de gestión principal de los orígenes de datos.
  • Información de indexación de los orígenes de datos.
Sintaxis:
{baseURL}/dataSources/
Consulta de ejemplo:
{baseURL}/dataSources
Ejemplo de respuesta JSON :
{
  "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"
    },
  ……
  ]
}
Consulta de ejemplo con filtro opcional . Devuelve orígenes de datos indexados cuando se utiliza el filtro 'SourceIndexType' = Indexed.:
{baseURL}/dataSources?SourceIndexType=Indexed
Ejemplo de respuesta JSON :
{
  "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}

Devuelve un origen de datos para el ID especificado para usarlo en una consulta de WQL. La solicitud también devuelve el objeto de gestión principal para el origen de datos.
Sintaxis:
{baseURL}/dataSources/‹datasource_wid›
Consulta de ejemplo: 

{baseURL}/dataSources/aae24a47e36110000a37dcb7628d000d
Ejemplo de respuesta JSON :
{
  "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

Devuelve los campos de un origen de datos específico para usarlos en una consulta de WQL. La solicitud también devuelve el objeto de gestión relacionado para cada campo.
Sintaxis:
{baseURL}/dataSources/‹datasource_wid›/fields
Consulta de ejemplo: 
{baseURL}/datasources/aae24a47e36110000a37dcb7628d000d/fields
Ejemplo de respuesta JSON :
{
 "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}

Devuelve los detalles de un campo en particular cuando el ID del campo se especifica como el
{subresourceID}
 . La solicitud también devuelve el objeto de gestión relacionado para cada campo.
Sintaxis:
{baseURL}/dataSources/‹datasource_wid›/fields/{subresourceID}
Consulta de ejemplo:
{baseURL}/dataSources/7884e9fbf68c10000b2b632e6e0100f1/fields/bb4ed38524451000419c823f09ba1587
Ejemplo de respuesta JSON :
{
  "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

Devuelve los filtros de origen de datos de un origen de datos específico para usarlos en una consulta de WQL.
Sintaxis:
{baseURL}/dataSources/‹datasource_wid›/dataSourceFilters
Consulta de ejemplo: 
{baseURL}/dataSources/6d34556ff015100012a60a4bb1ce0b92/dataSourceFilters
Ejemplo de respuesta JSON :
{
"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"
    },
    ...
]
}