User-Defined Hub Record Metadata
GET {{base_url}}/metadata/UDIC/:InfocenterArea
Use this endpoint to retrieve the User-Defined Hub record 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
{"UDIC_UserDefinedHub":{"Keys":"UDIC_UID","CustomTable":true,"TableName":"UDIC_UserDefinedHub","GridID":"X","Hidden":false,"Updateable":true,"Fields":[{"FieldName":"UDIC_UID","FieldType":"String","Caption":"UDIC_UID","DefaultValue":"[GUID]","Hidden":false,"Required":true,"Updateable":true,"MaxLength":32},{"FieldName":"CustomCurrencyCode","FieldType":"Dropdown","Caption":"Custom Currency Code","DefaultValue":"[FUNCTIONALCURRENCYCODE]","Hidden":false,"Required":false,"Updateable":true,"MaxLength":3,"CodeTable":"FW_CFGCurrency","LimitToList":true},{"FieldName":"desc_CustomCurrencyCode","FieldType":"String","Caption":"desc_CustomCurrencyCode","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"PhotoModDate","FieldType":"Datetime","Caption":"PhotoModDate","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"HasPhoto","FieldType":"Numeric","Caption":"HasPhoto","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"UDICNumber","FieldType":"String","Caption":"UDICNumber","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"UDICName","FieldType":"String","Caption":"UDICName","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"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":"CustName","FieldType":"Name","Caption":"Name","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":true},{"FieldName":"CustNumber","FieldType":"RecordID","Caption":"Number","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":true,"MaxLength":20}],"Caption":"User-Defined Hubs"}}