📄 Note: Users must have permission to download the media object for the profiles specified
Resource Information
Resource URL
Parameters
XML Body
Example Response
- Where the API results are returned successfully, but no match has been found
- Where the API results are returned successfully, and a match has been found
- Error response
Resource URL
https://{your imagen domain}/iweb/v1/search?query=WHERE {field}="{search term}"
Parameters
Arguments should be supplied as query parameters, as shown below
&numRecords
[Optional]
/iweb/v1/search&numRecords
n number of records for the search to return
&start
[Optional]
/iweb/v1/search&start
Index of the first record in the results that you want to be returned
💡Pro tip: the searchID will be returned in response to the call for the first page of results (and each subsequent call thereafter)
⚠️Warning: MUST be used with &searchID=xxxx
&includeMedia
[Optional]
/iweb/v1/search&includeMedia=(true or false)
Optional parameter so that media objects are returned with the call.
💡Pro tip: This query uses Imagen Query Language, similar to our related records and records grids in ImagenWeb. You can use > < = or != operators only. LIMIT can be added to the query.
XML Body
None
Response on success
Where the API results are returned succesfully but no match has been found
<?xml version="1.0" encoding="UTF-8"?>
<Records>
<SearchID>C6CCD52A-A7A2-41a7-AEA4-E784668EDDCF</SearchID>
<TotalHits>0</TotalHits>
<User>4</User>
</Records>
Where the API results are returned successfully, and a match has been found
<?xml version="1.0" encoding="UTF-8"?>
<Records>
<SearchID>C1F6107C-96FA-40d3-AD4B-FC8A4EB17367</SearchID>
<TotalHits>1</TotalHits>
<User>4</User>
<ImagenRecord ID="49" CanEdit="false">
<Fields>
<guid>9A9A8A08-4A82-4f9c-8CC1-0C93631C5EC9</guid>
<Title>Red Car</Title>
<Date>2020-01-16</Date>
<Summary>This is a red car</Summary>
<Rating/>
<Category>Cars,Art</Category>
<internal_guid/>
<CIS_ACLList/>
<imagenLastRecordChange>2022-09-02 12:09:19</imagenLastRecordChange>
</Fields>
<MediaObject Version="3" ID="38" MediaType="Image">
<BaseDownloadCost>0</BaseDownloadCost>
<ProcessingCostPerSecond>0</ProcessingCostPerSecond>
<Name/>
<Duration>0</Duration>
<MediaElement MediaType="Image" Index="0" Umid="0x060a2b340101010201010f1213e342a08f5e2c0326960580577e6045BD906AB2">
<Duration>-1</Duration>
<FileSize>5787338</FileSize>
<LastModified></LastModified>
<NumStills>0</NumStills>
<Offset>0</Offset>
<OriginalFile></OriginalFile>
<Rate>-1</Rate>
<Rotation>0</Rotation>
<Flip>110</Flip>
<StartOffset>0</StartOffset>
<IsDirty>True</IsDirty>
<IsNew>False</IsNew>
<TotalDuration>-1</TotalDuration>
<DownloadURL></DownloadURL>
</MediaElement>
<IsDirty>True</IsDirty>
<MediaRendition Umid="0x060a2b340101010201010f1213b6185533fb2c0326960580e0fa6045BD906AB2" Original="False" Profile="10">
<FileSize>110722</FileSize>
<IsDirty>True</IsDirty>
<JobId>8C96AA66-1DBC-40eb-9E79-B1F992AF104C</JobId>
<LastModified>2022-02-16 14:48:00</LastModified>
<RateUnknown>True</RateUnknown>
<Rate>0</Rate>
<StartOffset>-1</StartOffset>
<StillsInterval>-1</StillsInterval>
<NumStills>-1</NumStills>
<WorkflowId>3A2CF2CF-027A-43e7-9AD9-CAB4DD0FBC1D</WorkflowId>
<RenditionWidth>480</RenditionWidth>
<RenditionHeight>720</RenditionHeight>
<DownloadCostMultiplier>-1</DownloadCostMultiplier>
</MediaRendition>
<MediaRendition Umid="0x060a2b340101010201010f12133099a087fb2c0326960580d09f6045BD906AB2" Original="False" Profile="11">
<FileSize>7984</FileSize>
<IsDirty>True</IsDirty>
<JobId>1A4E772C-FE66-4773-AF29-469726E8E2D1</JobId>
<LastModified>2022-02-16 14:48:00</LastModified>
<RateUnknown>True</RateUnknown>
<Rate>0</Rate>
<StartOffset>-1</StartOffset>
<StillsInterval>-1</StillsInterval>
<NumStills>-1</NumStills>
<WorkflowId>3A2CF2CF-027A-43e7-9AD9-CAB4DD0FBC1D</WorkflowId>
<RenditionWidth>120</RenditionWidth>
<RenditionHeight>180</RenditionHeight>
<DownloadCostMultiplier>-1</DownloadCostMultiplier>
</MediaRendition>
<MediaRendition Umid="0x060a2b340101010201010f12136864a0cbfa2c0326960580dbb16045BD906AB2" Original="False" Profile="12">
<FileSize>4452618</FileSize>
<IsDirty>True</IsDirty>
<JobId>985BE0C0-17DC-4fee-84C4-7B89F49D0BCB</JobId>
<LastModified>2022-02-16 14:48:00</LastModified>
<RateUnknown>True</RateUnknown>
<Rate>0</Rate>
<StartOffset>-1</StartOffset>
<StillsInterval>-1</StillsInterval>
<NumStills>-1</NumStills>
<WorkflowId>3A2CF2CF-027A-43e7-9AD9-CAB4DD0FBC1D</WorkflowId>
<RenditionWidth>4000</RenditionWidth>
<RenditionHeight>6000</RenditionHeight>
<DownloadCostMultiplier>-1</DownloadCostMultiplier>
</MediaRendition>
<State>archived</State>
<MetaDataCollection>
<IsDirty>False</IsDirty>
<MetaDataKey IsDirty="False" Key="ArchivedTime">
<MetaDataValue>2022-02-16 14:48:00</MetaDataValue>
</MetaDataKey>
<MetaDataKey IsDirty="False" Key="CIS_ACLList">
<MetaDataValue><?xml version="1.0" encoding="UTF-8" ?><ACL><Role Type="1" RoleID="0" Organisation="" Start="0" End="0" Rights="1">Everyone</Role><Role Type="1" RoleID="2" Organisation="" Start="0" End="0" Rights="7">Administrators</Role><Role Type="0" RoleID="4" Organisation="" Start="0" End="0" Rights="7">superadmin@imagenevp.com</Role></ACL></MetaDataValue>
</MetaDataKey>
<MetaDataKey IsDirty="False" Key="DisplayPosition">
<MetaDataValue>0</MetaDataValue>
</MetaDataKey>
<MetaDataKey IsDirty="False" Key="PreviewOnly">
<MetaDataValue>false</MetaDataValue>
</MetaDataKey>
</MetaDataCollection>
<ObjectWidth>4000</ObjectWidth>
<ObjectHeight>6000</ObjectHeight>
<ActualColours>291D1A: 25.73 542C26: 15.80 A39DA2: 8.96 644733: 7.75 D4D5DE: 7.57 4F3D42: 7.42 C3B7BC: 6.59 665B58: 6.45 AB3F35: 6.05 976B5B: 4.50 B98A6F: 2.17 937C85: 1.00</ActualColours>
<DominantColours>brown brown brown brown brown brown brown brown brown brown brown white white white white white white</DominantColours>
</MediaObject>
</ImagenRecord>
</Records>