ListObjects

Returns a list of objects in a specified database. The action can also return information about the images, training options, and metadata associated with each object.

Type: synchronous

Parameter Description Required
database The name of the database that contains the objects. Yes
identifier A comma-separated list of identifiers to specify the objects to list. If you do not set this parameter, Media Server lists all of the objects 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 object. No
maxresults The maximum number of objects to return. No
metadata A Boolean value (default false) that specifies whether to return the metadata associated with each object. No
start The starting point for the list when you set the maxresults parameter. For example, to start listing objects from the tenth object in the database, set start=10. The entries in the database are indexed from 1. No
trainingoptions A Boolean value (default false) that specifies whether to return the training options set for each object. No

Example

The following example lists up to 10 objects contained in the CompanyLogos database:

/action=ListObjects&database=CompanyLogos
                   &imagestatus=TRUE
                   &metadata=TRUE
                   &trainingoptions=TRUE
                   &start=1
                   &maxresults=10

Response

The response always includes the following information for each object:

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

<autnresponse>
  <action>LISTOBJECTS</action>
  <response>SUCCESS</response>
  <responsedata>
    <entry>
      <identifier>HP</identifier>
      <numimages>3</numimages>
      <numtrained>1</numtrained>
      <numfailed>1</numfailed>
      <numuntrained>1</numuntrained>
      <images>
        <image>
          <label>image1</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>     
      <trainingoptions>
        <trainingoption>
          <key>usecolor</key>
          <value>false</value>
        </trainingoption>
      </trainingoptions>
      <metadata>
        <item>
          <key>CompanyName</key>
          <value>Hewlett Packard</value>
        </item>
      </metadata>
    </entry>
  </responsedata>
</autnresponse>

_HP_HTML5_bannerTitle.htm