API Reference

UPDATE calls

The Update action updates asset metadata.

📘

Note

If you are updating a user account, your changes might trigger an email to notify that user of their account changes. You can control email notifications with the &AllowNotifications parameter.

Asset example

This call updates the image’s title to “Sunrise over a temple in Bali.”

POST or GET /API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=ZZ116ER&CoreField.Title:=Sunrise over a temple in Bali

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.Default:Update</Resource>
<IsLoggedIn type="Boolean">True</IsLoggedIn>
<Status>LoggedIn</Status>
<UserLogin>jennifer.fance@orangelogic.com</UserLogin>
<Session>Jen Demo</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>ZZ116ER</Value>
</Filter>
</Filters>
<Updates type="List">
<Update>
<Field>CoreField.Title</Field>
<Operator>:=</Operator>
<OperatorDescription>Assign a value to a single-value field</OperatorDescription>
<Value>Sunrise over a temple in Bali</Value>
</Update>
</Updates>
<IgnoredParameters type="List"/>
</RequestInterpretation>
<ResponseSummary>
<NumberOfRecordsAffected type="Numeric">1</NumberOfRecordsAffected>
</ResponseSummary>
<Response>
<RecordsAffected type="List">
<Result>
<RecordID>2QDTWAGZW5H</RecordID>
<Code>SUCCESS</Code>
</Result>
</RecordsAffected>
</Response>
</Result>

Operators

The table below lists the operators that you can use to update asset metadata. Each operator corresponds to the type of metadata field (single-value field, single-value field based on an authority list, multi-value field, etc.)

OperatorDescription and example
:=Add or replace a value in a single-value field.

Example:
/API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=ZZ116ER&CoreField.Title:=Sunrise over a temple in Bali

This call updates the image’s title to “Sunrise over a temple in Bali.”
+:=Add or replace a value in a single-value field based on an authority list.

This call will only add the value if it already exists in the authority list.

Example:
/API/DataTable/V2.2/Documents.Image.Production-Still:Update?CoreField.Identifier=ZZ15G&Location.City+:=Bangkok

To remove the value from the field, do not add a value after the operator. The following call removes any value in the City field.

Example:
/API/DataTable/V2.2/Documents.Image.Production-Still:Update?CoreField.Identifier=ZZ15G&Location.City+:=
+=Add a value to a multivalued field based on an authority list.

This call will only add the value if it already exists in the authority list.

Example:
/API/DataTable/V2.2/Documents.Image.Production-Still:Update?CoreField.Identifier=ZZ15G&Images.Content-Usage+=Blog post

To add multiple values, separate each value with a pipe ( | ).

Example:
/API/DataTable/V2.2/Documents.Image.Production-Still:Update?CoreField.Identifier=ZZ15G&Images.Content-Usage+=Streaming platform|website|sales collateral
-=Remove a value from a multivalued field based on an authority list.

Example:
/API/DataTable/V2.2/Documents.Image.Production-Still:Update?CoreField.Identifier=ZZ15G&Images.Content-Usage-=Blog post
++=Create a new value and add it to a multivalued field based on an authority list.

Example:
/API/DataTable/V2.2/Documents.Image.Production-Still:Update?CoreField.Identifier=ZZ15G&Images.Content-Usage++=Brochure

This call can be used to create only one new value at a time. The newly-created Tag will be added to the Tag Type that is associated with that field’s authority list.

If you create new tags and add them to an asset’s Tags tab, the new tags will be added to the “Newly Created” Tag Type. For more examples of adding tags to the Tags tab, see the sample "Create tags and add them to an asset" call.
--=Remove all values from a multivalued field based on an authority list.

Example:
/API/DataTable/V2.2/Documents.Image.Production-Still:Update?CoreField.Identifier=ZZ15G&Images.Content-Usage--=

📙

Feature documentation