DocumentationDynamic Media Image Production System API

setImageSetMembers

Last update: Tue Jul 20 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Sets the list of assets associated with an image set.

This operation ignores the pageReset parameter for ImageSets and SpinSets and forces the value to true.

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
The user must have read and write access to the image set asset and read access to each member asset.

Parameters

Input (setImageSetMembersParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
Company handle.
assetHandle
xsd:string
Yes
Image set handle.
memberArray
types:ImageSetMemberUpdateArray
Yes
Array of asset members that belong to the image set.

Output (setImageSetMembersReturn)

The IPS API does not return a response for this operation.

Examples

This code sample uses a member array to set the members of an image set.

Request

<setImageSetMembersParam xmlns="http://www.scene7.com/IpsApi/xsd">
   <companyHandle>47</companyHandle>
   <assetHandle>34205|22|929</assetHandle>
   <memberArray>
      <items>
         <assetHandle>24266|1|17062</assetHandle>
         <pageReset>true</pageReset>
      </items>
   </memberArray>
</setImageSetMembersParam>

Response

None.

4e9b9d8c-5839-4215-aa35-01b652869681