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 de 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:

query

parámetro de

GET /data

punto final

El cuerpo de la solicitud de la

POST /data

punto final

Antes de crear su solicitud, puede realizar llamadas con el

GET /dataSources/

GET /dataSources/{ID}

puntos finales para verificar los nombres de alias correctos que se van a utilizar.

Consulte Referencia: alias de WQL.

Tanto los hosts arrendados como la pasarela de API de Workday Cloud Platform (WCP) 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 usar
Host definido por Workday	https://{hostname}/api/wql/{version}/{tenant}
Pasarela de API de WCP	https://api.workday.com/wql/{version}

GET /datos

Devuelve los datos de una consulta WQL. Utilice esta solicitud para consultas con menos de 2048 caracteres. Solo puede consultar los datos a los que tiene acceso de seguridad. El WQL se ejecuta mediante 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 15 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 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. El WQL se ejecuta mediante el

query

parámetro Coloque el

query

el parámetro y la consulta en el cuerpo de la solicitud de la llamada a la 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

Devuelve un conjunto de orígenes de datos para su uso en una consulta de WQL. La solicitud también devuelve el objeto de gestión principal de los orígenes de datos.

Syntax:

{baseURL}/dataSources/

Consulta de ejemplo:

{baseURL}/dataSources

Ejemplo de respuesta JSON:

{
"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}

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 del origen de datos.

Syntax:

{baseURL}/dataSources/‹datasource_wid›

Consulta de ejemplo:

{baseURL}/dataSources/aae24a47e36110000a37dcb7628d000d

Ejemplo de respuesta JSON:

{
"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

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/aae24a47e36110000a37dcb7628d000d/fields/09d50672a44001ea5d41efcfd6419a00

Ejemplo de respuesta JSON:

{
 "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

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"
    },
    ...
]
}

Concepto: lenguaje de consulta de Workday (WQL)

Registro de clientes de API para integraciones