Media Server 25.3
Media Server Help

# ListImageComparisonReferences

Returns a list of references in a specified database. The action can also return information about the image and metadata associated with each reference.

Type: synchronous

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

## Example

The following example lists up to 10 references contained in the `ReferenceImages` database:

    /action=ListImageComparisonReferences&database=ReferenceImages
                                         &imagestatus=TRUE
                                         &metadata=TRUE
                                         &start=1
                                         &maxresults=10

## Response

The response always includes the following information for each reference:

- `identifier` - The identifier of the reference.
- `numimages` - The number of training images associated with the reference.
- `numtrained` - The number of images associated with the reference that have been trained (the number that are used for image comparison).
- `numfailed` - The number of images associated with the reference where training failed.

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

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

  - `trained` indicates that training was successful.
  - `failed` indicates that Media Server could not use the image for training.

    <autnresponse>
      <action>LISTIMAGECOMPARISONREFERENCES</action>
      <response>SUCCESS</response>
      <responsedata>
        <entry>
          <identifier>6d8e53fd92e601a4b8948e1b9397e381</identifier>
          <numimages>1</numimages>
          <numtrained>1</numtrained>
          <numfailed>0</numfailed>
          <numuntrained>0</numuntrained>
          <images>
            <image>
              <label>image1</label>
              <status>trained</status>
              <hasimagedata>true</hasimagedata>
            </image>
          </images>
          <metadata>
            <item>
              <key>PartNumber</key>
              <value>8572087</value>
            </item>
          </metadata>
        </entry>
      </responsedata>
    </autnresponse>

Copyright 2025 Open Text
Version 25.3 | Last updated July 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Media Server 25.3

Topic Title: ListImageComparisonReferences