DocumentationDynamic Media Image Production System API

getAssets getassets

Last update: Thu Aug 31 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Returns assets from the Image Production System (IPS).

Syntax

Authorized User Types section-4673c1c9f4314160af8b165eb2dd20cc

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
Only returns those assets that the user has access to.

Parameters section-bb9cf1ab19ea47acbd9ae58646dbe273

Input (getAssetsParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
The company handle.
accessUserHandle
xsd:string
No
Impersonate a specific user. Used by administrators only.
accessGroupHandle
xsd:string
No
Filter by group.
assetHandleArray
xsd:HandleArray
Yes
The root folder to retrieve folders and all subfolders to the leaf level. If excluded, the company root is used.
responseFieldArray
types:StringArray
No
Fields and subfields that are included in the response.
excludeFieldArray
types:StringArray
Fields and subfields that are excluded from the response.

Output (getAssetsReturn)

Name
Type
Required
Description
assetArray
types:AssetArray
No
Array of assets matching the filter criteria.
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681