getAssets
Last update: August 31, 2023
CREATED FOR:
- Developer
- Admin
Returns assets from the Image Production System (IPS).
Syntax
Authorized User Types
IpsUserIpsAdminIpsCompanyAdminTrialSiteAdminTrialSiteUserImagePortalAdminImagePortalUserImagePortalContribImagePortalContribUser
NOTEOnly returns those assets that the user has access to.
Parameters
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