Boilerplate Metadata
GET {{base_url}}/metadata/boilerplate
Use this endpoint to retrieve the Boilerplate metadata.
The metadata describes the fields in each table of the database for the record and describes whether or not the table is a custom table and whether or not it has a grid ID. Each field describes whether or not the field is required, the data type, the default value, whether or not it is updateable, and other useful minimums, limits, and maximum details.
For more information, see Metadata Reference.
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | Required. |
The type of content supported by the API endpoint. |
| Authorization | string | | Required.
The type of authorization supported by the API endpoint. |
RESPONSES
status: OK
{"TextLibrary":{"Keys":"Name","TableName":"TextLibrary","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Name","FieldType":"String","Caption":"Name","DefaultValue":"[GUID]","Hidden":false,"Required":false,"Updateable":true,"MaxLength":32},{"FieldName":"DisplayName","FieldType":"String","Caption":"DisplayName","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":100},{"FieldName":"Description","FieldType":"String","Caption":"Description","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":255},{"FieldName":"Document","FieldType":"String","Caption":"Text","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"CustomCurrencyCode","FieldType":"Dropdown","Caption":"Custom Currency Code","DefaultValue":"[FUNCTIONALCURRENCYCODE]","Hidden":false,"Required":false,"Updateable":true,"MaxLength":3,"CodeTable":"FW_CFGCurrency","LimitToList":true},{"FieldName":"CreateUser","FieldType":"User","Caption":"Created by","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"MaxLength":32},{"FieldName":"ModUser","FieldType":"User","Caption":"Modified by","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"MaxLength":32},{"FieldName":"CreateUserName","FieldType":"User","Caption":"CreateUserName","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"MaxLength":32},{"FieldName":"ModUserName","FieldType":"User","Caption":"ModUserName","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"MaxLength":32},{"FieldName":"CreateDate","FieldType":"Datetime","Caption":"Create date","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"ModDate","FieldType":"Datetime","Caption":"Modify date","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"desc_CustBoilerplate","FieldType":"String","Caption":"Boilerplate Description","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":true},{"FieldName":"CustBoilerplate","FieldType":"TextLibrary","Caption":"Boilerplate","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":true,"MaxLength":50},{"FieldName":"desc_CustUDIC_testhub","FieldType":"String","Caption":"UDIC_testhub Description","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":true},{"FieldName":"CustUDIC_testhub","FieldType":"UDIC","Caption":"UDIC_testhub","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":true,"UDICType":"UDIC_testhub"},{"FieldName":"desc_CustUDIC_TestBP","FieldType":"String","Caption":"UDIC_TestBP Description","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":true},{"FieldName":"CustUDIC_TestBP","FieldType":"UDIC","Caption":"UDIC_TestBP","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":true,"UDICType":"UDIC_TestBP"},{"FieldName":"CustName","FieldType":"String","Caption":"Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":true,"MaxLength":255},{"FieldName":"desc_CustProject","FieldType":"String","Caption":"Project Description","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":true},{"FieldName":"CustProject","FieldType":"WBS1","Caption":"Project","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":true,"MaxLength":10},{"FieldName":"desc_CustResponsibleContact","FieldType":"String","Caption":"Responsible Contact Description","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":true},{"FieldName":"CustResponsibleContact","FieldType":"Employee","Caption":"Responsible Contact","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":true,"MaxLength":5},{"FieldName":"CustNote","FieldType":"String","Caption":"Note","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":true,"MaxLength":255},{"FieldName":"desc_CustResponsible","FieldType":"String","Caption":"Responsible Description","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"CustomField":true},{"FieldName":"CustResponsible","FieldType":"Employee","Caption":"Responsible","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":true,"MaxLength":5},{"FieldName":"CustFollowup","FieldType":"Checkbox","Caption":"Follow up","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true,"CustomField":true},{"FieldName":"CustomTest","FieldType":"Currency","Caption":"Test","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true,"CustomField":true}],"Caption":"TextLibrary","CustomTableName":"TextLibraryCustomTabFields"},"TextLibFileLinks":{"Keys":"LinkID,Name","TableName":"TextLibFileLinks","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"LinkID","FieldType":"String","Caption":"LinkID","DefaultValue":"[GUID]","Hidden":false,"Required":false,"Updateable":true,"MaxLength":32},{"FieldName":"Name","FieldType":"String","Caption":"Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Description","FieldType":"String","Caption":"Description","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":100},{"FieldName":"FilePath","FieldType":"String","Caption":"File Path","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":255},{"FieldName":"Graphic","FieldType":"Checkbox","Caption":"Graphic","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true,"MaxLength":1},{"FieldName":"CreateUser","FieldType":"User","Caption":"Created by","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"MaxLength":32},{"FieldName":"ModUser","FieldType":"User","Caption":"Modified by","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"MaxLength":32},{"FieldName":"CreateDate","FieldType":"Datetime","Caption":"Create date","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"ModDate","FieldType":"Datetime","Caption":"Modify date","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false}],"Caption":"Links"},"FW_ATTACHMENTS":{"Keys":"PKey,FileID","TableName":"FW_ATTACHMENTS","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"PKey","FieldType":"String","Caption":"PKey","DefaultValue":"[GUID]","Hidden":false,"Required":false,"Updateable":true,"MaxLength":32},{"FieldName":"FileID","FieldType":"String","Caption":"FileID","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":36},{"FieldName":"Key1","FieldType":"String","Caption":"Key1","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":32},{"FieldName":"Key2","FieldType":"String","Caption":"Key2","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":32},{"FieldName":"Key3","FieldType":"String","Caption":"Key3","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":32},{"FieldName":"Name","FieldType":"String","Caption":"Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"MaxLength":32},{"FieldName":"CategoryCode","FieldType":"Dropdown","Caption":"Category","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":15,"CodeTable":"FW_CFGAttachmentCategory","LimitToList":true},{"FieldName":"CategoryDescription","FieldType":"String","Caption":"Category Description","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"MaxLength":255},{"FieldName":"FileName","FieldType":"String","Caption":"File Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"MaxLength":250},{"FieldName":"FileDescription","FieldType":"String","Caption":"Description","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":500},{"FieldName":"FileSize","FieldType":"Numeric","Caption":"File Size","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false,"MaxLength":1},{"FieldName":"Application","FieldType":"String","Caption":"Application","DefaultValue":"TextLibrary","Hidden":false,"Required":false,"Updateable":true,"MaxLength":250},{"FieldName":"ContentType","FieldType":"String","Caption":"Content Type","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"MaxLength":200},{"FieldName":"CreateUser","FieldType":"User","Caption":"Created by","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"MaxLength":32},{"FieldName":"ModUser","FieldType":"User","Caption":"Modified by","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false,"MaxLength":32},{"FieldName":"CreateDate","FieldType":"Datetime","Caption":"Create date","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"ModDate","FieldType":"Datetime","Caption":"Modify date","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false}],"Caption":"Files"}}