Hanzo
OpenapiFramework

Defines a DocType in the caller's org: the metadata that gives a document…

Defines a DocType in the caller's org: the metadata that gives a document surface its fields, its naming rule, whether it has a submit/cancel lifecycle,…

POST /v1/framework/doctypes

Addresshttps://api.hanzo.ai/v1/framework/doctypes
MethodPOST
Operationpost_framework_doctypes
AuthAuthorization: Bearer $HANZO_API_KEY

Defines a DocType in the caller's org: the metadata that gives a document surface its fields, its naming rule, whether it has a submit/cancel lifecycle, and which role may do what to it. Manager-only — on a fresh org the first caller to administer it is seeded as its System Manager, after which only a System Manager (or a platform admin) may define. Answers 201.

Request

28 fields, body application/json (required).

FieldInTypeRequiredDescription
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
201DocTypecreated

201 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 create

Framework API · All Hanzo APIs · Interactive reference

How is this guide?

On this page