> For the complete documentation index, see [llms.txt](https://raic-labs.gitbook.io/raic-fed/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://raic-labs.gitbook.io/raic-fed/api-reference/04a-foundry-api/taxonomies.md).

# Taxonomies

## GET /taxonomies

> List Taxonomies

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies":{"get":{"tags":["taxonomies"],"summary":"List Taxonomies","operationId":"list_taxonomies_taxonomies_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"}}}}}}
```

## POST /taxonomies

> Create Taxonomy

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies":{"post":{"tags":["taxonomies"],"summary":"Create Taxonomy","operationId":"create_taxonomy_taxonomies_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTaxonomyRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CreateTaxonomyRequest":{"properties":{"name":{"type":"string","title":"Name"},"isReadonly":{"type":"boolean","title":"Isreadonly","default":false},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["name","metadata"],"title":"CreateTaxonomyRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /taxonomies/{taxonomy\_id}

> Get Taxonomy

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies/{taxonomy_id}":{"get":{"tags":["taxonomies"],"summary":"Get Taxonomy","operationId":"get_taxonomy_taxonomies__taxonomy_id__get","parameters":[{"name":"taxonomy_id","in":"path","required":true,"schema":{"type":"integer","title":"Taxonomy Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /taxonomies/{taxonomy\_id}/categories

> Create Taxonomy Category

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies/{taxonomy_id}/categories":{"post":{"tags":["taxonomies"],"summary":"Create Taxonomy Category","operationId":"create_taxonomy_category_taxonomies__taxonomy_id__categories_post","parameters":[{"name":"taxonomy_id","in":"path","required":true,"schema":{"type":"integer","title":"Taxonomy Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTaxonomyCategoryRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CreateTaxonomyCategoryRequest":{"properties":{"parentCategoryId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parentcategoryid"},"name":{"type":"string","title":"Name"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["parentCategoryId","name","metadata"],"title":"CreateTaxonomyCategoryRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## DELETE /taxonomies/{taxonomy\_id}/categories/{category\_id}

> Delete Taxonomy Category

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies/{taxonomy_id}/categories/{category_id}":{"delete":{"tags":["taxonomies"],"summary":"Delete Taxonomy Category","operationId":"delete_taxonomy_category_taxonomies__taxonomy_id__categories__category_id__delete","parameters":[{"name":"taxonomy_id","in":"path","required":true,"schema":{"type":"integer","title":"Taxonomy Id"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"integer","title":"Category Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## PATCH /taxonomies/{taxonomy\_id}/categories/{category\_id}

> Update Taxonomy Category

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies/{taxonomy_id}/categories/{category_id}":{"patch":{"tags":["taxonomies"],"summary":"Update Taxonomy Category","operationId":"update_taxonomy_category_taxonomies__taxonomy_id__categories__category_id__patch","parameters":[{"name":"taxonomy_id","in":"path","required":true,"schema":{"type":"integer","title":"Taxonomy Id"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"integer","title":"Category Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaxonomyCategoryRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"UpdateTaxonomyCategoryRequest":{"properties":{"parentCategoryId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parentcategoryid"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["parentCategoryId","name","metadata"],"title":"UpdateTaxonomyCategoryRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /taxonomies/{taxonomy\_id}/categories/{category\_id}/items

> List Taxonomy Category Items

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies/{taxonomy_id}/categories/{category_id}/items":{"get":{"tags":["taxonomies"],"summary":"List Taxonomy Category Items","operationId":"list_taxonomy_category_items_taxonomies__taxonomy_id__categories__category_id__items_get","parameters":[{"name":"taxonomy_id","in":"path","required":true,"schema":{"type":"integer","title":"Taxonomy Id"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"integer","title":"Category Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Page Size"}},{"name":"sort_by","in":"query","required":false,"schema":{"enum":["date-newest","date-oldest","scene-az","scene-za","size-largest","size-smallest"],"type":"string","default":"date-newest","title":"Sort By"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /taxonomies/{taxonomy\_id}/categories/{category\_id}/items

> Add Taxonomy Category Item

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies/{taxonomy_id}/categories/{category_id}/items":{"post":{"tags":["taxonomies"],"summary":"Add Taxonomy Category Item","operationId":"add_taxonomy_category_item_taxonomies__taxonomy_id__categories__category_id__items_post","parameters":[{"name":"taxonomy_id","in":"path","required":true,"schema":{"type":"integer","title":"Taxonomy Id"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"integer","title":"Category Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"title":"Metadetection Ids"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## DELETE /taxonomies/{taxonomy\_id}/categories/{category\_id}/items/{item\_id}

> Delete Taxonomy Category Item

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies/{taxonomy_id}/categories/{category_id}/items/{item_id}":{"delete":{"tags":["taxonomies"],"summary":"Delete Taxonomy Category Item","operationId":"delete_taxonomy_category_item_taxonomies__taxonomy_id__categories__category_id__items__item_id__delete","parameters":[{"name":"taxonomy_id","in":"path","required":true,"schema":{"type":"integer","title":"Taxonomy Id"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"integer","title":"Category Id"}},{"name":"item_id","in":"path","required":true,"schema":{"type":"integer","title":"Item Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## PATCH /taxonomies/{taxonomy\_id}/categories/{category\_id}/items/{item\_id}

> Update Taxonomy Category Item

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies/{taxonomy_id}/categories/{category_id}/items/{item_id}":{"patch":{"tags":["taxonomies"],"summary":"Update Taxonomy Category Item","operationId":"update_taxonomy_category_item_taxonomies__taxonomy_id__categories__category_id__items__item_id__patch","parameters":[{"name":"taxonomy_id","in":"path","required":true,"schema":{"type":"integer","title":"Taxonomy Id"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"integer","title":"Category Id"}},{"name":"item_id","in":"path","required":true,"schema":{"type":"integer","title":"Item Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaxonomyCategoryItemRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"UpdateTaxonomyCategoryItemRequest":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"isApproved":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isapproved"}},"type":"object","required":["id","isApproved"],"title":"UpdateTaxonomyCategoryItemRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## PATCH /taxonomies/{taxonomy\_id}/categories/{category\_id}/items/bulk/delete

> Bulk Delete Taxonomy Category Items

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies/{taxonomy_id}/categories/{category_id}/items/bulk/delete":{"patch":{"tags":["taxonomies"],"summary":"Bulk Delete Taxonomy Category Items","operationId":"bulk_delete_taxonomy_category_items_taxonomies__taxonomy_id__categories__category_id__items_bulk_delete_patch","parameters":[{"name":"taxonomy_id","in":"path","required":true,"schema":{"type":"integer","title":"Taxonomy Id"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"integer","title":"Category Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"},"title":"Item Ids"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## PATCH /taxonomies/{taxonomy\_id}/categories/{category\_id}/items/bulk/update

> Bulk Update Taxonomy Category Items

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies/{taxonomy_id}/categories/{category_id}/items/bulk/update":{"patch":{"tags":["taxonomies"],"summary":"Bulk Update Taxonomy Category Items","operationId":"bulk_update_taxonomy_category_items_taxonomies__taxonomy_id__categories__category_id__items_bulk_update_patch","parameters":[{"name":"taxonomy_id","in":"path","required":true,"schema":{"type":"integer","title":"Taxonomy Id"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"integer","title":"Category Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateTaxonomyCategoryItemRequest"},"title":"Request"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"UpdateTaxonomyCategoryItemRequest":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"isApproved":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isapproved"}},"type":"object","required":["id","isApproved"],"title":"UpdateTaxonomyCategoryItemRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## PATCH /taxonomies/{taxonomy\_id}/categories/{category\_id}/items/moveto/{target\_category\_id}

> Bulk Move Taxonomy Category Items

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies/{taxonomy_id}/categories/{category_id}/items/moveto/{target_category_id}":{"patch":{"tags":["taxonomies"],"summary":"Bulk Move Taxonomy Category Items","operationId":"bulk_move_taxonomy_category_items_taxonomies__taxonomy_id__categories__category_id__items_moveto__target_category_id__patch","parameters":[{"name":"taxonomy_id","in":"path","required":true,"schema":{"type":"integer","title":"Taxonomy Id"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"integer","title":"Category Id"}},{"name":"target_category_id","in":"path","required":true,"schema":{"type":"integer","title":"Target Category Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"},"title":"Item Ids"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Create Taxonomy Category Export

> Kick off a background task that builds a dataset export for the category items.

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies/{taxonomy_id}/categories/{category_id}/exports":{"post":{"tags":["taxonomies"],"summary":"Create Taxonomy Category Export","description":"Kick off a background task that builds a dataset export for the category items.","operationId":"create_taxonomy_category_export_taxonomies__taxonomy_id__categories__category_id__exports_post","parameters":[{"name":"taxonomy_id","in":"path","required":true,"schema":{"type":"integer","title":"Taxonomy Id"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"integer","title":"Category Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTaxonomyCategoryExportRequest"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxonomyCategoryExportResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CreateTaxonomyCategoryExportRequest":{"properties":{"exportType":{"type":"string","title":"Exporttype","default":"GeoJson"}},"type":"object","title":"CreateTaxonomyCategoryExportRequest"},"TaxonomyCategoryExportResponse":{"properties":{"exportId":{"type":"string","format":"uuid","title":"Exportid"},"taxonomyCategoryId":{"type":"integer","title":"Taxonomycategoryid"},"exportType":{"type":"string","title":"Exporttype"},"status":{"type":"string","title":"Status"},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Errormessage"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"updatedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedon"}},"type":"object","required":["exportId","taxonomyCategoryId","exportType","status","createdOn","updatedOn"],"title":"TaxonomyCategoryExportResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /taxonomies/{taxonomy\_id}/categories/{category\_id}/exports/{export\_id}

> Get Taxonomy Category Export

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies/{taxonomy_id}/categories/{category_id}/exports/{export_id}":{"get":{"tags":["taxonomies"],"summary":"Get Taxonomy Category Export","operationId":"get_taxonomy_category_export_taxonomies__taxonomy_id__categories__category_id__exports__export_id__get","parameters":[{"name":"taxonomy_id","in":"path","required":true,"schema":{"type":"integer","title":"Taxonomy Id"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"integer","title":"Category Id"}},{"name":"export_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Export Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxonomyCategoryExportResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"TaxonomyCategoryExportResponse":{"properties":{"exportId":{"type":"string","format":"uuid","title":"Exportid"},"taxonomyCategoryId":{"type":"integer","title":"Taxonomycategoryid"},"exportType":{"type":"string","title":"Exporttype"},"status":{"type":"string","title":"Status"},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Errormessage"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"updatedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedon"}},"type":"object","required":["exportId","taxonomyCategoryId","exportType","status","createdOn","updatedOn"],"title":"TaxonomyCategoryExportResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /taxonomies/{taxonomy\_id}/categories/{category\_id}/exports/{export\_id}/download

> Download Taxonomy Category Export

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/taxonomies/{taxonomy_id}/categories/{category_id}/exports/{export_id}/download":{"get":{"tags":["taxonomies"],"summary":"Download Taxonomy Category Export","operationId":"download_taxonomy_category_export_taxonomies__taxonomy_id__categories__category_id__exports__export_id__download_get","parameters":[{"name":"taxonomy_id","in":"path","required":true,"schema":{"type":"integer","title":"Taxonomy Id"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"integer","title":"Category Id"}},{"name":"export_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Export Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```
