ValidateWorktags

Validates worktags.

Workday Resource Information

Validates the allowed and required worktag types and worktag combinations based on the configuration in the 'Maintain Related Worktag Usage' and 'Maintain Worktag Usage' tasks and related worktags. This endpoint enables you to correct errors before you submit transactions that include worktags.

This POST endpoint is a read-only POST that submits the request for validation. This endpoint doesn't add data to Workday.

In the request body, specify the required field: taggableConfiguration{ id }, where id uses the format Taggable_Type_ID={referenceID}. You can get the Reference ID of the taggable type from the View Taggable Types task. Example id: Taggable_Type_ID=EXPENSE_REPORT

You can optionally specify these fields in the request body:

* worktags [{id}] where id is the reference ID of the worktag. Example: Organization_Reference_ID=REGION-4-132

* validationTypes[{id}] where id uses the format Worktags_REST_Validation_Type_ID={referenceID}. You can get the Reference ID of the validation type from the Worktags REST Validation Types report. Example: Worktags_REST_Validation_Type_ID=INACTIVE_WORKTAG_TYPES

* restrictions[{id}] where id is the reference ID of the worktag type configured with 'Restricted To' values. Example: Company_Reference_ID=COMPANY-10-209

For details and examples, see Community > REST API Guides > Validate Worktags REST API.

Secured by: Manage: Related Worktags, Worktag REST API

Scope: Common Financial Management, Worktags

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.

InvalidRestrictionsForWorktags_Aggregate

