lists Related to Entity

Description

The collection of lists connected to fields of the specified entity type.

URL

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

Remarks

The collection contains lists used to populate values of fields of the specified entity type.

The entity type name is in the singular. For example, test or requirement.

To get all the used lists in the project, use the used-lists Collection

HTTP Methods

GET: Returns the project lists related to the entity.

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.

Examples

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--
GET: /qcbin/rest/domains/DOMAIN_NAME/projects/PROJECT_NAME/customization/entities/defect/lists
Accept: application/xml
 -->

<Lists>
    <List>
        <Name>Operating System (Environment)</Name>
        <Id>183</Id>
        <LogicalName>hp.qc.operating-system-environment</LogicalName>
        <Items>
            <Item value="Apple Mac OS" logicalName="hp.qc.operating-system-mac-os"/>
            <Item value="Linux" logicalName="hp.qc.operating-system-linux"/>
            <Item value="Microsoft Windows" logicalName="hp.qc.operating-system-windows"/>
        </Items>
    </List>
    …
</Lists>

JSON example

GET /qcbin/rest/domains/DOMAIN_NAME/projects/PROJECT_NAME/customization/entities/defect/lists
Accept: application/json

{
    "lists": [
        {
            "Name": "Operating System (Environment)",
            "Id": 183,
            "LogicalName": "hp.qc.operating-system-environment",
            "Items": [
                {
                    "logicalName": "hp.qc.operating-system-mac-os",
                    "value": "Apple Mac OS"
                },
                {
                    "logicalName": "hp.qc.operating-system-linux",
                    "value": "Linux"
                },
                {
                    "logicalName": "hp.qc.operating-system-windows",
                    "value": "Microsoft Windows"
                }
            ]
        }
        …
      ]
}