Taxonomies

Duplicate

Create a copy of a taxonomy owned by the caller.

The copy gets a fresh taxonomy_id, regenerated graph node/edge ids, the caller as owner, and reset run history/stats. kind, description, tag membership, sharing/permissions and project associations are inherited from the source.

Request Body

Field	Type	Description
`source_taxonomy_id`	`str`	Taxonomy being copied (keyed by id).
`new_taxonomy_name`	`str`	Name for the copy.

Response

200: Returns the new DeasyTaxonomy.
400: Empty new_taxonomy_name.
403: Caller is not the owner of the source.
404: Source taxonomy not found or not accessible.
409: new_taxonomy_name collides with an existing taxonomy.

POST

taxonomy

duplicate

Python

# pip install deasy-sdk
import os
from deasy import DeasyClient

client = DeasyClient(
    base_url=os.environ["UNSTRUCTURED_CLIENT_BASE_URL"],
    username=os.environ["UNSTRUCTURED_USERNAME"],
    password=os.environ["UNSTRUCTURED_PASSWORD"],
    auth_method="basic",
)

response = client.taxonomy.duplicate(
    new_taxonomy_name="example_new_taxonomy_name",
    source_taxonomy_id="example_source_taxonomy_id",
)
print(response.taxonomy_id)

{
  "taxonomy_id": "<string>",
  "taxonomy_name": "<string>",
  "taxonomy_description": "<string>",
  "taxonomy_data": {
    "nodes": [
      {
        "name": "<string>",
        "node_id": "<string>",
        "node_type": "tag",
        "description": "<string>",
        "active_values": [
          "<string>"
        ]
      }
    ],
    "edges": [
      {
        "target_node_ids": [
          "<string>"
        ],
        "conditions": [
          {
            "node_id": "<string>",
            "tag_value_name": "<string>"
          }
        ],
        "edge_id": "<string>"
      }
    ],
    "root_node_id": "root"
  },
  "created_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "refreshed_at": "2023-11-07T05:31:56Z",
  "kind": "<string>",
  "retention_schedule_version": "<string>",
  "schedule_up_to_date": true,
  "is_owner": true,
  "owner_name": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

source_taxonomy_id

string

required

new_taxonomy_name

string

required

Response

Successful Response

taxonomy_id

string

required

taxonomy_name

string

required

taxonomy_description

string

required

taxonomy_data

TaxonomyGraph · object

required

A node/edge style graph representation of a taxonomy.

Example (simple case - single condition per edge): graph = TaxonomyGraph( nodes=[ TaxonomyNode(node_id="1", name="Document Type", active_values=["Contract", "Invoice"]), TaxonomyNode(node_id="2", name="Contract Type", active_values=["NDA", "Employment"]), ], edges=[ TaxonomyEdge( target_node_ids=["1"], conditions=[EdgeCondition(node_id="root", tag_value_name="Contract")], ), TaxonomyEdge( target_node_ids=["2"], conditions=[EdgeCondition(node_id="1", tag_value_name="NDA")], ), ] )

Example (AND case - multiple conditions): # Edge only followed when Document Type = Contract AND Region = US TaxonomyEdge( target_node_ids=["us_contract_node"], conditions=[ EdgeCondition(node_id="doc_type_node", tag_value_name="Contract"), EdgeCondition(node_id="region_node", tag_value_name="US"), ], )

Show child attributes

created_by

string | null

created_at

string<date-time> | null

updated_at

string<date-time> | null

refreshed_at

string<date-time> | null

kind

string | null

retention_schedule_version

string | null

schedule_up_to_date

boolean | null

is_owner

boolean | null

owner_name

string | null

⌘I

Python

# pip install deasy-sdk
import os
from deasy import DeasyClient

client = DeasyClient(
    base_url=os.environ["UNSTRUCTURED_CLIENT_BASE_URL"],
    username=os.environ["UNSTRUCTURED_USERNAME"],
    password=os.environ["UNSTRUCTURED_PASSWORD"],
    auth_method="basic",
)

response = client.taxonomy.duplicate(
    new_taxonomy_name="example_new_taxonomy_name",
    source_taxonomy_id="example_source_taxonomy_id",
)
print(response.taxonomy_id)

{
  "taxonomy_id": "<string>",
  "taxonomy_name": "<string>",
  "taxonomy_description": "<string>",
  "taxonomy_data": {
    "nodes": [
      {
        "name": "<string>",
        "node_id": "<string>",
        "node_type": "tag",
        "description": "<string>",
        "active_values": [
          "<string>"
        ]
      }
    ],
    "edges": [
      {
        "target_node_ids": [
          "<string>"
        ],
        "conditions": [
          {
            "node_id": "<string>",
            "tag_value_name": "<string>"
          }
        ],
        "edge_id": "<string>"
      }
    ],
    "root_node_id": "root"
  },
  "created_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "refreshed_at": "2023-11-07T05:31:56Z",
  "kind": "<string>",
  "retention_schedule_version": "<string>",
  "schedule_up_to_date": true,
  "is_owner": true,
  "owner_name": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Overview

Data Connectors

Tags

Taxonomies

Metadata

Data Slices

Deduplication

Destinations

Projects

Workflows

Versioning

Task Tracking

Duplicate

Request Body

Response

Authorizations

Body

Response