Taxonomy.import (Method)
Imports a taxonomy's file.
Returns:
TaxonomyImportStatus (struct)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
Facets | NonNegativeInteger | The number of facets imported. |
TaxonomyID | TaxonomyID | The ID of the taxonomy created. |
TermAnnotations | NonNegativeInteger | The number of imported annotation terms. |
TermRelationships | Any | The number of term relationships imported. |
Terms | NonNegativeInteger | The number of imported terms. |
TermsWithData | NonNegativeInteger | The number of terms imported with existing data. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
xmlFile | ModulePath_EmptyString | Optional. Defaults to an empty string. | The full path to the XML file being imported 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 imported or an empty string. You must enter a value to this argument of to the 'xmlFile' argument. |
taxonomyID | TaxonomyID_0 | Optional. Defaults to '0'. | A taxonomy's ID or 0. If this value is 0, CommonSpot creates a new taxonomy instead of updating an existing one. |
Context:
License Requirements | Taxonomy |
Permission Requirements | site:ManageTaxonomies |
Deny Context | None |
Require Context | AuthoringEnabled |
Author Lock | (not required) |
Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
Customization | Customization is not supported for this method. |
Error Codes:
Code | Error Message |
---|---|
58006 | You must specify either XMLFile or XMLURL. |
58007 | Validation failed: $1. |
Notes:
None