DocumentationDynamic Media Image Production System API

batchSetIccProfileFields

Last update: Wed Mar 09 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Sets ICC profile metadata fields.

Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters

Input (batchSetIccProfileFields)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
Handle to the company that contains the ICC profiles.
update array
xsd:string
Yes
Array of ICC profile updates.

Output (batchSetIccProfileFields)

Name
Type
Required
Description
successCount
xsd:int
Yes
The number of successfully set ICC profile fields.
warningCount
xsd:int
Yes
The number of warnings generated when the operation attempted to set the ICC profile fields.
errorCount
xsd:int
Yes
The number of errors generated when the operation attempted to set the ICC profile fields.
warningDetailArray
types:AssetOperationFaultArray
No
The array of details associated with the assets that generated warnings when the operation attempted to apply the updates.
errorDetailArray
types:AssetOperationFaultArray
No
The array of details associated with the assets that generated errors when the operation attempted to apply the updates.

Examples

Request

<batchSetIccProfileFieldsParam xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
   <companyHandle>c|1</companyHandle>
   <updateArray>
      <items>
         <assetHandle>a|1808|13|169</assetHandle>
         <class>Output</class>
         <colorSpace>CMYK</colorSpace>
         <pcsType>Luv</pcsType>
      </items>
   </updateArray>
</batchSetIccProfileFieldsParam>

Response

<batchSetIccProfileFieldsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2009-07-31">
   <successCount>1</successCount>
   <warningCount>0</warningCount>
   <errorCount>0</errorCount>
</batchSetIccProfileFieldsReturn>
4e9b9d8c-5839-4215-aa35-01b652869681