used-lists Collection

Description

The collection of project lists that are in use.

URL

/qcbin/rest/domains/{domain}/projects/{project}/customization/used-lists

Alternatively, you can use /qcbin/v2/rest/domains/{domain}/projects/{project}/customization/used-lists. For details, see used-lists/{list-id}.

Remarks

This resource returns all the lists in the project that are connected to a field or used in a business rule. To get only the lists that can be used with a given entity, see lists Related to Entity.

The parameters that can be applied to lists are name and id. For example:
/used-lists?name=Status,Run State
/used-lists?id=12,55

This resource is cached using an ETag. See the ALM help for details on enabling caching.

HTTP Methods

GET: Returns the project lists.

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 Lists Schema or a string containing the data in another supported format. See Schema Reference.

Examples

GET Customization In-use Lists Example