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 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.1</APIVersion>
<Resource>Contact.Client:Read</Resource>
<IsLoggedIn type="Boolean">True</IsLoggedIn>
<Status>LoggedIn</Status>
<UserLogin>[email protected]</UserLogin>
<Session>No session (production configuration)</Session>
<TimeoutPeriodMinutes type="Numeric">120</TimeoutPeriodMinutes>
</APIRequestInfo>
<RequestInterpretation>
<Filters type="List">
<Filter>
<Field>Contact.CoreField.Last_Name</Field>
<Operator>= / *</Operator>
<OperatorDescription>Field should start like value</OperatorDescription>
<Value>f%</Value>
</Filter>
</Filters>
<IgnoredParameters type="List"/>
</RequestInterpretation>
<ResponseSummary>
<CurrentPage type="Numeric">1</CurrentPage>
<ItemsPerPage type="Numeric">30</ItemsPerPage>
<TotalItemCount type="Numeric">1</TotalItemCount>
</ResponseSummary>
<Response type="List">
<Record>
<Contact.CoreField.BlockTransactions type="Boolean">False</Contact.CoreField.BlockTransactions>
<Contact.CoreField.CanPayByCreditCard type="Boolean">True</Contact.CoreField.CanPayByCreditCard>
<Contact.CoreField.ConsentPA type="Boolean">True</Contact.CoreField.ConsentPA>
<Contact.CoreField.ConsentTC type="Boolean">True</Contact.CoreField.ConsentTC>
<Contact.CoreField.Contact_type>Client</Contact.CoreField.Contact_type>
<Contact.CoreField.Country>US</Contact.CoreField.Country>
<Contact.CoreField.DirectMarketing type="Boolean">False</Contact.CoreField.DirectMarketing>
<Contact.CoreField.Disabled type="Boolean">False</Contact.CoreField.Disabled>
<Contact.CoreField.DisplayName>Jennifer Fancera</Contact.CoreField.DisplayName>
<Contact.CoreField.DueDays type="Numeric">30</Contact.CoreField.DueDays>
<Contact.CoreField.EditDate type="DateTime">2024-11-18T15:58:11</Contact.CoreField.EditDate>
<Contact.CoreField.EditLocation>ZZ1</Contact.CoreField.EditLocation>
<Contact.CoreField.Email1>[email protected]</Contact.CoreField.Email1>
<Contact.CoreField.First_Name>Jennifer</Contact.CoreField.First_Name>
<Contact.CoreField.Identifier>ZZ091721</Contact.CoreField.Identifier>
<Contact.CoreField.Last_Name>Fance</Contact.CoreField.Last_Name>
<Contact.CoreField.Locked type="Boolean">False</Contact.CoreField.Locked>
<Contact.CoreField.SSO_Status>NonSSOAllowed</Contact.CoreField.SSO_Status>
<Contact.CoreField.Status>Validated</Contact.CoreField.Status>
<RecordID>K8OEC0OOVV</RecordID>
</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*

Response

  
  <Result>
<APIRequestInfo>
<ProviderVersion>KOBE.R2.2065F.216315</ProviderVersion>
<ProviderIdentity>OLU-T-USW2</ProviderIdentity>
<ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
<Module>DataTable</Module>
<APIVersion>v2.1</APIVersion>
<Resource>Contact.Client:Read</Resource>
<IsLoggedIn type="Boolean">True</IsLoggedIn>
<Status>LoggedIn</Status>
<UserLogin>[email protected]</UserLogin>
<Session>No session (production configuration)</Session>
<TimeoutPeriodMinutes type="Numeric">120</TimeoutPeriodMinutes>
</APIRequestInfo>
<RequestInterpretation>
<Filters type="List">
<Filter>
<Field>Contact.CoreField.Last_Name</Field>
<Operator>= / *</Operator>
<OperatorDescription>Field should start like value</OperatorDescription>
<Value>f%</Value>
</Filter>
</Filters>
<IgnoredParameters type="List"/>
</RequestInterpretation>
<ResponseSummary>
<CurrentPage type="Numeric">1</CurrentPage>
<ItemsPerPage type="Numeric">30</ItemsPerPage>
<TotalItemCount type="Numeric">1</TotalItemCount>
</ResponseSummary>
<Response type="List">
<Record>
<Contact.CoreField.BlockTransactions type="Boolean">False</Contact.CoreField.BlockTransactions>
<Contact.CoreField.CanPayByCreditCard type="Boolean">True</Contact.CoreField.CanPayByCreditCard>
<Contact.CoreField.ConsentPA type="Boolean">True</Contact.CoreField.ConsentPA>
<Contact.CoreField.ConsentTC type="Boolean">True</Contact.CoreField.ConsentTC>
<Contact.CoreField.Contact_type>Client</Contact.CoreField.Contact_type>
<Contact.CoreField.Country>US</Contact.CoreField.Country>
<Contact.CoreField.DirectMarketing type="Boolean">False</Contact.CoreField.DirectMarketing>
<Contact.CoreField.Disabled type="Boolean">False</Contact.CoreField.Disabled>
<Contact.CoreField.DisplayName>Jennifer Fancera</Contact.CoreField.DisplayName>
<Contact.CoreField.DueDays type="Numeric">30</Contact.CoreField.DueDays>
<Contact.CoreField.EditDate type="DateTime">2024-11-18T15:58:11</Contact.CoreField.EditDate>
<Contact.CoreField.EditLocation>ZZ1</Contact.CoreField.EditLocation>
<Contact.CoreField.Email1>[email protected]</Contact.CoreField.Email1>
<Contact.CoreField.First_Name>Jennifer</Contact.CoreField.First_Name>
<Contact.CoreField.Identifier>ZZ091721</Contact.CoreField.Identifier>
<Contact.CoreField.Last_Name>Fance</Contact.CoreField.Last_Name>
<Contact.CoreField.Locked type="Boolean">False</Contact.CoreField.Locked>
<Contact.CoreField.SSO_Status>NonSSOAllowed</Contact.CoreField.SSO_Status>
<Contact.CoreField.Status>Validated</Contact.CoreField.Status>
<RecordID>K8OEC0OOVV</RecordID>
</Record>
</Response>
</Result>

Operators

The table below lists the operators that you can use to search for assets that meet specific criteria. When the criteria includes metadata fields, you can use the field’s name or a field value.

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.”
<>	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 The use of 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