READ calls

The Read action returns all metadata fields and values for the requested object.

📘
Notes

The Read action can only return one result at a time when querying assets. To view or update multiple records, use the Search API.

Empty fields are excluded from the response by default. To include empty fields, add &Verbose=1 (the IncludeBlankFields parameter) to the query.

Asset example

This call returns all filled metadata fields and values for the production still with the unique identifier ZZ13B.

POST or GET API/DataTable/v2.2/Documents.Image.Production-Still:Read?CoreField.Identifier=ZZ13B

Response

<Result>
<APIRequestInfo>
<ProviderVersion>KOBE.R2.2065F.216315</ProviderVersion>
<ProviderIdentity>OLU-T-USW2</ProviderIdentity>
<ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
<Module>DataTable</Module>
<APIVersion>v2.2</APIVersion>
<Resource>Documents.Image.Production-Still:Read</Resource>
<IsLoggedIn type="Boolean">True</IsLoggedIn>
<Status>LoggedIn</Status>
<UserLogin>[email protected]</UserLogin>
<Session>No session (production configuration)</Session>
<TimeoutPeriodMinutes type="Numeric">20</TimeoutPeriodMinutes>
</APIRequestInfo>
<RequestInterpretation>
<Filters type="List">
<Filter>
<Field>CoreField.Identifier</Field>
<Operator>=</Operator>
<OperatorDescription>Field must be equal to value</OperatorDescription>
<Value>ZZ13B</Value>
</Filter>
</Filters>
<IgnoredParameters type="List"/>
</RequestInterpretation>
<ResponseSummary>
<CurrentPage type="Numeric">1</CurrentPage>
<ItemsPerPage type="Numeric">30</ItemsPerPage>
<TotalItemCount type="Numeric">1</TotalItemCount>
</ResponseSummary>
<FieldNames>
<CoreField.Unique-identifier>CoreField.unique-identifier</CoreField.Unique-identifier>
<CoreField.Legacy-Identifier>CoreField.Legacy-Identifier</CoreField.Legacy-Identifier>
<CoreField.Original-file-name>CoreField.original-file-name</CoreField.Original-file-name>
<CoreField.Digitized-date>CoreField.digitized-date</CoreField.Digitized-date>
<CoreField.Width>CoreField.width</CoreField.Width>
<CoreField.Max-height>CoreField.max-height</CoreField.Max-height>
<CoreField.File-size>CoreField.file-size</CoreField.File-size>
<CoreField.Parent-folder>CoreField.parent-folder</CoreField.Parent-folder>
<CoreField.Title>CoreField.title</CoreField.Title>
<CoreField.Description>CoreField.description</CoreField.Description>
<CoreField.Asset-date>CoreField.asset-date</CoreField.Asset-date>
<_x0032_QDTEB9QUKI>Images.Content-Usage</_x0032_QDTEB9QUKI>
<CoreField.Visibility-class>CoreField.visibility-class</CoreField.Visibility-class>
<CoreField.Source>CoreField.source</CoreField.Source>
<CoreField.Copyright>CoreField.copyright</CoreField.Copyright>
<CoreField.Usage-rights>CoreField.usage-rights</CoreField.Usage-rights>
<CoreField.Allow-Users-to-Bypass-Permissions-when-Impersonating>CoreField.Allow-Users-to-Bypass-Permissions-when-Impersonating</CoreField.Allow-Users-to-Bypass-Permissions-when-Impersonating>
<_x0032_QDZ64M5Z70>People.Approver</_x0032_QDZ64M5Z70>
<_x0032_QDZ64MHP7S>Media.Approved-Date</_x0032_QDZ64MHP7S>
<CoreField.Digitized>CoreField.digitized</CoreField.Digitized>
<CoreField.Editor_x0027_s-rating>CoreField.editor's-rating</CoreField.Editor_x0027_s-rating>
<CoreField.Sub-type>CoreField.sub-type</CoreField.Sub-type>
<CoreField.Type>CoreField.type</CoreField.Type>
<CoreField.Required-editor_x0027_s-rating>CoreField.required-editor's-rating</CoreField.Required-editor_x0027_s-rating>
<CoreField.Source-FastID>CoreField.source-FastID</CoreField.Source-FastID>
<CoreField.Source-name>CoreField.source-name</CoreField.Source-name>
<CoreField.Block-participant-inheritance>CoreField.Block-participant-inheritance</CoreField.Block-participant-inheritance>
<CoreField.File-Create-Date>CoreField.File-Create-Date</CoreField.File-Create-Date>
<CoreField.File-Edit-Date>CoreField.File-Edit-Date</CoreField.File-Edit-Date>
<CoreField.File-import-date>CoreField.file-import-date</CoreField.File-import-date>
<CoreField.MD5-CheckSum>CoreField.MD5-CheckSum</CoreField.MD5-CheckSum>
<CoreField.First-copy-proxy-storage>CoreField.First-copy-proxy-storage</CoreField.First-copy-proxy-storage>
<CoreField.First-copy-original-storage>CoreField.First-copy-original-storage</CoreField.First-copy-original-storage>
<CoreField.Storage-group>CoreField.storage-group</CoreField.Storage-group>
<CoreField.Name-in-urls>CoreField.name-in-urls</CoreField.Name-in-urls>
</FieldNames>
<Response type="List">
<Record>
<CoreField.Unique-identifier>ZZ13B</CoreField.Unique-identifier>
<CoreField.Legacy-Identifier>AdobeStock_317055593</CoreField.Legacy-Identifier>
<CoreField.Original-file-name>AdobeStock_317055593.jpeg</CoreField.Original-file-name>
<CoreField.Digitized-date type="DateTime">2023-09-07T11:31:06</CoreField.Digitized-date>
<CoreField.Width type="Numeric">6638</CoreField.Width>
<CoreField.Max-height type="Numeric">4425</CoreField.Max-height>
<CoreField.File-size>14046524</CoreField.File-size>
<CoreField.Parent-folder>2QDTWAGKDT</CoreField.Parent-folder>
<CoreField.Title>Prague Old Town Pier</CoreField.Title>
<CoreField.Description>Scenic view of the Old Town pier architecture and Charles Bridge over Vltava river in Prague, Czech Republic</CoreField.Description>
<CoreField.Asset-date type="DateTime">2024-09-04T00:00:00</CoreField.Asset-date>
<Images.Content-Usage type="List">
<Item>
<Value>Email</Value>
<RecordID>2QDTREIXAG</RecordID>
<KeywordText>Email</KeywordText>
<PairingMode>NoPairing</PairingMode>
</Item>
<Item>
<Value>Social media</Value>
<RecordID>2QDTRE8OCF</RecordID>
<KeywordText>Social media</KeywordText>
<PairingMode>NoPairing</PairingMode>
</Item>
<Item>
<Value>Website</Value>
<RecordID>2QDTREIA1S</RecordID>
<KeywordText>Website</KeywordText>
<PairingMode>NoPairing</PairingMode>
</Item>
</Images.Content-Usage>
<CoreField.Visibility-class>OR1ND000001488149</CoreField.Visibility-class>
<CoreField.Source>K8OEC0AIXE</CoreField.Source>
<CoreField.Copyright>2023 Anna Morado</CoreField.Copyright>
<CoreField.Usage-rights>Print and web unlimited</CoreField.Usage-rights>
<CoreField.Allow-Users-to-Bypass-Permissions-when-Impersonating>I</CoreField.Allow-Users-to-Bypass-Permissions-when-Impersonating>
<People.Approver>
<Value>Emily Bruchet</Value>
<RecordID>K8OEC0W38A</RecordID>
<KeywordText/>
</People.Approver>
<Media.Approved-Date type="DateTime">2024-08-09T00:00:00</Media.Approved-Date>
<CoreField.Digitized type="Boolean">True</CoreField.Digitized>
<CoreField.Editor_x0027_s-rating>F</CoreField.Editor_x0027_s-rating>
<CoreField.Sub-type>DO_ZZ1ND000000001189</CoreField.Sub-type>
<CoreField.Type>Image</CoreField.Type>
<CoreField.Required-editor_x0027_s-rating>E</CoreField.Required-editor_x0027_s-rating>
<CoreField.Source-FastID>ZZ1CT293</CoreField.Source-FastID>
<CoreField.Source-name>Anna Morado</CoreField.Source-name>
<CoreField.Block-participant-inheritance type="Boolean">False</CoreField.Block-participant-inheritance>
<CoreField.File-Create-Date type="DateTime">2023-09-05T22:16:51</CoreField.File-Create-Date>
<CoreField.File-Edit-Date type="DateTime">2023-09-06T02:07:28</CoreField.File-Edit-Date>
<CoreField.File-import-date type="DateTime">2023-09-07T16:42:36</CoreField.File-import-date>
<CoreField.MD5-CheckSum>e669d22bd1e098ee2aa7304f4ceca763</CoreField.MD5-CheckSum>
<CoreField.First-copy-proxy-storage>ZZ1S5000000000004</CoreField.First-copy-proxy-storage>
<CoreField.First-copy-original-storage>ZZ1S5000000000003</CoreField.First-copy-original-storage>
<CoreField.Storage-group>CTIS6000000000002</CoreField.Storage-group>
<CoreField.Name-in-urls>Prague-Old-Town-Pier</CoreField.Name-in-urls>
<_x0032_QDZ64MHP7S type="DateTime">2024-08-09T00:00:00</_x0032_QDZ64MHP7S>
<_x0032_QDZ64M5Z70>
<Value>Emily Bruchet</Value>
<RecordID>K8OEC0W38A</RecordID>
<KeywordText/>
</_x0032_QDZ64M5Z70>
<_x0032_QDTEB9QUKI type="List">
<Item>
<Value>Email</Value>
<RecordID>2QDTREIXAG</RecordID>
<KeywordText>Email</KeywordText>
<PairingMode>NoPairing</PairingMode>
</Item>
<Item>
<Value>Social media</Value>
<RecordID>2QDTRE8OCF</RecordID>
<KeywordText>Social media</KeywordText>
<PairingMode>NoPairing</PairingMode>
</Item>
<Item>
<Value>Website</Value>
<RecordID>2QDTREIA1S</RecordID>
<KeywordText>Website</KeywordText>
<PairingMode>NoPairing</PairingMode>
</Item>
</_x0032_QDTEB9QUKI>
<CoreField.CreateDate type="DateTime">2023-09-07T16:42:31</CoreField.CreateDate>
<CoreField.EditDate type="DateTime">2025-01-06T22:34:46</CoreField.EditDate>
<CoreField.EditLocation>ZZ1</CoreField.EditLocation>
<RecordID>2QDTWAWEQJ</RecordID>
<CoreField.Disabled type="Boolean">False</CoreField.Disabled>
</Record>
</Response>
</Result>

