Stores metadata definitions for custom objects within Workday, detailing their attributes, structure, and relationships. This table provides foundational information for managing custom object schemas.

Workday Resource Information

Retrieves a custom object definition for a multi-instance or single-instance custom object with the specified ID.

Secured by: Custom Object Management, Workday Designer

Scope: System, Workday Designer

Aggregate Fields

The connector 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.

Domains_Aggregate

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

Fields_Aggregate

[{
 *alias: Text /* The web service alias of the custom field. */
 *authorizedUsages: [{
      descriptor: Text /* The display name of the instance */
      href: Text /* A link to the instance */
      id: Text /* Id of the instance */
  }]
 *categories: [{
      descriptor: Text /* The display name of the instance */
      href: Text /* A link to the instance */
      id: Text /* Id of the instance */
  }]
  descriptor: Text /* The display name of the instance */
  displayOptions: [{
      descriptor: Text /* The display name of the instance */
      href: Text /* A link to the instance */
      id: Text /* Id of the instance */
  }]
  draft: Boolean /* If true, the custom field is not activated yet and it is saved as a draft. */
 *fieldType: { /* The field type of the custom field. */
     -descriptor: Text /* The display name of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  href: Text /* A link to the instance */
  id: Text /* Id of the instance */
  inactive: Boolean /* If true, the custom field should no longer be used. */
 *name: Text /* The name of the custom field on the business object. */
  order: Text /* The order of the custom field. */
  prompts: [{
      descriptor: Text /* The display name of the instance */
      href: Text /* A link to the instance */
      id: Text /* Id of the instance */
  }]
  validations: [{
      descriptor: Text /* The display name 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 of the custom object instance, used for internal and external references.
Active	Bool	False	Indicates whether the custom object definition is currently active or still in a draft state.
Alias	String	False	The web service alias of the custom object, used for API interactions.
BusinessObjectFilter_Descriptor	String	False	The display name of the instance
BusinessObjectFilter_Href	String	False	URL link to the business object filter instance, enabling direct access.
BusinessObjectFilter_Id	String	False	Unique identifier (WID, Id, or reference Id) of the business object filter.
BusinessObject_Descriptor	String	False	The display name of the instance
BusinessObject_Href	String	False	URL link to the related business object instance for easy navigation.
BusinessObject_Id	String	False	Unique identifier (WID, Id, or reference Id) of the related business object.
Descriptor	String	False	The display name of the instance
DisplayValue_Id	String	False	Unique identifier (WID, Id, or reference Id) representing the display value of the object.
Domains_Aggregate	String	False	Lists the Security Domains that control access to this custom object, separated by commas with 1 space after each comma.
Fields_Aggregate	String	False	Lists all custom fields associated with the custom object, separated by commas with 1 space after each comma.
HelpText	String	False	Text that provides guidance or context for using the custom object within the application.
HideOnView	Bool	False	If true, the field is hidden from view when it is unpopulated.
Href	String	False	URL link to the custom object instance for direct access.
MultiInstance	Bool	False	If true, the custom object allows multiple instances to be associated with the extended business object.
Name	String	False	The name of the custom object, typically used for display and identification.
ReferenceId_Id	String	False	Unique identifier (WID, Id, or reference Id) of the reference Id associated with this instance.
UiVisibilityRule_Id	String	False	Unique identifier (WID, Id, or reference Id) of the UI visibility rule that controls the display of this object.