updateTagFieldValues

Updates tag dictionary values for a tag field.

Syntax

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (updateTagFieldValuesParam)

Name Type Required Description
companyHandle xsd:string Yes Company handle.
fieldHandle xsd:string Yes Tag field handle.
updateArray types:TagValueUpdateArray Yes Array of tag field values that you want to update.

Note: Updates tag string values only. Does not affect asset associations.

Output (updateTagFieldValuesReturn)

Name Type Required Description
*successCount* xsd:int Yes The number of successfully updated tag fields.
*warningCount* xsd:int Yes The number of warnings generated when the operation attempted to update tag fields.
*errorCount* xsd:int Yes The number of errors generated when the operation attempted to update tag fields.
*warningDetailArray* types:TagValueUpdateFaultArray No The array of details associated with the assets that generated warnings when the operation attempted to update tag fields.
*errorDetailArray* types:TagValueUpdateFaultArray No The array of details associated with the assets that generated errors when the operation attempted to update tag fields.

Examples

Request

<updateTagFieldValuesParam xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
   <companyHandle>c|3</companyHandle>
   <fieldHandle>m|3|ASSET|SingleFixedTag</fieldHandle>
   <updateArray>
      <items>
         <oldValue>Nurth</oldValue>
         <newValue>North</newValue>
      </items>
      <items>
         <oldValue>Suth</oldValue>
         <newValue>South</newValue>
      </items>
      <items>
         <oldValue>East</oldValue>
         <newValue>West</newValue>
      </items>
      <items>
         <oldValue>Banana</oldValue>
         <newValue>Pear</newValue>
      </items>
   </updateArray>
</updateTagFieldValuesParam>

Response

<updateTagFieldValuesReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
   <successCount>2</successCount>
   <warningCount>0</warningCount>
   <errorCount>2</errorCount>
   <errorDetailArray>
      <items>
         <value>East</value>
         <code>30001</code>
         <reason>New tag value 'West' already exists.</reason>
      </items>
      <items>
         <value>Banana</value>
         <code>30001</code>
         <reason>Tag value 'Banana' not found.</reason>
      </items>
   </errorDetailArray>
</updateTagFieldValuesReturn>

On this page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now