Open topic with navigation

# ListVehicleModels

Returns a list of vehicle models in a specified database. The action can also return information about the images and metadata associated with each vehicle model.

Type: synchronous

Parameter | Description | Required
--- | --- | ---
`database` | The name of the database that contains the vehicle models. | Yes
`identifier` | A comma-separated list of identifiers to specify the vehicle models to list. If you do not set this parameter, HPE Media Server lists all of the vehicle models in the specified database. | No
`imagestatus` | A Boolean value (default false) that specifies whether to return the label and training status of each image associated with each vehicle model. | No
`maxresults` | The maximum number of vehicle models to return. | No
`metadata` | A Boolean value (default false) that specifies whether to return the metadata associated with each vehicle model. | No
`start` | The starting point for the list when you set the `maxresults` parameter. For example, to start listing vehicle models from the tenth model in the database, set `start=10`. The entries in the database are indexed from 1. | No

## Example

The following example lists up to 10 vehicle models contained in the `Cars` database:

    /action=ListVehicleModels&database=Cars
                             &imagestatus=TRUE
                             &metadata=TRUE
                             &start=1
                             &maxresults=10

## Response

The response always includes the following information for each vehicle model:

- `identifier` - The identifier for the vehicle model.
- `numimages` - The number of training images associated with the vehicle model.
- `numtrained` - The number of images associated with the vehicle model that have been trained (the number that are used for recognition).
- `numfailed` - The number of images associated with the vehicle model where training failed.
- `numuntrained` - The number of images associated with the vehicle model that have not yet been trained.

If you set the action parameter `imagestatus` to `true`, HPE Media Server returns the status of each training image associated with each vehicle model.

- The `status` element indicates the status of training:

  - `trained` indicates that training was successful.
  - `untrained` indicates that training has not been attempted. Run training for the vehicle model using the action BuildVehicleModel, or run training for all vehicle models that have incomplete training using the action BuildAllVehicleModels.
  - `failed` indicates that HPE Media Server could not use the image for training. Remove the failed image using the action RemoveVehicleModelImages.
- The `hasimagedata` element indicates whether the training image is stored in the database. If the value of this element is `false`, the image has been removed from the database by the action NullVehicleModelImageData. Images that have been removed and have a status of `untrained` cannot be trained, so HPE recommends you remove these images with the action RemoveVehicleModelImages.

    <autnresponse>
      <action>LISTVEHICLEMODELS</action>
      <response>SUCCESS</response>
      <responsedata>
        <entry>
          <identifier>FordFocusRS</identifier>
          <numimages>3</numimages>
          <numtrained>1</numtrained>
          <numfailed>1</numfailed>
          <numuntrained>1</numuntrained>
          <vehiclemake>Ford</vehiclemake>
          <images>
            <image>
              <label>focus-rs-front</label>
              <status>trained</status>
              <hasimagedata>true</hasimagedata>
            </image>
            <image>
              <label>image2</label>
              <status>untrained</status>
              <hasimagedata>true</hasimagedata>
            </image>
            <image>
              <label>image3</label>
              <status>failed</status>
              <hasimagedata>true</hasimagedata>
            </image>
          </images>
          <metadata>
            <item>
              <key>type</key>
              <value>hatchback</value>
            </item>
          </metadata>
        </entry>
      </responsedata>
    </autnresponse>

© 2016 Hewlett Packard Enterprise Development LP | Send documentation feedback to HPE Close Send Documentation Feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to AutonomyTPFeedback@hpe.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_HP_HTML5_bannerTitle.htm