Show Menu
TOPICS×

getProperty

Gets string values of system properties related to Image Portal.
Supported system properties include:
  • IpsVersion : IPS version number.
  • IpsImageServerUrl : Full, external URL prefix for the IPS Image Server.
  • VideoRootUrl
  • swfRootUrl
  • SvgRenderRootUrl : URL prefix for rendering SVG assets.
  • SvgRenderEnabled : True if SVG assets can be rendered by SvgRenderRootUrl .
  • UploadPostMaxFileSize : Maximum size (in bytes) of file data allowed in an upload POST. The system rejects files larger than the maximum limit.

Authorized User Types

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

Parameters

Input (getPropertyParam)
Name
Type
Required
Description
* name *
xsd:string
Yes
The name of the property to get.
Output (getPropertyReturn)
Name
Type
Required
Description
* value *
xsd:string
Yes
The property value.

Examples

This code sample uses an IPS Properties string constant to return a specific value. In this example, the IPS property is the version of the IPS server.
Request
<ns1:getPropertyParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:name>IpsVersion</ns1:name>
</ns1:getPropertyParam>

Response
<getPropertyReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <value>3.8.0</value>
</getPropertyReturn>