參照︰WQL REST API

GET /data

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

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

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

POST /資料

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

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

GET /dataSources

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

{baseURL}/dataSources/aae24a47e36110000a37dcb7628d000d
 

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

{baseURL}/datasources/aae24a47e36110000a37dcb7628d000d/fields

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

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

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

{baseURL}/dataSources/6d34556ff015100012a60a4bb1ce0b92/dataSourceFilters
 

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