fields Collection

Description

The collection of fields belonging to instances of the specified entity type.

URL

/qcbin/rest/domains/{domain}/projects/{project}/customization/entities/{entity name}/fields

Remarks

The filter parameters that can be applied to fields are required and can-filter. For example:

   /fields?required=true
/fields?can-filter=true

If a field is required, include it in the XML input when creating an entity.

If can-filter is true, the field can be used in a query when filtering a resource collection. The entity type name is in the singular. For example, test or requirement.

For downloading fields information together with other customization information, see Extended Mode in the entities Collection reference.

HTTP Methods

GET: Retrieves the collection of fields.

PUT: N/A

DELETE: N/A

POST: N/A

Media Type
GET
PUT
DELETE
POST
application/xml
check
-
-
-
application/json
check
-
-
-

Returns

One of the HTTP Return Codes.

An XML string compliant with the Fields Schema or a string containing the data in another supported format. See Schema Reference.

Examples

GET Test Fields Example