144 lines
4.6 KiB
Markdown
144 lines
4.6 KiB
Markdown
---
|
|
name: metadata-templates-routes
|
|
description: Handle 13 OpenAPI operation(s) under /metadata_templates for the metadata templates route group.
|
|
---
|
|
|
|
# metadata templates API Routes
|
|
|
|
Handle 13 OpenAPI operation(s) under /metadata_templates for the metadata templates route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### get_metadata_templates
|
|
|
|
- Operation ID: `get_metadata_templates`
|
|
- Route: `GET /metadata_templates`
|
|
- Mode: READ
|
|
- Summary: Find metadata template by instance ID
|
|
- Parameters:
|
|
- `metadata_instance_id` in `query` required
|
|
- `marker` in `query`
|
|
- `limit` in `query`
|
|
|
|
### get_metadata_templates_enterprise_security_classification_6_vm_vochw_u_wo_schema
|
|
|
|
- Operation ID: `get_metadata_templates_enterprise_security_classification_6_vm_vochw_u_wo_schema`
|
|
- Route: `GET /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema`
|
|
- Mode: READ
|
|
- Summary: List all classifications
|
|
|
|
### put_metadata_templates_enterprise_security_classification_6_vm_vochw_u_wo_schema
|
|
|
|
- Operation ID: `put_metadata_templates_enterprise_security_classification_6_vm_vochw_u_wo_schema`
|
|
- Route: `PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add`
|
|
- Mode: WRITE
|
|
- Summary: Add classification
|
|
- Body: JSON request body accepted.
|
|
|
|
### put_metadata_templates_enterprise_security_classification_6_vm_vochw_u_wo_sche_2
|
|
|
|
- Operation ID: `put_metadata_templates_enterprise_security_classification_6_vm_vochw_u_wo_sche_2`
|
|
- Route: `PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update`
|
|
- Mode: WRITE
|
|
- Summary: Update classification
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_metadata_templates_id_id_schema
|
|
|
|
- Operation ID: `get_metadata_templates_id_id_schema`
|
|
- Route: `GET /metadata_templates/{scope}/{template_key}/schema`
|
|
- Mode: READ
|
|
- Summary: Get metadata template by name
|
|
- Parameters:
|
|
- `scope` in `path` required
|
|
- `template_key` in `path` required
|
|
|
|
### put_metadata_templates_id_id_schema
|
|
|
|
- Operation ID: `put_metadata_templates_id_id_schema`
|
|
- Route: `PUT /metadata_templates/{scope}/{template_key}/schema`
|
|
- Mode: WRITE
|
|
- Summary: Update metadata template
|
|
- Parameters:
|
|
- `scope` in `path` required
|
|
- `template_key` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_metadata_templates_id_id_schema
|
|
|
|
- Operation ID: `delete_metadata_templates_id_id_schema`
|
|
- Route: `DELETE /metadata_templates/{scope}/{template_key}/schema`
|
|
- Mode: WRITE
|
|
- Summary: Remove metadata template
|
|
- Parameters:
|
|
- `scope` in `path` required
|
|
- `template_key` in `path` required
|
|
|
|
### get_metadata_templates_id
|
|
|
|
- Operation ID: `get_metadata_templates_id`
|
|
- Route: `GET /metadata_templates/{template_id}`
|
|
- Mode: READ
|
|
- Summary: Get metadata template by ID
|
|
- Parameters:
|
|
- `template_id` in `path` required
|
|
|
|
### get_metadata_templates_global
|
|
|
|
- Operation ID: `get_metadata_templates_global`
|
|
- Route: `GET /metadata_templates/global`
|
|
- Mode: READ
|
|
- Summary: List all global metadata templates
|
|
- Parameters:
|
|
- `marker` in `query`
|
|
- `limit` in `query`
|
|
|
|
### get_metadata_templates_enterprise
|
|
|
|
- Operation ID: `get_metadata_templates_enterprise`
|
|
- Route: `GET /metadata_templates/enterprise`
|
|
- Mode: READ
|
|
- Summary: List all metadata templates for enterprise
|
|
- Parameters:
|
|
- `marker` in `query`
|
|
- `limit` in `query`
|
|
|
|
### post_metadata_templates_schema
|
|
|
|
- Operation ID: `post_metadata_templates_schema`
|
|
- Route: `POST /metadata_templates/schema`
|
|
- Mode: WRITE
|
|
- Summary: Create metadata template
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_metadata_templates_schema_classifications
|
|
|
|
- Operation ID: `post_metadata_templates_schema_classifications`
|
|
- Route: `POST /metadata_templates/schema#classifications`
|
|
- Mode: WRITE
|
|
- Summary: Add initial classifications
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_metadata_templates_id_id_fields_id_options
|
|
|
|
- Operation ID: `get_metadata_templates_id_id_fields_id_options`
|
|
- Route: `GET /metadata_templates/{namespace}/{template_key}/fields/{field_key}/options`
|
|
- Mode: READ
|
|
- Summary: List metadata template's options for taxonomy field
|
|
- Parameters:
|
|
- `namespace` in `path` required
|
|
- `template_key` in `path` required
|
|
- `field_key` in `path` required
|
|
- `level` in `query`
|
|
- `parent` in `query`
|
|
- `ancestor` in `query`
|
|
- `query` in `query`
|
|
- `include-total-result-count` in `query`
|
|
- `only-selectable-options` in `query`
|
|
- `marker` in `query`
|
|
- `limit` in `query`
|