Metadata Reference

GET {{base_url}}/metadata/{{configurationType-or-hubName}}

Metadata

Detailed description of the fields that return from the Vantagepoint metadata.

The APIs you use to get the metadata all have the form

{{base_url}}/metadata/<hub_name>/

{{base_url}}/metadata/<config_type>/

Metadata is an object representing and describing the data, logic, and visual presentation of what is available from an API method. The metadata structure will differ depending on the modules activated, settings, roles and permissions, and overall configuration.

For example, here is the call to retrieve the metadata that describes the available fields for a list:

GET {{base_url}}/metadata/codeTable/{{Codetable}}

where {{Codetable}} is the name of the list that you want to read.

JSON Response with metadata for the codetable you specify

General Metadata Fields

Attributes

Element	Description	Type
Top level	Object where the name is almost always the same name as the table name which is the attribute for the keys	Top level object

Table Attributes: Represents the table key/value pairs

Element	Description	Type
Keys	Array of objects whose attributes are described in the metadata fields	Array
CustomTable	If true, this table is a user-defined custom table; otherwise, this table is a system standard table. All custom tables have a TableName prefixed with “Cust.”	Boolean
TableName	Name of the table which generally matches the key value	String
GridID	Unique identifier of the table grid	String

Fields Array: Represents the field or attributes

Element	Description	Type
FieldName	Name of the field or attribute	String
FieldType	Type of data allowed in the field. Additional fields are associated with types to provide additional information. See the section below Valid values for FieldType for details.	String
Caption	Text label that shows on the UI	String
DefaultValue	If not provided, a blank value is assigned. Upon insert, the value can be replaced with a blank represented by " ".	String
Hidden	If true, the value is hidden from the user in the application based on roles and permissions; otherwise, the value is shown to all roles.	Boolean
Required	Whether creating or updating an object, if true, the call requires providing this value; otherwise, this field is optional.	Boolean
Updateable	If true, the role the call is authenticated with can update the field; otherwise, the field cannot be updated by the role.	Boolean
CustomField	If true, this field is a user-defined custom field; otherwise, this field is a system standard field. All fields that are custom fields have a FieldName prefixed with Cust.	Boolean
Decimals	When the field type is currency or numeric, this field defines how many decimal places are allowed to the right of the decimal point for the numeric columns.	Number
MinValue	When the field type is numeric, this value is the minimum threshold that the field will accept.	Number
CurrencyType	If the instance is multi-currency, this field identifies which currency type is used for the field. The value can be null. Example: The type can be specified as projectCurrency or record when CustomField is set to true.	String
Codetable	If the field type is a dropdown, this field is used to provide the codetable used to populate the dropdown. Valid values for the codetable are read via GET {{base_url}}/codeTable/{{codeTable}}.	String
Codes	If the field type is a dropdown, this field is used to provide the hard coded list of values.	Array
LimitToList	When the FieldType is a dropdown and the value is true, limit this field to that dropdown list.	Boolean
MaxLength	User defined length of the attribute	Number

Valid values for FieldType

This set of field types require values that conform to validation.

Account
Company
Contact
Employee
Equipment
Firm
LABCD
Mkt
Org
Role
TextLibrary
UDIC
Unit
UnitTable
Vendor
WBS1

These field types are entities that do not require validation: * Checkbox * Currency * Date * Datetime * Dropdown * Memo * Name * Numeric * Phone * ProjectPlan * RecordID * String * Uppercase * URL * WBS2 * WBS3 * XML

Project Hub Specific Metadata

Fields Array: Represents the field or attributes

Element	Type
RequireWBSLevel	String

Description

When the RequireWBSLevel field is available, it denotes whether or not this field is required and at which level. Use this field in conjunction with the Required field.

This field is unique to the Projects hub since there are three levels that are part of the work breakdown structure: tree structure with project (top level with a project key), phase, task.

The levels are dependent on how the system is set up from a work breakdown structure standpoint. For example, if there is only one level in the work breakdown structure, you have the project level which is also the lowest level.

If the project only has phases and no tasks, then the phases are the lowest level. If the project has two phases and one phase has a task, then the task for the phase is the lowest level, whereas the other phase without a task would be the lowest level.

Valid Values for RequireWBSLevel

A Required at all work breakdown structure levels
P Required only at the top level such as the project level
L Required at the lowest level or the leaf node

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string		Required.

The type of authorization supported by the API endpoint. |

RESPONSES

status: OK

&quot;{\r\n    \&quot;Contacts\&quot;: {\r\n        \&quot;Keys\&quot;: \&quot;ContactID\&quot;,\r\n        \&quot;CustomTable\&quot;: false,\r\n        \&quot;TableName\&quot;: \&quot;Contacts\&quot;,\r\n        \&quot;GridID\&quot;: null,\r\n        \&quot;Fields\&quot;: [\r\n            {\r\n                \&quot;FieldName\&quot;: \&quot;ContactID\&quot;,\r\n                \&quot;FieldType\&quot;: \&quot;String\&quot;,\r\n                \&quot;Caption\&quot;: \&quot;ContactID\&quot;,\r\n                \&quot;DefaultValue\&quot;: \&quot;[GUID]\&quot;,\r\n                \&quot;Hidden\&quot;: true,\r\n                \&quot;Required\&quot;: false,\r\n                \&quot;Updateable\&quot;: true,\r\n                \&quot;CustomField\&quot;: false,\r\n                \&quot;MaxLength\&quot;: 32\r\n            },\r\n            {\r\n                \&quot;FieldName\&quot;: \&quot;Salutation\&quot;,\r\n                \&quot;FieldType\&quot;: \&quot;Dropdown\&quot;,\r\n                \&quot;Caption\&quot;: \&quot;Prefix\&quot;,\r\n                \&quot;DefaultValue\&quot;: \&quot;\&quot;,\r\n                \&quot;Hidden\&quot;: true,\r\n                \&quot;Required\&quot;: false,\r\n                \&quot;Updateable\&quot;: true,\r\n                \&quot;CustomField\&quot;: false,\r\n                \&quot;MaxLength\&quot;: 10,\r\n                \&quot;CodeTable\&quot;: \&quot;CFGPrefix\&quot;,\r\n                \&quot;LimitToList\&quot;: true\r\n                ]\r\n    }&quot;