getGenerationInfo

Returns 2 different types of information based on the parameters passed in. originatorHandle returns information about assets generated from the specified asset. generateHandle returns information about steps used to generate the specified asset or file.

Syntax

Authorized User Types

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

Parameters

Input (getGenerationInfoParam)

Name Type Required Description
*Code Phrase* xsd:string Yes The handle to the company.
*Code Phrase* xsd:string No The engine that was used in the generation. See Font Styles.
*Code Phrase* xsd:string No The handle of the asset to query for generated assets.
*Code Phrase* xsd:string No The handle of the asset to query for assets and engines used in its generation.
*Code Phrase* xsd:StringArray No Properties included in the operation.
*Code Phrase* xsd:StringArray No Properties excluded from the operation.

Output (getGenerationInfoReturn)

Name Type Required Description
*generationArray* types:GenerationInfoArray Yes Array of generation information.

Examples

This code sample returns information about assets generated from a specific asset. It does not retrieve information about steps used to generate the specified asset. The response is truncated for brevity.

Request

<getGenerationInfoParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|6</companyHandle>
   <originatorHandle>a|716|25|160</originatorHandle>
</getGenerationInfoParam>

Response

<getGenerationInfoReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <generationArray>
      <items>
         <engine>PostScriptRip</engine>
         <originator>
         ...
         </generated>
         <attributeArray/>
      </items>
   </generationArray>
</getGenerationInfoReturn>

On this page