Taxonomy Metadata
- 1 Minute to read
Taxonomy Metadata
- 1 Minute to read
Article summary
Did you find this summary helpful?
Thank you for your feedback!
The Taxonomy resource defines an extension over the Base DataX Metadata structure.
JSON Structure
{
>>(Base DataX Metadata)<<
"extensions" : { "action" :
{string}, "incrementalData" :
{
"taxonomyId": {string}
},
"links" : [{
"rel" : "https://datax.yahooapis.com/rels/fullTaxonomy", "title" : "Full
Taxonomy post processing",
"href": {string}
]
}
}Fields above are generated and returned by DataX.
JSON Property Descriptions
The table below lists Taxonomy specific Metadata value descriptions:
Property Name | Type | Description |
|---|---|---|
resourceType (Base DataX Metadata) | String | [output-only] Always set to ‘datax-taxonomy’. |
status.state (Base DataX Metadata) | String | [output-only] Current state of the Taxonomy within DataX, which may be one of these: -Processing: Taxonomy is being processed post submission. -Error: Processing of Taxonomy failed due to errors. Refer to “status.error” for more details. -Accepted: Taxonomy was processed successfully. All future data uploads will be executed with reference to this version of the Taxonomy. Note: there is no explicit action required to Activate a taxonomy. A new taxonomy automatically supersedes the previous version once it is successfully processed. please use GET /taxonomy to fetch the currently active taxonomy. |
extensions.action | String | Represents the Taxonomy Action for one of the following:
|
extensions.incrementalData | String | Available for incremental Taxonomy requests. This represents the primary taxonomy node id on which the incremental request is sent. |
extensions.incrementalData.additionalTaxonomyIds | Array | Available for incremental Taxonomy requests. This contains any additional taxonomy node Ids that are included in the request, such as the destination node id for MOVE. |
extensions.links | Array | Useful link extensions. These links are useful to get the response extended data links useful for triaging and auditing purpose. Currently defines the following relation types. 1. https://datax.yahooapis.com/rels/fullTaxonomy - Available for incremental taxonomy requests to get full taxonomy post processing. |
Was this article helpful?
