Hanzo
OpenapiFramework

Replaces a DocType definition wholesale (PUT semantics): the stored definition…

Replaces a DocType definition wholesale (PUT semantics): the stored definition becomes the body.

PUT /v1/framework/doctypes/{name}

Addresshttps://api.hanzo.ai/v1/framework/doctypes/{name}
MethodPUT
Operationput_framework_doctypes_by_name
AuthAuthorization: Bearer $HANZO_API_KEY

Replaces a DocType definition wholesale (PUT semantics): the stored definition becomes the body. The name in the URL is authoritative over the body's, and documents already stored under the DocType are left intact. Manager-only.

Request

29 fields, body application/json (required).

FieldInTypeRequiredDescription
namepathstringyes
autonamebodystring
createdAtbodyinteger
fieldsbodyDocField[]
fields[].defaultbodystring
fields[].fetchFrombodystring
fields[].fieldnamebodystring
fields[].fieldtypebodystring
fields[].hiddenbodyboolean
fields[].inListViewbodyboolean
fields[].labelbodystring
fields[].optionsbodystring
fields[].readOnlybodyboolean
fields[].reqdbodyboolean
fields[].uniquebodyboolean
isSinglebodyboolean
isSubmittablebodyboolean
modulebodystring
namebodystring
permissionsbodyDocPerm[]
permissions[].cancelbodyboolean
permissions[].createbodyboolean
permissions[].deletebodyboolean
permissions[].readbodyboolean
permissions[].rolebodystring
permissions[].submitbodyboolean
permissions[].writebodyboolean
titleFieldbodystring
updatedAtbodyinteger

Response

StatusBodyMeaning
200DocTypeok

200 body — 28 fields.

FieldInTypeAlwaysDescription
autonamebodystring
createdAtbodyinteger
fieldsbodyDocField[]
fields[].defaultbodystring
fields[].fetchFrombodystring
fields[].fieldnamebodystring
fields[].fieldtypebodystring
fields[].hiddenbodyboolean
fields[].inListViewbodyboolean
fields[].labelbodystring
fields[].optionsbodystring
fields[].readOnlybodyboolean
fields[].reqdbodyboolean
fields[].uniquebodyboolean
isSinglebodyboolean
isSubmittablebodyboolean
modulebodystring
namebodystring
permissionsbodyDocPerm[]
permissions[].cancelbodyboolean
permissions[].createbodyboolean
permissions[].deletebodyboolean
permissions[].readbodyboolean
permissions[].rolebodystring
permissions[].submitbodyboolean
permissions[].writebodyboolean
titleFieldbodystring
updatedAtbodyinteger

Failure carries the platform error shape — see Errors.

Examples

hanzo framework doctypes set <name>

Framework API · All Hanzo APIs · Interactive reference

How is this guide?

On this page