[{
  invalidRestrictedToValues: [{
      descriptor: Text /* A preview of the instance */
      href: Text /* A link to the instance */
      id: Text /* Id of the instance */
  }]
  worktagWithRestrictedToValues: { /* For REST API responses only. Worktags that are configured with Restricted To values. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
}]

InvalidWorktagCombinations_Aggregate

[{
  invalidWorktagValues: [{
      descriptor: Text /* A preview of the instance */
      href: Text /* A link to the instance */
      id: Text /* Id of the instance */
  }]
  worktagWithAllowedValues: { /* For REST API responses only. Worktags that are configured with allowed values. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
}]

MissingRequiredWorktagTypesAfterDefaulting_Aggregate

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

MissingRequiredWorktagTypesForTaggableConfig_Aggregate

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

MissingRequiredWorktagTypesForWorktags_Aggregate

[{
  missingWorktagTypes: [{
      descriptor: Text /* A preview of the instance */
      href: Text /* A link to the instance */
      id: Text /* Id of the instance */
  }]
  worktagWithRequiredWorktags: { /* For REST API responses only. Worktags configured with required worktag types in their related worktags. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
}]

NonAllowedInactiveWorktagValues_Aggregate

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

NonAllowedWorktagTypesForTaggableConfig_Aggregate

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

Restrictions_Aggregate

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

ValidationTypes_Aggregate

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

Worktags_Aggregate

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

Input


Name	Type	Description
AllowBuiltInWorktags	String	When true, REST API requests can include values in the Worktags field that aren't configurable worktag types for the Taggable Type but are valid for validation purposes. Example: Supplier in Supplier Invoice.
InvalidRestrictionsForWorktags_Aggregate	String	A JSON aggregate. When returned in a REST API response, indicates invalid restrictions for a worktag configured with Restricted To values. Use the Worktag With Restricted To Values and Invalid Restricted To Values report fields to view the values.
InvalidWorktagCombinations_Aggregate	String	A JSON aggregate. When returned in a REST API response, indicates that at least one combination of worktag values aren't allowed with one another. Use the Worktag with Allowed Values and Invalid Worktag Values report fields to view the values.
MissingRequiredWorktagTypesAfterDefaulting_Aggregate	String	A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type configured as ‘Required’ for the Taggable Configuration is missing in the request and not added by default from related worktags. Use the Worktag With Required Worktags and Missing Required Worktag Types report fields to view the values.
MissingRequiredWorktagTypesForTaggableConfig_Aggregate	String	A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type configured as ‘Required’ for the Taggable Configuration is missing in the request.
MissingRequiredWorktagTypesForWorktags_Aggregate	String	A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type configured as required in related worktags is missing. Use the Worktag With Required Worktags and Missing Required Worktag Types report fields to view the values.
NonAllowedInactiveWorktagValues_Aggregate	String	A JSON aggregate. When returned in a REST API response, indicates that at least one inactive worktag was sent in the request that wasn't allowed by the Taggable Configuration.
NonAllowedWorktagTypesForTaggableConfig_Aggregate	String	A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type sent in the request isn't allowed by the Taggable Configuration.
OnlyOneProjectOrPhaseOrTaskAllowed	String	When returned in a REST API response, indicates that there is more than one worktag for a Project in the request. Only one worktag type of Project, Project Phase or Project Task is allowed.
Restrictions_Aggregate	String	A JSON aggregate. For REST API requests only. Values that are validated for worktag types configured with 'Restricted To' values. Example: Company for a cost center configured with Restricted To Companies.
Status	String	The status in the REST API response that indicates whether the worktags sent in the request have validation errors or not.
TaggableConfiguration_Id	String	wid / id / reference id
ValidationTypes_Aggregate	String	A JSON aggregate. For REST API requests only. The validation types to include in the response. If this request parameter is missing or empty, all validation types are included in the response.
Worktags_Aggregate	String	A JSON aggregate. The worktags sent in a REST API request to be validated based on the configuration in the 'Maintain Worktag Usage' and 'Maintain Related Worktag Usage' tasks. Validations consider required and allowed worktag types, allowed values, and whether inactive values are allowed.

Result Set Columns


Name	Type	Description
AllowBuiltInWorktags	String	When true, REST API requests can include values in the Worktags field that aren't configurable worktag types for the Taggable Type but are valid for validation purposes. Example: Supplier in Supplier Invoice.
InvalidRestrictionsForWorktags_Aggregate	String	A JSON aggregate. When returned in a REST API response, indicates invalid restrictions for a worktag configured with Restricted To values. Use the Worktag With Restricted To Values and Invalid Restricted To Values report fields to view the values.
InvalidWorktagCombinations_Aggregate	String	A JSON aggregate. When returned in a REST API response, indicates that at least one combination of worktag values aren't allowed with one another. Use the Worktag with Allowed Values and Invalid Worktag Values report fields to view the values.
MissingRequiredWorktagTypesAfterDefaulting_Aggregate	String	A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type configured as ‘Required’ for the Taggable Configuration is missing in the request and not added by default from related worktags. Use the Worktag With Required Worktags and Missing Required Worktag Types report fields to view the values.
MissingRequiredWorktagTypesForTaggableConfig_Aggregate	String	A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type configured as ‘Required’ for the Taggable Configuration is missing in the request.
MissingRequiredWorktagTypesForWorktags_Aggregate	String	A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type configured as required in related worktags is missing. Use the Worktag With Required Worktags and Missing Required Worktag Types report fields to view the values.
NonAllowedInactiveWorktagValues_Aggregate	String	A JSON aggregate. When returned in a REST API response, indicates that at least one inactive worktag was sent in the request that wasn't allowed by the Taggable Configuration.
NonAllowedWorktagTypesForTaggableConfig_Aggregate	String	A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type sent in the request isn't allowed by the Taggable Configuration.
OnlyOneProjectOrPhaseOrTaskAllowed	String	When returned in a REST API response, indicates that there is more than one worktag for a Project in the request. Only one worktag type of Project, Project Phase or Project Task is allowed.
Restrictions_Aggregate	String	A JSON aggregate. For REST API requests only. Values that are validated for worktag types configured with 'Restricted To' values. Example: Company for a cost center configured with Restricted To Companies.
Status	String	The status in the REST API response that indicates whether the worktags sent in the request have validation errors or not.
TaggableConfiguration_Descriptor	String	A description of the instance
TaggableConfiguration_Href	String	A link to the instance
TaggableConfiguration_Id	String	wid / id / reference id
ValidationTypes_Aggregate	String	A JSON aggregate. For REST API requests only. The validation types to include in the response. If this request parameter is missing or empty, all validation types are included in the response.
Worktags_Aggregate	String	A JSON aggregate. The worktags sent in a REST API request to be validated based on the configuration in the 'Maintain Worktag Usage' and 'Maintain Related Worktag Usage' tasks. Validations consider required and allowed worktag types, allowed values, and whether inactive values are allowed.

Cmdlets for Workday