Fields

The fields resource returns metadata about the data returned for a member of a collection.

URI

/qcbin/api/domains/DOMAIN_NAME/projects/PROJECT_NAME/{collection name}/$metadata/fields

General Data on the Field

Name	Comments
type	Generally the literal, "field", as in the attribute–value pair: "type":"field". In addition to this general type, the return data also contains a type object ( "type":{...} ). This object refers to the values. See below.
name	The logical name of the field. This is the name used by this API in all contexts.
label	The display label for the field.

Input Validation

The validations are in array: "input-validations":[...],

Name	Comments
Format	The Format value is the mask for the required format.
Not Null	This is a required field.
Maximum length	The maximum length is the value of the Maximum length object. For example: {"name": "Maximum length", "value": 1}
Reference Match	The field value is validated against a required format, or the value must refer to an existing item in the project. For example, a date value must be a valid date-string, an ID must reference an existing instance, or a string must be a member of a project list. See details of the Reference object under Data Type, below.

Output Validation

The validations are in array: "output-validations":[...],

Name	Comments
Sanitization	The value is either Text or HTML. See Sanitizing Output

Data type

The data types are in object: "type":{...}

Name	Comments
Date	The date format is ISO-8601.
Float	float
Integer	integer
Memo	A formatted ALM type.
Reference	A Reference is an identifier of a member of a collection. The referenced item can be a member of a list or a resource. Member of List "type": { "name": "Reference", "multiple": false "target": { "type": "list-items", "parent-id": 270 }, } Instance "type": { "name": "Reference", "multiple": false, "source": { "type": "releases" } }
Reference by Value	A Reference by Value is an identifier of a member of a collection. The value of this field matches the value of the referenced item. The referenced item can be a member of a list or a resource instance. Member of List "type": { "name": "Reference By Value", "multiple": false, "source": { "type": "list-item", "field": "name", "parent": { "type": "list-item", "id": 1 } } } Value of Another Instance "type": { "name": "Reference By Value", "multiple": false, "source": { "type": "defects", "field": "summary", } }
String	string