Lists available fields within data sources, along with their associated business objects. Users can retrieve detailed metadata about each field, including access control restrictions based on security settings.

Workday Resource Information

Retrieves the field with a specified {ID} for the specific data source. Also retrieves the related business object of the field. You can only view fields and data sources that you have security access to.

Secured by: Development, WQL for Workday Extend, Workday Query Language+TG

Scope: System

Aggregate Fields

The component represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.

This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.

OptionalParameters_Aggregate

[{
  alias: Text /* This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. */
  description: Text /* Description for Query Parameter for External Promptable */
  type: Text /* Returns "Text", "Date", "Numeric", "Currency", "Boolean", "Single Instance" or "Multi Instance". */
  workData: {
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
}]

RelatedFields_Aggregate

[{
  alias: Text /* This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. */
  descriptor: Text /* A preview of the instance */
  href: Text /* A link to the instance */
  id: Text /* Id of the instance */
  relatedBusinessObject: { /* Related Business Object */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  type: Text /* The type of the field */
}]

RequiredParameters_Aggregate

[{
  alias: Text /* This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. */
  description: Text /* Description for Query Parameter for External Promptable */
  type: Text /* Returns "Text", "Date", "Numeric", "Currency", "Boolean", "Single Instance" or "Multi Instance". */
  workData: {
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
}]

Columns

Name	Type	Description
Id [KEY]	String	Unique identifier of the instance within Workday.
DataSources_Id [KEY]	String	The unique Workday identifier (WID) of the DataSources that owns this element, used to establish ownership and context.
Alias	String	Internal Workday Query Language (WQL) alias used to reference this element in queries.
Descriptor	String	A brief preview or summary of the instance for quick identification.
Href	String	A URL link pointing to the specific instance within Workday.
OptionalParameters_Aggregate	String	Optional parameters available for use in WQL, allowing additional query customization.
RelatedBusinessObject_Descriptor	String	A textual description of the related business object for contextual understanding.
RelatedBusinessObject_Href	String	A URL link pointing to the related business object within Workday.
RelatedBusinessObject_Id	String	Identifier for the related business object, which can be a WID, a standard Id, or a reference Id.
RelatedFields_Aggregate	String	Collection of fields from the related business object that can be accessed or referenced.
RequiredParameters_Aggregate	String	Required parameters that must be provided when using WQL to ensure the query executes correctly.
Type	String	Specifies the type of the field, indicating its data format and usage.
Alias_Prompt	String	Prompt text guiding users to enter the alias of the data source field.
SearchString_Prompt	String	Prompt text for entering a search string that is matched in a case-insensitive manner within the descriptors of the data source fields.
Alias_Prompt_For_DataSources	String	Prompt text guiding users to enter the alias of the data source itself.
SearchString_Prompt_For_DataSources	String	Prompt text for entering a search string that is matched in a case-insensitive manner within the descriptors of the data sources.