Referência: API REST do WQL

Use a API REST WQL para retornar:

Uma lista de fontes de dados e filtros de fonte de dados.

Detalhes sobre uma fonte de dados específica.

Os principais objetos de negócios de uma fonte de dados específica.

Campos em fontes de dados.

O objeto de negócios relacionado para um campo específico.

Você pode usar as informações da resposta para construir uma solicitação WQL em:

query

parâmetro do

GET /data

ponto de extremidade

O corpo da solicitação do

POST /data

ponto de extremidade

Antes de criar sua solicitação, você pode fazer chamadas com o

GET /dataSources/

GET /dataSources/{ID}

Os pontos de extremidade para verificar os nomes de alias corretos a serem usados.

Consulte Referência: aliases WQL.

Tanto os anfitriões definidos pelo locatário como o gateway de API da Workday Cloud Platform (WCP) oferecem suporte a solicitações WQL. Dependendo de onde você faz solicitações WQL, o URL base que você usa é diferente.

Origem da solicitação de WQL	URL base a ser usado
Anfitrião definido pelo locatário do Workday	https://{hostname}/api/wql/{version}/{tenant}
Gateway de API do WCP	https://api.workday.com/wql/{version}

GET /data

Retorna os dados de uma consulta WQL. Use esta solicitação para consultas com menos de 2.048 caracteres. Você só pode visualizar dados aos quais tem acesso de segurança. Você executa o WQL usando o .

query

parâmetro

Syntax:

{baseURL}/data?query={myquery}

Exemplo de consulta:

{baseURL}/data?query=SELECT location, max(yearsOfService) FROM allWorkers GROUP BY location

Exemplo de resposta JSON:

{
"total": 152,
"data": [
    {
        "location": {
            "descriptor": "Academic Location WATS 1",
            "id": "5403216f5ef810381796f3bb216504f5"
        },
        "max(yearsOfService)": "20"
    },
    ...
]
}

O Workday limpa os resultados da consulta WQL armazenados em cache após 15 minutos. Para limpar o cache manualmente, você pode adicionar

offset=0

à sua consulta Exemplo:

{baseURL}/data?offset=0&query=SELECT firstName, location FROM allWorkers

POST /data

Retorna os dados de uma consulta WQL. Use essa solicitação para consultas entre 2.048 e 16.000 caracteres. Você só pode visualizar dados aos quais tem acesso de segurança. Você executa o WQL usando o .

query

parâmetro Coloque o

query

Parâmetro e consulta no corpo da solicitação da chamada de API.

Syntax:

{baseURL}/data/

Corpo da solicitação de exemplo:


{
"query" : "SELECT location, max(yearsOfService) FROM allWorkers GROUP BY location"
}

Exemplo de resposta JSON:

{
"total": 152,
"data": [
    {
        "location": {
            "descriptor": "Academic Location WATS 1",
            "id": "5403216f5ef810381796f3bb216504f5"
        },
        "max(yearsOfService)": "20"
    },
    ...
]
}

GET /dataSources

Retorna uma coleção de fontes de dados para uso em uma consulta WQL. A solicitação também retorna o objeto de negócios principal para as fontes de dados.

Syntax:

{baseURL}/dataSources/

Exemplo de consulta:

{baseURL}/dataSources

Exemplo de resposta 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}

Retorna uma fonte de dados com a ID especificada para uso em uma consulta WQL. A solicitação também retorna o objeto de negócios principal da fonte de dados.

Syntax:

{baseURL}/dataSources/‹datasource_wid›

Exemplo de consulta:

{baseURL}/dataSources/aae24a47e36110000a37dcb7628d000d

Exemplo de resposta 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

Retorna os campos de uma fonte de dados específica para uso em uma consulta WQL. A solicitação também retorna o objeto de negócios relacionado de cada campo.

Syntax:

{baseURL}/dataSources/‹datasource_wid›/fields

Exemplo de consulta:

{baseURL}/datasources/aae24a47e36110000a37dcb7628d000d/fields

Exemplo de resposta 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}

Retorna detalhes de um campo específico quando a ID para o campo é especificada como

{subresourceID}

. A solicitação também retorna o objeto de negócios relacionado de cada campo.

Syntax:

{baseURL}/dataSources/‹datasource_wid›/fields/{subresourceID}

Exemplo de consulta:

{baseURL}/dataSources/aae24a47e36110000a37dcb7628d000d/fields/09d50672a44001ea5d41efcfd6419a00

Exemplo de resposta 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

Retorna os filtros de fonte de dados de uma fonte de dados específica para uso em uma consulta WQL.

Syntax:

{baseURL}/dataSources/‹datasource_wid›/dataSourceFilters

Exemplo de consulta:

{baseURL}/dataSources/6d34556ff015100012a60a4bb1ce0b92/dataSourceFilters

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

Conceito: Workday Query Language (WQL)

Registrar clientes de API para integrações