Get a project list and CRUD project list items

Available for: 24.1 and later versions

You can use the following REST API to get project lists in use and customize project list items:

OperationMethod and URL

Get project lists in use

GET

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

Alternatively, you can use used-lists Collection.

Get details of a project list

GET

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

Add an item to a project list

POST

/qcbin/v2/rest/domains/{domain}/projects/{project}/customization/used-lists/{list-id}/items

Rename an item of a project list

PUT

/qcbin/v2/rest/domains/{domain}/projects/{project}/customization/used-lists/{list-id}/items/{item-id}

Add a sub-item to an item of a project list

POST

/qcbin/v2/rest/domains/{domain}/projects/{project}/customization/used-lists/{list-id}/items/{item-id}

Delete an item of a project list

DELETE

/qcbin/v2/rest/domains/{domain}/projects/{project}/customization/used-lists/{list-id}/items/{item-id}

For specifications and samples about the REST API above, see the Swagger-powered help embedded in the product.

To access the help:

  1. Open the following link: http://<server>:<port number>/qcbin/api-doc/v2/.

    Alternatively, from the qcbin page (http://<server>:<port number>/qcbin/), click the Tools link. At the bottom of the Tools page, click the Project REST API Reference link.

  2. From the side menu, expand the UsedList section.