XML Command Listing

This section lists:

• the XML commands supported by eVe

• the output produced by those commands in both XML and pipe-delimited strings format

addMetaData

XML Input Syntax

<EveCommand>

<command>addMetadata</command>

<arg1>metadata key</arg1>

<arg2>metadata value</arg2>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok"

or

"error|error message"

analyze

XML Input Syntax

<EveCommand>

<command>analyze</command>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok"

or

"error|error message"

binaryImage

XML Input Syntax

<EveCommand>

<command>binaryImage</command>

<arg1>foreign key value</arg1>

<shortResponse>true</shortResponse>

</EveCommand>

Note: This command triggers two reads by the server - the first to read the XML command itself, followed by a second binary read of the client to get the image.

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok"

closeDatabase

XML Input Syntax

<EveCommand>

<command>closeDatabase</command>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok"

or

"error|error message"

createDatabase

XML Input Syntax

<EveCommand>

<command>createDatabase</command>

<arg1>name of database</arg1>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok"

or

"error|error message"

deleteRecord

XML Input Syntax

<EveCommand>

<command>deleteRecord</command>

<arg1>foreign key</arg1>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok"

foreignKeyRegionSearch

XML Input Syntax

<EveCommand>

<command>foreignKeyRegionSearch</command>

<arg1>colorWeight</arg1>

<arg2>regionWeight</arg2>

<arg3>shapeWeight</arg3>

<arg4>textureWeight</arg4>

<arg5>foreign key</arg5>

<arg6>region1|region2|etc.</arg6>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok|key 1|key 2|etc."

foreignKeySearch

XML Input Syntax

<EveCommand>

<command>foreignKeySearch</command>

<arg1>colorWeight</arg1>

<arg2>regionWeight</arg2>

<arg3>shapeWeight</arg3>

<arg4>textureWeight</arg4>

<arg5>foreign key</arg5>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok|key 1|key 2|etc."

getFirstMetadataValue

XML Input Syntax

<EveCommand>

<command>getFirstMetadataValue</command>

<arg1>metadata key</arg1>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok|metadata value"
 

getKeys

XML Input Syntax

<EveCommand>

<command>getKeys</command>

<shortResponse>true<shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok|key 1|key 2|etc."

getSegmentationMask

XML Input Syntax

<EveCommand>

<command>getSegmentationMask</command>

<arg1>foreignKey</arg1>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

ok|width|height|bunch of 0's, 1's, 2's, etc"

getVocabulary

XML Input Syntax

<EveCommand>

<command>getVocabulary</command>

<arg1>colorWeight|regionWeight|shapeWeight|textureWeight|similarity</arg1>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok"

or

"ok|foreign key 1|foreign key 2|etc."

loadImageFromURL

XML Input Syntax

<EveCommand>

 <command>loadImageFromURL</command>

 <arg1>url string</arg1>

 <shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok"

or

"error|error message"

loadImage

XML Input Syntax

<EveCommand>

<command>loadImage</command>

<arg1>media object key</arg1>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok"

metadataFindExact

XML Input Syntax

<EveCommand>

<command>metadataFindExact</command>

<arg1>metadata key</arg1>

<arg2>metadata value</arg2>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok|key 1|key 2|etc."

metadataFind

XML Input Syntax

<EveCommand>

<command>metadataFind</command>

<arg1>metadata key</arg1>

<arg2>metadata value</arg2>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok|key 1|key 2|etc."

openDatabase

XML Input Syntax

<EveCommand>

<command>openDatabase</command>

<arg1>name of database</arg1>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok"

or

"error|error message"

reorganize

XML Input Syntax

<EveCommand>

<command>reorganize</command>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok"

saveImage

XML Input Syntax

<EveCommand>

<command>saveImage</command>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveResponse>

<errorFlag>false</errorFlag>

<errorMessage>OK</errorMessage>

</EveResponse>

Pipe-Delimited String Output

"ok"

search

XML Input Syntax

<EveCommand>

<command>saveImage</command>

<shortResponse>true</shortResponse>

</EveCommand>

XML Output

<EveCommand>

<command>search</command>

<arg1>colorWeight</arg1>

<arg2>regionWeight</arg2>

<arg3>shapeWeight</arg3>

<arg4>textureWeight</arg4>

<shortResponse>true</shortResponse>

</EveCommand>

Pipe-Delimited String Output

"ok|key 1|key 2|etc."