Workday Extend · Schema

GraphQueryRequest

AutomationCustom ApplicationsEnterpriseExtensionsHCMHuman Capital ManagementIntegrationOrchestrationPaaS

Properties

Name Type Description
query string The graph query string specifying the business objects, fields, filters, and relationships to retrieve
variables object Variables to substitute into the query. Referenced in the query using the $variableName syntax.
limit integer Maximum number of results to return
offset integer Number of results to skip for pagination
View JSON Schema on GitHub

JSON Schema

workday-extend-graphqueryrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GraphQueryRequest",
  "title": "GraphQueryRequest",
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "query": {
      "type": "string",
      "description": "The graph query string specifying the business objects, fields, filters, and relationships to retrieve"
    },
    "variables": {
      "type": "object",
      "additionalProperties": true,
      "description": "Variables to substitute into the query. Referenced in the query using the $variableName syntax."
    },
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "description": "Maximum number of results to return"
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "description": "Number of results to skip for pagination"
    }
  }
}