Intralinks Developer Portal

Creates field definitions (custom field values) for the specified workspace.


Resource Location

POST /services/workspaces/fieldDefinitions


Authorization Type

HTTP Cookie ssoGlobalSessionID


Request Parameters

Name Description Required Example
method Intralinks call method. Must be set to CREATE Yes method=CREATE
workspaceId Integer identifier of the target exchange Yes &workspaceId=123789

Example Request

<?xml version="1.0" encoding="UTF-8"?>
<fieldDefinitionsRequest>
   <fieldDefinitionList>
      <fieldDefinition>
         <label>Expiry Date</label>
         <dataType>date</dataType>
         <required>F</required>
         <readOnly>F</readOnly>
         <customFieldType>DOCUMENT</customFieldType>
         <isActive>T</isActive>
         <displayOrder>1</displayOrder>
         <defaultValue>02/23/2009</defaultValue>
         <isActive>T</isActive>
         <childFieldDefinitionList>
            <fieldDefinition>
               <isActive>F</isActive>
               <customFieldPermissions>
                  <customFieldPermission>
                     <optionValues>
                        <value>firstValue</value>
                        <value>secondValue</value>
                        <value>thirdValue</value>
                     </optionValues>
                     <optionValues>
                        <optionValue>
                           <value>Pending</value>
                        </optionValue>
                     </optionValues>
                  </customFieldPermission>
               </customFieldPermissions>
            </fieldDefinition>
         </childFieldDefinitionList>
      </fieldDefinition>
   </fieldDefinitionList>
</fieldDefinitionsRequest>

Example Response

A successful response is code 202, and will include in the following XML.

<?xml version="1.0" encoding="UTF-8"?>
<fieldDefinitionsResponse>
   <status>
      <code>202</code>
      <message>Request completed fine, no errors</message>
   </status>
   <fieldDefinitionList>
      <fieldDefinition>
         <id>1232423393</id>
         <fieldId>1</fieldId>
         <label>Expiry Date</label>
         <dataType>date</dataType>
         <required>F</required>
         <isActive>T</isActive>
         <readOnly>F</readOnly>
         <customFieldType>DOCUMENT</customFieldType>
         <displayOrder>1</displayOrder>
         <defaultValue>02/23/2009</defaultValue>
         <searchFieldName>1232123</searchFieldName>
      </fieldDefinition>
      ...
   </fieldDefinitionList>
</fieldDefinitionsResponse>