Intralinks Developer Portal

Updates 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 workspace Yes &workspaceId=123789

Example Request

<fieldDefinitionsRequest>
    <fieldDefinitionList>
        <fieldDefinition>
            <id>1232423393</id>
            <fieldId>13232213</fieldId>
            <isActive>T</isActive>
            <customFieldPermissions>
              <customFieldPermission>
                <role>publisher</role>
                <permission>CONTROL</permission>
              <customFieldPermission>
              <customFieldPermission>
                <role>reviwer</role>
                <permission>SEE</permission>
             <customFieldPermission>
           </customFieldPermissions>
           <optionValues>
             <optionValue>
               <methodToPerform>ADD</methodToPerform>
               <id></id>
               <value>Pending</value>
             </optionValue>
           </optionValues>
        </fieldDefinition>
    </fieldDefinitionList>
</fieldDefinitionsRequest>

 

Example Response

A successful response is code 202, and will return the same result as a GET call. (The entire custom field heirarchy for the workspace will be returned).

 

XML Elements

Element Description
id The ID for the field. Used as the XML element name in entity data.

This is the custom field association ID, NOT the custom field definition ID (fieldId), which is associated with documents when custom fields are attached to a document.

searchFieldName Encoded name of the custom field used for searching. This field is used to build search requests.
fieldId The custom field definition ID attached to the document.
label Display label for this field.
dataType Identifies the type of data entered in the field. Valid values are:
DATE
STRING
NUMBER
OPTION
defaultValue The default value for the string.

These values depend upon the dataType. For DATA, STRING and NUMBER data types, a value appropriate for the data type. For OPTION, the value is numeric, indicating a particular option within a group of options.

required Identifies whether the field is required for creation or updates.
readOnly Identifies whether the field is read only.
customFieldType The entity associated with this custom field:
DOCUMENT
WSGROUP
EXCHANGE.
isActive Identifies whether the custom field is active.
isHidden Identifies whether the custom field is hidden.
displayOrder Identifies the order in which the fields are displayed on the screen.
validation Defines validation rules for data entry.
optionValues Allowed values for the Option data type.
parentFieldId The ID for the current field’s parent field. (Available only on child field definitions.)
parentFieldValue Displays the value assigned to the parent field. (Available only on child field definitions.)
childFieldDefinitionList Lists child field definitions (using fieldDefinition) that match the defined attributes structure
permission Identifies whether the specified user can see or control (modify) this custom field. One of the following:
SEE
CONTROL
customFieldPermissions
customFieldPermission
A group of custom field permissions for specific roles
customFieldPermissions/role The role associated with this custom field permission (standard exchange roles).
customFieldPermissions/customFieldPermissionType The permission associated with this custom field permission.
Allowed values:
HIDDEN
SEE
CONTROL

The following operations are considered "destructive edits" and require there to be no active workflows or naming conventions on the workspace:
Setting isActive to false
Changing the label
Setting requried to false
Setting readOnly to false
In order to determine whether these destructive edits are possible, the page-level security action "cflEdt" can be retrieved for the active exchange.

 

XML Elements

Element Description
id The ID for the field. Used as the XML element name in entity data.

This is the custom field association ID, NOT the custom field definition ID (fieldId), which is associated with documents when custom fields are attached to a document.

searchFieldName Encoded name of the custom field used for searching. This field is used to build search requests.
fieldId The custom field definition ID attached to the document.
label Display label for this field.
dataType Identifies the type of data entered in the field. Valid values are:
DATE
STRING
NUMBER
OPTION
defaultValue The default value for the string.

These values depend upon the dataType. For DATA, STRING and NUMBER data types, a value appropriate for the data type. For OPTION, the value is numeric, indicating a particular option within a group of options.

required Identifies whether the field is required for creation or updates.
readOnly Identifies whether the field is read only.
customFieldType The entity associated with this custom field:
DOCUMENT
WSGROUP
EXCHANGE.
isActive Identifies whether the custom field is active.
isHidden Identifies whether the custom field is hidden.
displayOrder Identifies the order in which the fields are displayed on the screen.
validation Defines validation rules for data entry.
optionValues Allowed values for the Option data type.
parentFieldId The ID for the current field’s parent field. (Available only on child field definitions.)
parentFieldValue Displays the value assigned to the parent field. (Available only on child field definitions.)
childFieldDefinitionList Lists child field definitions (using fieldDefinition) that match the defined attributes structure
permission Identifies whether the specified user can see or control (modify) this custom field. One of the following:
SEE
CONTROL
customFieldPermissions
customFieldPermission
A group of custom field permissions for specific roles
customFieldPermissions/role The role associated with this custom field permission (standard exchange roles).
customFieldPermissions/customFieldPermissionType The permission associated with this custom field permission.
Allowed values:
HIDDEN
SEE
CONTROL

Validation XML Elements

Element Description
maxSize Maximum length for a string
min Lowest number or earliest date accepted.
The value must be convertible to a valid number or date.
max Highest number or latest date accepted.
The value must be convertible to a valid number or date.

Options XML Elements

Element Description
id ID for the custom field option
value One of the allowed values for this option field.
At least one value element must be present in an optionValues structure.
methodToPerform Indicates which operation should be performed on custom field option.

Allowed values:
ADD
UPDATE
DELETE