setCompanySettings

Sets various company-specific configuration values.

Syntax

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameters

Input (setCompanySettingsParam)

Name Type Required Description
*companyHandle* xsd:string Yes Company handle.
*overwriteMode* xsd:string No Asset overwrite mode.
*retainPublishState* xsd:boolean No Set to true to preserve the publish state when an asset is re-uploaded.
*defaultSourceProfileHandle* xsd:string No IccProfile asset to use as default source color profile.
*defaultDisplayProfileHandle* xsd:string No IccProfile asset to use as default display color profile.
*iptcExifMappingXsltHandle* xsd:string No XSL asset used for mapping IPTC and EXIF metadata to IPS metadata fields.
*xmpMappingXsltHandle* xsd:string No XSL asset used to map XMP metadata to IPS metadata fields.
*diskSpaceWarningMin* xsd:int No Minimum free disk space (in KB) available before a warning message is sent.
*emailTrashCleanupWarning* xsd:boolean No Set to true to send company administrators a notification whenever assets are emptied from trash.

Output (setCompanySettingsReturn)

The IPS API does not return a response for this operation.

Examples

This code sample sets a company’s configuration.

Request

<ns1:setCompanySettingsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <ns1:companyHandle>c|6</ns1:companyHandle>
   <ns1:overwriteMode>OverwriteFullName</ns1:overwriteMode>
   <ns1:retainPublishState>true</ns1:retainPublishState>
   <ns1:diskSpaceWarningMin>100000</ns1:diskSpaceWarningMin>
   <ns1:emailTrashCleanupWarning>true</ns1:emailTrashCleanupWarning>
</ns1:setCompanySettingsParam>

Response

None.

On this page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now