getOriginalFilePaths

Gets the original file paths of a company’s assets.

Syntax

Authorized User Types

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

Requires read access to the asset.

Parameters

Input (getOriginalFilePathsParam)

Name Type Required Description
*companyHandle* xsd:string Yes The handle to the company.
*assetHandleArray* types:HandleArray Yes Array of handles to assets whose original file path you want to obtain.

Output (getOriginalFilePathsReturn)

Name Type Required Description
*originalFileArray* types:StringArray Yes The array of strings that represent the original file paths.

Examples

This code sample returns the file paths of assets specified with unique asset handles in an asset handle array.

Request

<ns1:getOriginalFilePathsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:assetHandleArray>
      <ns1:items>24265|1|17061</ns1:items>
      <ns1:items>24267|1|17063</ns1:items>
   </ns1:assetHandleArray>
</ns1:getOriginalFilePathsParam>

Response

<getOriginalFilePathsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <originalFileArray>
      <items>MyCompany/Autumn Leaves.jpg</items>
      <items>MyCompany/Desert Landscape.jpg</items>
   </originalFileArray>
</getOriginalFilePathsReturn>

On this page