OpenapiFramework
Returns one DocType definition — its fields, naming rule, permissions and…
Returns one DocType definition — its fields, naming rule, permissions and lifecycle flags.
GET /v1/framework/doctypes/{name}
| Address | https://api.hanzo.ai/v1/framework/doctypes/{name} |
| Method | GET |
| Operation | get_framework_doctypes_by_name |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one DocType definition — its fields, naming rule, permissions and lifecycle flags. Scoped to the caller's org, so another tenant's DocType of the same name is simply not found.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | yes | Name is the DocType's name, from the path. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | DocType | ok |
200 body — 28 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
autoname | body | string | — | |
createdAt | body | integer | — | |
fields | body | DocField[] | — | |
fields[].default | body | string | — | |
fields[].fetchFrom | body | string | — | |
fields[].fieldname | body | string | — | |
fields[].fieldtype | body | string | — | |
fields[].hidden | body | boolean | — | |
fields[].inListView | body | boolean | — | |
fields[].label | body | string | — | |
fields[].options | body | string | — | |
fields[].readOnly | body | boolean | — | |
fields[].reqd | body | boolean | — | |
fields[].unique | body | boolean | — | |
isSingle | body | boolean | — | |
isSubmittable | body | boolean | — | |
module | body | string | — | |
name | body | string | — | |
permissions | body | DocPerm[] | — | |
permissions[].cancel | body | boolean | — | |
permissions[].create | body | boolean | — | |
permissions[].delete | body | boolean | — | |
permissions[].read | body | boolean | — | |
permissions[].role | body | string | — | |
permissions[].submit | body | boolean | — | |
permissions[].write | body | boolean | — | |
titleField | body | string | — | |
updatedAt | body | integer | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo framework doctypes get <name>import { Configuration, FrameworkApi } from 'hanzoai';
const api = new FrameworkApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getFrameworkDoctypesByName({ name: 'name' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import FrameworkApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FrameworkApi(client).get_framework_doctypes_by_name(name='name')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.FrameworkAPI.GetFrameworkDoctypesByName(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, framework_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = framework_api::get_framework_doctypes_by_name(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FrameworkApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new FrameworkApi(client).getFrameworkDoctypesByName();curl https://api.hanzo.ai/v1/framework/doctypes/<name> \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches framework through the framework tool, which names its 17 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "get_framework_by_doctype"
}
}
}'How is this guide?