getAssociatedAssets getassociatedassets

Hiermee worden elementen opgehaald die zijn gekoppeld aan een opgegeven element en worden details over de relatie ervan weergegeven.

Syntaxis

Geautoriseerde gebruikerstypen section-453cc706400345778713cda249bfac16

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

Parameters section-d11d0dab59e94e89b466123a0ebfa82e

Input (getAssociatedAssetsParam)

Naam
Type
Vereist
Beschrijving
companyHandle
xsd:string
Ja
Verwerking naar het bedrijf dat eigenaar is van het actief.
assetHandle
xsd:string
Ja
Asset handle.
responseFieldArray
types:StringArray
Nee
De array met responsvelden die u wilt. Zie response- FieldArray/excludeFieldArray in de Inleiding.
excludeFieldArray
types:StringArray
Nee
De array van uitgesloten responsvelden. Zie response- FieldArray/excludeFieldArray in de Inleiding.

Output (getAssociatedAssetsReturn)

Naam
Type
Vereist
Beschrijving
containerArray
types:AssetArray
Nee
Array van set- en sjabloonelementen die het opgegeven element bevatten.
memberArray
types:AssetArray
Nee
Array met elementen die deel uitmaken van de opgegeven set of het sjabloonelement.
layerReferenceArray
types:AssetArray
Nee
Array met elementen waarnaar wordt verwezen in een laag of sjabloon-URL.
ownerArray
types:AssetArray
Nee
Array met elementen die eigenaar zijn van het opgegeven element.
derivedArray
types:AssetArray
Nee
Array met elementen die zijn gebruikt om het opgegeven element te genereren.
generatorArray
types:GenerationInfoArray
Nee
generatorArray maakt een lijst van de manier dit element werd gecreeerd. Als assetHandler bijvoorbeeld een afbeeldingspagina van een PDF was, zou dit het PDF-processorgereedschap bevatten en verwijzen naar het PDFFile-element.
generateArray
types:GenerationInfoArray
Nee
generatedArray keert de manier om dit element werd gecreeerd. Bijvoorbeeld, generatedArray kon de lijst van beelden bevatten die van dit assetHandler worden geproduceerd als dit een activa PdfFile was.
thumbAsset
types:Asset
Nee
De informatie over het blokelement dat aan het aanvraagelement is gekoppeld. Als er geen blokelement is toegewezen, wordt het veld weggelaten in het antwoord.

U kunt de parameters responseFieldArray of excludeFieldArray gebruiken om de grootte van de reactie te beperken. Met name de GenerationInfo items die in generatorArray of generatedArray standaard worden geretourneerd, omvatten zowel de maker als de gegenereerde elementrecords. Voor een PDF-elementtype resulteert dit in ongewenste meervoudige kopieën van de "originator" PDF-elementrecord in de reactie. U kunt dit probleem verhelpen door generatedArray/items/originator aan excludeFieldArray toe te voegen. U kunt ook een expliciete lijst opgeven met responsvelden die u wilt opnemen in responseFieldArray .

Voorbeelden section-8946ea4b9cb94912a8408249c897f192

Het volgende eenvoudige voorbeeld is een verzoek om de handgreep van de generator voor een afbeelding die uit een PDF wordt geëxtraheerd. Het bevat een containerArray lengte van één met een item inclusief de assetHandle van de PDF.

Verzoek

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:beta="http://www.scene7.com/IpsApi/xsd/2013-08-29-beta">
   <soap:Body>
      <beta:getAssociatedAssetsParam>
         <beta:companyHandle>c|11</beta:companyHandle>
         <beta:assetHandle>a|197</beta:assetHandle>
         <beta:responseFieldArray>
            <beta:items>containerArray/items/assetHandle</beta:items>
         </beta:responseFieldArray>
      </beta:getAssociatedAssetsParam>
   </soap:Body>
</soap:Envelope>

Reactie

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <getAssociatedAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2013-08-29-beta">
         <containerArray>
            <items>
               <assetHandle>a|207</assetHandle>
            </items>
         </containerArray>
      </getAssociatedAssetsReturn>
   </soapenv:Body>
</soapenv:Envelope>

Het omgekeerde van het bovenstaande voorbeeld is als volgt:

Verzoek

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:beta="http://www.scene7.com/IpsApi/xsd/2013-08-29-beta">
   <soap:Body>
      <beta:getAssociatedAssetsParam>
         <beta:companyHandle>c|11</beta:companyHandle>
         <beta:assetHandle>a|177</beta:assetHandle>
        <beta:responseFieldArray>
           <beta:items>generatedArray/items/originator/assetHandle</beta:items>
         </beta:responseFieldArray>
      </beta:getAssociatedAssetsParam>
   </soap:Body>
</soap:Envelope>

Reactie

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <getAssociatedAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2013-08-29-beta">
         <generatedArray>
            <items>
               <originator>
                  <assetHandle>a|177</assetHandle>
               </originator>
            </items>
            <items>
               <originator>
                  <assetHandle>a|177</assetHandle>
               </originator>
            </items>
            <items>
               <originator>
                  <assetHandle>a|177</assetHandle>
               </originator>
            </items>
            <items>
               <originator>
                  <assetHandle>a|177</assetHandle>
               </originator>
            </items>
            <items>
               <originator>
                  <assetHandle>a|177</assetHandle>
               </originator>
            </items>
            <items>
               <originator>
                  <assetHandle>a|177</assetHandle>
               </originator>
            </items>
            <items>
               <originator>
                  <assetHandle>a|177</assetHandle>
               </originator>
            </items>
            <items>
               <originator>
                  <assetHandle>a|177</assetHandle>
               </originator>
            </items>
            <items>
               <originator>
                  <assetHandle>a|177</assetHandle>
               </originator>
            </items>
            <items>
               <originator>
                  <assetHandle>a|177</assetHandle>
               </originator>
            </items>
         </generatedArray>
      </getAssociatedAssetsReturn>
   </soapenv:Body>
</soapenv:Envelope>

In dit volgende voorbeeld wordt een groep toegevoegd aan een bedrijf met groupHandleArray . In dit voorbeeld wordt slechts één groep gebruikt.

Verzoek

<ns1:addGroupMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:groupHandleArray><ns1:items>225</ns1:items></ns1:groupHandleArray>
</ns1:addGroupMembershipParam>

Reactie

Geen.

recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681