Defines individual fields within custom objects, outlining their properties, data types, and relationships. This table serves as a reference for understanding the structure of custom objects.

Workday Resource Information

Retrieves a field in a custom object definition with the specified ID.

Secured by: Custom Object Management, Workday Designer

Scope: System, Workday Designer

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.

AuthorizedUsages_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  href: Text /* A link to the instance */
  id: Text /* Id of the instance */
}]

Categories_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  href: Text /* A link to the instance */
  id: Text /* Id of the instance */
}]

DisplayOptions_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  href: Text /* A link to the instance */
  id: Text /* Id of the instance */
}]

Prompts_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  href: Text /* A link to the instance */
  id: Text /* Id of the instance */
}]

Validations_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  href: Text /* A link to the instance */
  id: Text /* Id of the instance */
}]

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Unique identifier for the instance of the custom field.
Definitions_Id [KEY]	String	False	The Workday identifier (WID) of the Definitions object that owns this custom field.
Alias	String	False	The web service alias used to reference the custom field in integrations and reports.
AuthorizedUsages_Aggregate	String	False	Specifies the application areas where the custom field is intended to be used, such as reporting, business processes, or integrations.
Categories_Aggregate	String	False	Lists one or more categories associated with the custom field, used for organizing and filtering fields.
Descriptor	String	False	A text preview that provides a human-readable summary of the instance.
DisplayOptions_Aggregate	String	False	Lists one or more display options configured for the custom field, such as formatting or visibility settings.
Draft	Bool	False	Indicates whether the custom field is saved as a draft. If 'true', the field is not yet active.
FieldType_Descriptor	String	False	A brief description of the custom field type, such as text, number, or date.
FieldType_Href	String	False	A URL link to the Workday reference page for the custom field type.
FieldType_Id	String	False	The unique identifier of the custom field type, which may be a WID, standard Id, or reference Id.
Href	String	False	A URL link to the Workday reference page for this custom field.
Inactive	Bool	False	Indicates whether the custom field is inactive. If 'true', the field should no longer be used.
Name	String	False	The name of the custom field as displayed on the associated business object.
Order	String	False	Specifies the display order of the custom field when shown in forms, reports, or business processes.
Prompts_Aggregate	String	False	Lists the prompt Ids associated with this custom field, used to capture user input or selections.
Validations_Aggregate	String	False	Lists one or more custom field validations applied to ensure data accuracy and compliance with business rules.