Taxonomy.validate (Method)
Returns a structure containing the results from CommonSpot validating an XML file or URL. Use this method before using the import() method. The elements of this structure are 'isValid' and 'Message'.
Returns:
TaxonomyValidationStatus (struct)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
isValid | Boolean | Boolean flag which when true indicates that the XML file is valid. |
Message | PlainText_2000 | A message describing the validation's status. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
xmlFile | ModulePath_EmptyString | Optional. Defaults to an empty string. | The full path to the XML file being validated or an empty string. You must enter a value for this argument or for the 'xmlURL' argument. |
xmlURL | FullyQualifiedURL_EmptyString | Optional. Defaults to an empty string. | The fully-qualified URL to the XML file being validated or an empty string. You must enter a value to this argument of to the 'xmlFile' argument. |
taxonomyID | TaxonomyID_0 | Required | The taxonomy's ID or 0. If this value is 0, CommonSpot creates a new taxonomy instead of validating an existing one. |
Context:
License Requirements | Taxonomy |
Permission Requirements | site:ManageTaxonomies |
Deny Context | None |
Require Context | AuthoringEnabled |
Author Lock | (not required) |
Transaction Logging | Transaction logging is disabled for this method |
Customization | Customization is not supported for this method. |
Error Codes:
Code | Error Message |
---|---|
58006 | You must specify either XMLFile or XMLURL. |
Notes:
None