Intralinks Developer Portal

Returns the configuration settings for a workspace based on the input parameters.


Resource Location

GET /v1/services/workspaces/workspaceSettings


Authorization Type

HTTP Cookie ssoGlobalSessionID


Request Parameters

Name Description Format Required Default Example
method Intralinks call method. Must be set to GET string yes none method=GET
workspaceID ID of the workspace that you want to work with. Long Yes ?workspaceId=12343
settingCategory Indicates the category of exchange settings for which setting details has to be retrieved. Allowed values:
DOCUMENTS
COREWORKSPACE
QA
String No settingCategory=COREWORKSPACE
settingType Indicates the exchange setting type. Full list below. String No settingType=DOC_PDF_PROTECTION

Setting Types

Setting Category Description Type Name
DOCUMENTS Save deleted documents DOC_SAVE_DELETED
Automatically version modified documents DOC_VERSIONING
Indexing DOC_ENABLE_INDEXING
Bulk Download DOC_BULK_DOWNLOAD_ENABLED
Hide document created/updated by info from reviewer role users DOC_HIDE_NAMES
Hide document created date/updated date from reviewer role users DOC_HIDE_DATES
Hide or show effective date for documents DOC_ENABLE_EFFECTIVE_DATE
Limited publisher LIMITED_PUBLISHER
Folder-level permissions FOLDER_LEVEL_PERMISSIONING
COREWORKSPACE Enable Document Content Search CORE_ENABLE_FULL_TEXT_SEARCH
Allow access by Intralinks Administrators CORE_RESTRICT_ADMIN_ACCESS
Geo specific mount point GEO_MOUNTPOINT
ALERT Enable multilingual email alerts CORE_ENABLE_MULTILINGUAL_ALERT
QA Q&A enabled QA_ENABLED
Q&A Question Limit QA_QUESTION_LIMIT
Q&A Freeze Category QA_FREEZE_CATEGORY


Example Request


Example Response

A successful response will include the following XML:

<?xml version="1.0" encoding="UTF-8"?>
<workspaceSettingsListResponse>
 <status>
    <code>200</code>
    <message>message</message>
  </status>
  <canUpdateFooterSplash>T</canUpdateFooterSplash>
  <workspaceSettings>
     <workspaceSetting>
     <typeName>DOC_PDF_PROTECTION</typeName>
     <description>Enable Document PDF Protection</description>
     <value>T</value>
     <readOnly>T</readOnly>
        <canSet>F</canSet>
     </workspaceSetting>
     <workspaceSetting>
    <typeName>CORE_RESTRICT_ADMIN_ACCESS</typeName>
     <description>Restrict admin access</description>
     <value>T</value>
     <readOnly>T</readOnly>
        <canSet>T</canSet>
     </workspaceSetting>
  </workspaceSettings>
  ........
</workspaceSettingsListResponse>


Response Fields

Element Description Data Type
typeName Exchange ID. Long
descirption Exchange setting description. String
value Exchange value setting. String
readOnly Indicates whether the setting is hidden (masked) Boolean
canSet Indicates whether the requesting user can set this setting.

The canSet element indicates whether the user retrieving the setting has permission to update it. Settings can be updated only by users with the Manager Plus, Hidden Manager Plus or Manager role. The element will always return false for users with any other role. For settings depend on another (parent) setting, canSet will have the same value that its parent setting has.
String