Fields parameter

ℹ️
Note
The maximum length for a field value in the Search API is 2048 characters.
If your fields have longer values, enter the query parameters into the body of the request using an API client, such as Postman.

Use the fields parameter to specify the information you want Orange Logic to return for each asset that meets your search criteria. You can return any searchable field as well as different asset formats. Use the List Fields API to display a list of all returnable fields available in your organization’s Orange Logic environment.

Asset Formats

To return a link to an asset format, use Path_[Asset Format] in the fields parameter. The asset formats and dimensions you have access to, which are also called proxies, are determined by your Permissions and Security Functions.

ℹ️
Note
The original high-resolution file is protected and cannot be retrieved with the Search API. Instead, use the Extract Original Document API. To request access to this API, submit a support request.

Asset formats generated on upload

Some asset formats are generated on upload, whereas others need to be generated on demand.

Image formats

If an image asset format exists or can be generated, its URL, width, and height are included in the response.

For example, let’s say you want the path of the TR1 format for all assets with “London” in the title. You could use the following API call, which includes Path_TR1 in the fields parameter:

curl -X 'GET' \
  'https://mangovations.orangelogic.com/API/Search/v4.0/Search?query=title%3ALondon&sort=1&fields=path_TR1&fields=SystemIdentifier&pagenumber=1&format=JSON' \
  -H 'accept: application/json'

This returns:

"path_TR1": {
          "URI": "https://mangovations.orangelogic.com/Assets/V2/Y3vwbBLZ3WROfciZLPOxBWdQeS6bQ3QLwvtftGiDEYptZEGhvJpcNpLmaowGsbd1mORdkHM2hqP4FPkrdaQVl62PX7cStX@xb4fubOjDK39TWlbYg6TyPccq7pOTxRTt/QRXdUerhhv92CalB/4l19c6xaxiwhm@Kq/CTL898759.jpg",
          "Width": 1200,
          "Height": 675
        },

Video formats

