Cmdlets for Workday

Build 25.0.9434

FieldTypes

Defines custom field types that can be used across different Workday objects, enabling organizations to extend standard data structures.

Workday Resource Information

Retrieves all custom field types.

This method returns the native field type Workday ID in fieldType{id}. You can use the field type Workday ID to filter the custom field types.

Secured by: Custom Object Management, Workday Designer

Scope: System, Workday Designer

Aggregate Fields

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

ListInfo_Values_Aggregate


[{
  alias: Text /* The web service alias of the custom list value. */
  descriptor: Text /* A preview of the instance */
  href: Text /* A link to the instance */
  id: Text /* Id of the instance */
  inactive: Boolean /* If true, the custom list value is not active and should not be used. */
  name: Text /* The name of a custom list value. */
  order: Text /* The order of the custom list value. */
}]

Columns

Name Type ReadOnly Description
Id [KEY] String False

Unique identifier for the custom field type instance.

Alias String False

The web service alias used to reference the custom field type in integrations and APIs.

CurrencyInfo_Max Decimal False

Maximum allowable value for a custom currency field, defined in decimal format.

CurrencyInfo_Min Decimal False

Minimum allowable value for a custom currency field, defined in decimal format.

CurrencyInfo_Precision Decimal False

Number of decimal places allowed for a custom currency field.

DecimalInfo_Max Decimal False

Maximum allowable value for a custom decimal field.

DecimalInfo_Min Decimal False

Minimum allowable value for a custom decimal field.

DecimalInfo_Precision Decimal False

Number of decimal places allowed for a custom decimal field.

Descriptor String False

A text summary or preview of the custom field type instance.

FieldType_Descriptor String False

A detailed description of the custom field type instance.

FieldType_Id String False

Unique identifier for the type of custom field.

Href String False

A hyperlink that provides direct access to the custom field type instance.

Inactive Bool False

Indicates whether the custom field type is inactive. If true, the field type should not be used.

IntegerInfo_Max Decimal False

Maximum allowable value for a custom integer field.

IntegerInfo_Min Decimal False

Minimum allowable value for a custom integer field.

ListInfo_Values_Aggregate String False

A list of all available custom list values, presented as an array. Each value is separated by a comma, followed by a space.

Name String False

The display name assigned to the custom field type.

ParagraphInfo_MaxLength Decimal False

Maximum number of characters allowed in a custom paragraph text field.

TextInfo_MaxLength Decimal False

Maximum number of characters allowed in a custom text field.

FieldType_Prompt String False

A prompt or label displayed to users when interacting with the custom field type.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434