Search method

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

This method executes a search through the agent and returns the resulting file list as an XML document.

Note: The Preview Agent API is deprecated and will be set to End of Life on July 1st, 2024.

If you have integrations that display previews in real-time, we recommend looking into alternative solutions such as obtaining temporary preview links from the RESTful API.

URL

http://servername/ArchiveAgentPath/Search

Parameters

Search[1]

The string to search for.

PreviewSize[*] := [ 0 . . . 1024 ]

The maximum dimension in pixels for a preview. The URL for this preview will be returned.

FileInfo[1] := [ 0 | 1 ]

Boolean value indicating if file information should be returned with the file list.

MetaData[1] := [ 0 | 1 ]

Boolean value indicating if metadata should be returned with the file list.

Return value

An ‘Archive Agent File List XML’ document containing a list of files matching the search string and any requested
data:

<?xml version="1.0" ?>
<FileList
    Version="1.0"
    CreatorApplication="FotoWeb/6.0"
    Created="Mon, 06 Jun 2005 11:50:38 GMT"
    TotalHits="2"
    ReturnedHits="2"
    SearchTime="0.582941850472644"
    ProcessingTime="4.4580299341163">
<File Name="182492.jpg" Id="fileIdString">
  <PreviewLinks>
      <PreviewUrl Id="0" Size="200">previewUrl</PreviewUrl>
  </PreviewLinks>
  
  <FileInfo>
    <Path>D:\Media Library\Archive\Images\Alain Ernoult</Path>
    <Created>Tue, 30 Sep 2003 09:23:38 GMT</Created>
    <LastModified>Wed, 16 Mar 2005 12:59:15 GMT</LastModified>
    <FileSize>4203447</FileSize>
    <MimeType>image/jpeg</MimeType>
  </FileInfo>

  <MetaData>
    <PixelWidth>3565</PixelWidth>
    <PixelHeight>2371</PixelHeight>
    <Resolution>300.00</Resolution>
    <ColorSpace>Rgb</ColorSpace>

    <Text>
      <Field Id="IPTC2:0" Name="Iptc Field 0" />
      <Field Id="IPTC2:120" Name="Caption">AUTO VOITURE</Field>
    </Text>
  </MetaData>
</File>
</FileList>