Video proxies are usually generated as WebHigh and scrub (thumbnail) formats, but your organization might have different video proxies. Entering Path_WebHigh in the fields parameter returns:

 "Path_Webhigh": {
          "URI": "https://mangovations.orangelogic.com/Assets/V2/Y3vwbBLZ3WROfciZLPOxBQmE9c@MIVh0lUOUemFJsimZ08kufxABWzMtG8Kn9z686fLWnGTdlBWNaCsopQqoJlbJEkyIzmX8CIzMP@vtXxKdaIEYTdtRxXq3_HOhYCk3C7LcXX7Iq3N6kyFUoGujUQ--/Gynl5mpkMtEiAr8j/c_NqCDniWAChYG0m/CTL856742.mp4",
          "Width": 0,
          "Height": 0

To obtain the representative image for a video (the image that appears in a video player before a user clicks “play”), query the appropriate media format (this is usually Path_TR1). For example, entering Path_WebHigh, Path_TR1 in the fields parameter returns:

"Path_Webhigh": {
          "URI": "https://mangovations.orangelogic.com/Assets/V2/Y3vwbBLZ3WROfciZLPOxBQmE9c@MIVh0lUOUemFJsimZ08kufxABWzMtG8Kn9z686fLWnGTdlBWNaCsopQqoJlbJEkyIzmX8CIzMP@vtXxKH1aL@hA@Sq_zN2s2qiVTtZTam1mHeIf7kEoN6bKfe_w--/yhzbmuAg8fnj@jhn/SHApBtuTpxqtNVXo/CTL856742.mp4",
          "Width": 0,
          "Height": 0
        },
        "Path_TR1": {
          "URI": "https://mangovations.orangelogic.com/Assets/V2/Y3vwbBLZ3WROfciZLPOxBU573c9dYIlnlZwpYIyK4jlAqsZ@oX3cH8dcPC7IYsZCEE2F@ZRh_qv@OeK3KXA2x8F1mIYzb3hI_CUETUOtTp5IkkzzJj4V@NguQZ9z0iKK/tExxkNMY0_wtfieP/7@iarBFf43WvW5U_/CTL856632.jpg",
          "Width": 1200,
          "Height": 675
        }

Generate Formats On Demand

You can generate formats on demand by setting the generateformatifnotexists parameter as true in the Search API. For example, the following common image formats are common, but are not typically generated on upload:

TRX: Highest quality
CMS1: 2000px x 2000px
CMS2: 1000px x 1000px
CMS3: 500px x 500px

The system displays a warning if:

If the requested format does not exist and generateformatifnotexists is false.
Orange Logic cannot generate the requested format.
You do not have the permissions necessary to generate the requested format.

"Warning": "The requested format is not available on this media [Format]"

Non-watermarked formats

If you request a non-watermarked format but do not have the required Security Functions or Permissions to access that format, the API returns a watermarked format and displays the following message:

"Warning": "You do not have the security clearance to access the requested format."
"SubstituteFormat": "TR1_ WATERMARKED"

Use wildcards in the `fields` parameter

You can use wildcards in the fields parameter to return searchable Core and custom fields that contain values.

For example, to return all searchable fields that contain values from all Namespaces, enter * in the fields parameter. Or, to return all searchable fields that contain values and belong to the Marketing Namespace, enter marketing.* in the fields parameter. The following call returns assets with “London” in the title and the results include information from filled fields in any Marketing Namespace. Note that the asterisk (*) is percent-encoded as %2A.

curl -X 'GET' \
  'https://mangovations.orangelogic.com/API/Search/v3.0/Search?query=title%3ALondon&sort=1&fields=marketing.%2A&pagenumber=1&format=JSON' \
  -H 'accept: application/json'

Limitations

Wildcard searches of the fields parameter do not search smart or computed fields. Additionally, when you use a wildcard, only fields that contain values are returned. This improves the API’s performance.

Standard fields

This list includes the standard fields, their description, and an example of the returned field:

Path: The asset’s path, including the document filename.

<Path>Library/Media & Entertainment/Dream Vacation Destinations/Season 03/Tower bridge</Path>

Path_[Asset Format]: A link to a specific format of an asset.

<Path_TR1>        
  <URI>https://mangovations.orangelogic.com/Assets/V2/Y3vwobM373Ep2iT/3lISg87ue6R6ihX/CTL898758.jpg</URI>
  <Width type="Numeric">1200</Width>   
  <Height type="Numeric">800</Height>
</Path_TR1>

Directory: The asset’s directory, excluding the document filename.

<Directory>Root/Library/Media &amp; Entertainment/Dream Vacation Destinations/Season 03</Directory>

Title: The title in the default language.
```
<title>London bridge</title>
```
SystemIdentifier: Unique System Identifier for the Media generated by the application.
```
<SystemIdentifier>CTL898538</SystemIdentifier>
```
MediaNumber: An asset’s Media Number. Media Numbers field labels vary by organization. For example, some organizations call them “Picture Number,” ”Package Number,” “Accession Number,” or “URN.” Contact your site administrator to learn what your organization calls this field Media Number.
```
<MediaNumber>Walkway with the London Bridge in the background.jpeg</MediaNumber>
```
MediaEncryptedIdentifier: An asset’s Media Encrypted Identifier, or RecordID. Beginning in Orange Logic London, you can also return this field with the syntax RecordID.

Note: This field is protected by security level. Ask your site administrator if you need access.
```
<MediaEncryptedIdentifier>2RBKT7U02C8J</MediaEncryptedIdentifier>
<RecordID>2RBKT7U02C8J</RecordID>
```

FileMD5: The MD5 checksum for the asset.

<FileMD5>a7e3f2f31322aa0e79f5c01473837a6e</FileMD5>

CaptionShort: The short description field.

<CaptionShort> Tower Bridge </CaptionShort>

CaptionLong: The description field.
Note: You can also use Caption to return this field.

<CaptionLong>Walkway with the Tower Bridge in the background.</CaptionLong>
<Caption>Walkway with the Tower Bridge in the background.</Caption>

MediaDate: Media date in the format: MM/DD/YYYY HH:MM:SS, or your requested format.
```
<MediaDate>10/18/2026 08:49:00</MediaDate>
```
CreateDate: Creation date in the format: MM/DD/YYYY HH:MM:SS AM/PM, or your requested format.
```
<CreateDate>11/20/2024 17:49:56</CreateDate>
```
EditDate: Last Edit date in the format: MM/DD/YYYY HH:MM:SS AM/PM, or your requested format.
```
<EditDate>11/20/2024 5:51:12 PM</EditDate>
```
MediaType: The returned asset’s Type.
```
<MediaType>Image</MediaType>
```
Artist: The Artist in the format FirstName LastName.
```
<Artist>Anna Morado</Artist>
```
ParentFolderTitle: The title of the returned asset’s Parent folder.
```
<ParentFolderTitle>Season 03</ParentFolderTitle>
```
ParentFolderNumber: The Legacy Identifier of the returned asset’s parent folder.
```
<ParentFolderNumber></ParentFolderNumber>
```
ParentFolderIdentifier: The Unique ID of the returned asset’s parent folder.
```
<ParentFolderIdentifier>CTLSTO203010</ParentFolderIdentifier>
```
ParentFolderEncryptedIdentifier: The Media Encrypted Identifier, or Record ID , of the asset’s parent folder. This field is protected by security level. Ask your site administrator if you need access.
```
<ParentFolderEncryptedIdentifier>2RBKT7U8TVRU</ParentFolderEncryptedIdentifier>
```
MaxWidth: Width in pixels of the original image.
```
<MaxWidth>6362</MaxWidth>
```
MaxHeight: Height in pixels of the original image.
```
<MaxHeight>4243</MaxHeight>
```
MediaCount: Only relevant in a query on folders. Retrieves the number of assets in a folder.
```
<MediaCount>2</MediaCount>
```
ImageCount: Only relevant in a query on folders. Retrieves the number of images in a folder.
```
<ImageCount>7</ImageCount>
```
VideoCount: Only relevant in a query on folders. Retrieves the number of videos in a folder.
```
<VideoCount>1</VideoCount>
```
PackageCount: Only relevant in a query on folders. Retrieves the number of folders in a folder.
```
<PackageCount>1</PackageCount>
```
Document.DominantColors: Orange Logic automatically identifies the colors that appear most frequently in an image asset and displays them in the Similar Tones extension. This field extracts the HEX codes of the most frequent colors.

Similar Tones extension

The response shows the HEX codes of the colors displayed in the Similar Tones extension, starting with the most dominant color. Each HEX code is preceded by a multiplier (4x, 2x, 1x, etc.) that indicates how important that color is, as represented by the relative size of the color’s block in the extension’s UI. For example, in the following code, the returned asset has 12 dominant colors.
```
<Document.DominantColors>4x #00BDE2, 2x #0087AB, 2x #5279AB, 2x #95B823, 1x #62BAA8, 1x #85B96D, 1x #51833C, 1x #1E510C, 1x #8A753E, 1x #56450F, 1x #917400, 1x #5D8300</Document.DominantColors>
```

Keywords: An asset’s tags and each tag’s Tag Type. For example, the following response shows that the returned asset has the tags amazing and architecture with the Common Tag Type and the tag attraction with the NewlyCreated Tag Type.

<Keywords type="List">
  <Keyword>    
    <Label>amazing</Label>
    <KeywordType>Common</KeywordType>
    <LinkType>
    </LinkType>
  </Keyword>
  <Keyword>
<Label>architecture</Label>
     <KeywordType>Common</KeywordType>
<LinkType>
</LinkType>
  </Keyword>
  <Keyword>
     <Label>attraction</Label>         
     <KeywordType>NewlyCreated</KeywordType>
 <LinkType>
 </LinkType>
 </Keyword>
</Keywords>

MIMEtype: Retrieve an asset’s MIME type, which stands for Multipurpose Internet Mail Extension. Essentially, this is a file’s format and file extension. Browsers use MIME Types (not file extensions) to process a URL. Most MIME Types have a type and a subtype. These differ from Orange Logic asset types and subtypes.
```
<mimetype>image/jpeg</mimetype>
```

Fields parameter

ℹ️
Note

Asset Formats

ℹ️
Note

Asset formats generated on upload

Image formats

Video formats

Generate Formats On Demand

Non-watermarked formats

Use wildcards in the `fields` parameter

Limitations

Standard fields

ℹ️Note

Asset Formats

ℹ️Note

Asset formats generated on upload

Image formats

Video formats

Generate Formats On Demand

Non-watermarked formats

Use wildcards in the fields parameter

Limitations

Standard fields

ℹ️
Note

ℹ️
Note

Use wildcards in the `fields` parameter