getAssets

Returns assets from IPS.

Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE

Only returns those assets the user has access to.

Parameters

Input (getAssetParam)

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 sub-fields included in the response.

excludeFieldArray

types:StringArray

Fields and sub-fields excluded from the response.

Outpub (getAssetsReturn)

Name

Type

Required

Description

assetArray

types:AssetArray

No

Array of assets matching the filter criteria.

On this page