getPublishContexts
Last update: August 31, 2023
- Topics:
- Dynamic Media Classic,SDK/API
CREATED FOR:
- Developer
- Admin
Syntax
Authorized User Types
IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser
- The user must have read access to return the assets.
- All users have access to the shared company.
Parameters
Input (getPublishContextsParam)
Name | Type | Required | Description |
---|---|---|---|
companyHandle | xsd:string | Yes | Handle to the company. |
contextType | xsd:string | No |
The type of publishing context that you want to return. Includes:
|
Output (getPublishContextsReturn)
Name | Type | Required | Description |
---|---|---|---|
publishContextArray | types:PublishContextArray | Yes | An array of publish contexts for a company, filtered by context type if necessary. |
Examples
Request
<getPublishContextsParam xmlns="http://www.scene7.com/IpsApi/xsd/2011-11-04">
<companyHandle>c|301</companyHandle>
</getPublishContextsParam>
Response
<getPublishContextsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<publishContextArray>
<items>
<contextHandle>pc|3001</contextHandle>
<contextName>ImageRendering</contextName>
<contextType>ImageRendering</contextType>
</items>
<items>
<contextHandle>pc|3002</contextHandle>
<contextName>ImageServing</contextName>
<contextType>ImageServing</contextType>
</items>
<items>
<contextHandle>pc|3003</contextHandle>
<contextName>ServerDirectory</contextName>
<contextType>ServerDirectory</contextType>
</items>
<items>
<contextHandle>pc|3004</contextHandle>
<contextName>Video</contextName>
<contextType>Video</contextType>
</items>
</publishContextArray>
</getPublishContextsReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681