Contact example

This call returns all metadata fields and values for all users whose last names begin with “f.”

POST or GET /API/DataTable/v2.1/Contact.Client:Read?Contact.CoreField.Last_Name=f*

Operators

The table below lists the operators that you can use to search for assets that meet specific criteria.

If you use a date field as a criterion, use one of these two ISO 8601 date formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.

Operator	Description and example
=	Exact match Asset example `API/DataTable/v2.2/Documents.Image.Default:Read?CoreField.Identifier=CTL898558` This call returns all metadata for the asset with the unique identifier CTL898558. Contact example `/API/DataTable/v2.1/Contact.Client:Read?Contact.CoreField.Last_Name=f*` This call returns all contacts whose last names begin with the letter “f.”
<> or !=	Find assets that are different from the criterion. Contact examples `/API/DataTable/v2.2/Contacts.Client.Default:Read?CoreField.Country<>France` `/API/DataTable/v2.2/Contacts.Client.Default:Read?CoreField.Country!=France` These calls return contacts located in any country except France.
!=	List all values Using the `!=` operator *without* a value allows you to search for all assets that have any value in that field. Contact example: `/API/DataTable/v2.2/Contacts.Client.Default:Read?CoreField.Country!=` This call returns contacts located in any country, as long as the country field has a value.

📘Notes

Asset example

Contact example

Operators

📘
Notes