Referência: API REST WQL

Administrator Guide

Baixar PDF

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 objetos de negócios principais de uma fonte de dados específica .

Campos em uma fonte 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:

O campo

query

parâmetro de

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}

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

ConsultarReferência: aliases WQL .

Tanto os anfitriões definido pelo locatário quanto 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 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 essa solicitação para consultas com menos de 2.048 caracteres. Você só pode visualizar dados aos quais tenha acesso de segurança. Você executa o WQL usando o

query

parâmetro.

Syntax:

{baseURL}/data?query={myquery}

Consulta de exemplo:

{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 30 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 tenha 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 à API .

Syntax:

{baseURL}/data/

Exemplo de corpo de solicitação :


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

Retorna:

Uma coleção de fontes de dados para uso em uma consulta WQL.

O não se aplica para as fontes de dados.

Informações de indexação das fontes de dados.

Syntax:

{baseURL}/dataSources/

Consulta de exemplo:

{baseURL}/dataSources

Exemplo de resposta 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 exemplo com filtro opcional . Retorna fontes de dados indexadas quando o filtro SourceIndexType = Indexado é usado.

{baseURL}/dataSources?SourceIndexType=Indexed

Exemplo de resposta 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 /dataSsourcings/{ID}

Retorna uma fonte de dados para a ID especificada a ser usada em uma consulta WQL. A solicitação também retorna o não se aplica para a fonte de dados.

Syntax:

{baseURL}/dataSources/‹datasource_wid›

Consulta de exemplo:


{baseURL}/dataSources/aae24a47e36110000a37dcb7628d000d

Exemplo de resposta 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 /dataSsourcings/{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 para cada campo.

Syntax:

{baseURL}/dataSources/‹datasource_wid›/fields

Consulta de exemplo:

{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 do campo é especificada como

{subresourceID}

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

Syntax:

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

Consulta de exemplo:

{baseURL}/dataSources/7884e9fbf68c10000b2b632e6e0100f1/fields/bb4ed38524451000419c823f09ba1587

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

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

Consulta de exemplo:

{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