DocumentationDynamic Media Image Production System API

batchGetAssetPublishContexts

Last update: Wed Mar 09 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Returns the publish contexts for assets marked for publication.

Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
  • The user must have read access to return the assets.
  • All users have access to the shared company.

Parameters

Input (batchGetAssetPublishContextsParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
Handle to the company.
assetHandleArray
``types:HandleArray``
Yes
A list of assets you want to query for active (marked for publish) contexts.

Output (batchGetAssetPublishContextsReturn)

Name
Type
Required
Description
assetPublishContextsArray
types:assetPublishContextsArray
Yes
An array of publish contexts in which each asset is marked for publish.

Examples

Request

<batchGetAssetPublishContextsParam xmlns="http://www.scene7.com/IpsApi/xsd/2011-11-04">
  <companyHandle>c|301</companyHandle>
  <assetHandleArray>
    <items>a|27007</items>
    <items>a|27008</items>
  </assetHandleArray>
</batchGetAssetPublishContextsParam>

Response

<batchGetAssetPublishContextsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2011-11-04">
  <assetPublishContextsArray>
    <items>
      <assetHandle>a|27007</assetHandle>
      <publishContextArray>
        <items>
          <contextHandle>pc|3002</contextHandle>
          <contextName>ImageServing</contextName>
          <contextType>ImageServing</contextType>
        </items>
      </publishContextArray>
    </items>
    <items>
      <assetHandle>a|27008</assetHandle>
      <publishContextArray>
        <items>
          <contextHandle>pc|3004</contextHandle>
          <contextName>Video</contextName>
          <contextType>Video</contextType>
        </items>
        <items>
          <contextHandle>pc|3001</contextHandle>
          <contextName>ImageRendering</contextName>
          <contextType>ImageRendering</contextType>
        </items>
      </publishContextArray>
    </items>
  </assetPublishContextsArray>
</batchGetAssetPublishContextsReturn>
4e9b9d8c-5839-4215-aa35-01b652869681