Intralinks Developer Portal

Returns a list of field definitions (custom field values) for the specified exchange.

 

Resource Location

GET /services/workspaces/fieldDefinitions

 

Authorization Type

HTTP Cookie ssoGlobalSessionID

 

Request Parameters

Name Description Required Example
method Intralinks call method. Must be set to GET Yes method=GET
xml XML Document that contains the parameters for the call Yes  
workspaceId Integer identifier of the target exchange Yes &workspaceId=123789
entityType Entity associated with the field descriptions:
DOCUMENT
WSGROUP
EXCHANGE
The default is DOCUMENT
No &entityType=DOCUMENT
parentFieldId ID for a parent custom field.

When a client specifies the parentFieldId, all child custom fields of the parent will be returned. Sometimes the unique identity of a parent field requires both parentFieldId and parentFieldValue to be specified. For example, if a client wants all child fields of a specific document type parent, then both parameters are required.

No &parentFieldId=1259943008
parentFieldValue The parent custom field value.

When a client specifies the parentFieldId, all child custom fields of the parent will be returned. Sometimes the unique identity of a parent field requires both parentFieldId and parentFieldValue to be specified. For example, if a client wants all child fields of a specific document type parent, then both parameters are required.

No &parentFieldValue="Adverse Drug Report"
includeIsInUse Flag to include the inUse element (and its value) for each custom field.

If includeIsInUse is set to T, an additional tag (inUse) indicating whether the custom field is in use will be sent in the response, as shown in the example below. Custom fields that are in use cannot be updated, if any custom fields fail to be updated, any remaining updates also will be rolled back.

No &includeIsInUse=T

 

Example Request

No XML is sent with the request

 

Example Response

A successful response is code 200, and will include the following XML:

<fieldDefinitionsResponse>
  <status>
    <code>200</code>
    <message>Request completed fine, no errors</message>
  </status>
  <fieldDefinitionList>
    <fieldDefinition>
      <id>2343393</id>
      <fieldId>1</fieldId>
      <label>Document Status</label>
      <dataType>option</dataType>
      <required>F</required>
      <readOnly>F</readOnly>
      <customFieldType>DOCUMENT</customFieldType>
      <isActive>T</isActive>
      <displayOrder>2</displayOrder>
      <searchFieldName>1232123</searchFieldName>
      <permission>CONTROL</permission>
      <customFieldPermissions>
        <customFieldPermission>
          <customFieldPermissionType>CONTROL</customFieldPermissionType>
          <workspaceRoleType>MANAGER_PLUS</workspaceRoleType>
        </customFieldPermission>
        <customFieldPermission>
          <customFieldPermissionType>CONTROL</customFieldPermissionType>
          <workspaceRoleType>MANAGER_LTD</workspaceRoleType>
        </customFieldPermission>
        <customFieldPermission>
          <customFieldPermissionType>CONTROL</customFieldPermissionType>
          <workspaceRoleType>REVIEWER_PLUS</workspaceRoleType>
        </customFieldPermission>
        <customFieldPermission>
          <customFieldPermissionType>CONTROL</customFieldPermissionType>
          <workspaceRoleType>HIDDEN_MANAGER_PLUS</workspaceRoleType>
        </customFieldPermission>
        <customFieldPermission>
          <customFieldPermissionType>CONTROL</customFieldPermissionType>
          <workspaceRoleType>PREVIEWER</workspaceRoleType>
        </customFieldPermission>
        <customFieldPermission>
          <customFieldPermissionType>CONTROL</customFieldPermissionType>
          <workspaceRoleType>MANAGER</workspaceRoleType>
        </customFieldPermission>
        <customFieldPermission>
          <customFieldPermissionType>CONTROL</customFieldPermissionType>
          <workspaceRoleType>PUBLISHER</workspaceRoleType>
        </customFieldPermission>
        <customFieldPermission>
          <customFieldPermissionType>CONTROL</customFieldPermissionType>
          <workspaceRoleType>PUBLISHER_PLUS</workspaceRoleType>
        </customFieldPermission>
        <customFieldPermission>
          <customFieldPermissionType>CONTROL</customFieldPermissionType>
          <workspaceRoleType>REVIEWER</workspaceRoleType>
        </customFieldPermission>
      </customFieldPermissions>
      <optionValues>
        <optionValue>
          <id>177441008</id>
          <sortOrder>1</sortOrder> 
          <value>Draft</value>
        </optionValue>
        <optionValue>
          <id>177442008</id>
          <sortOrder>2</sortOrder>
          <value>Final</value>
        </optionValue>
        <optionValue>
          <id>177443008</id>
          <sortOrder>3</sortOrder>
          <value>Active</value>
        </optionValue>
      </optionValues>
      <childFieldDefinitionList>
        <fieldDefinition>
          <id>12328888</id>
          <fieldId>1222777</fieldId>
          <parentFieldId>1</parentFieldId>
          <parentFieldValue>hold</parentFieldValue>
          <label>Child CF 1</label>
          <dataType>String</dataType>
          <required>F</required>
          <readOnly>F</readOnly>
          <customFieldType>DOCUMENT</customFieldType>
          <isActive>T</isActive>
          <displayOrder>1</displayOrder>
          <defaultValue>02/23/2009</defaultValue>
          <searchFieldName>12a32afb123</searchFieldName>
          <permission>CONTROL</permission>
          <customFieldPermissions>
            <customFieldPermission>
              <customFieldPermissionType>CONTROL</customFieldPermissionType>
              <workspaceRoleType>MANAGER_PLUS</workspaceRoleType>
            </customFieldPermission>
            <customFieldPermission>
              <customFieldPermissionType>CONTROL</customFieldPermissionType>
              <workspaceRoleType>MANAGER_LTD</workspaceRoleType>
            </customFieldPermission>
            <customFieldPermission>
              <customFieldPermissionType>CONTROL</customFieldPermissionType>
              <workspaceRoleType>REVIEWER_PLUS</workspaceRoleType>
            </customFieldPermission>
            <customFieldPermission>
              <customFieldPermissionType>CONTROL</customFieldPermissionType>
              <workspaceRoleType>HIDDEN_MANAGER_PLUS</workspaceRoleType>
            </customFieldPermission>
            <customFieldPermission>
              <customFieldPermissionType>CONTROL</customFieldPermissionType>
              <workspaceRoleType>PREVIEWER</workspaceRoleType>
            </customFieldPermission>
            <customFieldPermission>
              <customFieldPermissionType>CONTROL</customFieldPermissionType>
              <workspaceRoleType>MANAGER</workspaceRoleType>
            </customFieldPermission>
            <customFieldPermission>
              <customFieldPermissionType>CONTROL</customFieldPermissionType>
              <workspaceRoleType>PUBLISHER</workspaceRoleType>
            </customFieldPermission>
            <customFieldPermission>
              <customFieldPermissionType>CONTROL</customFieldPermissionType>
              <workspaceRoleType>PUBLISHER_PLUS</workspaceRoleType>
            </customFieldPermission>
            <customFieldPermission>
              <customFieldPermissionType>CONTROL</customFieldPermissionType>
              <workspaceRoleType>REVIEWER</workspaceRoleType>
            </customFieldPermission>
          </customFieldPermissions>
        </fieldDefinition>
      </childFieldDefinitionList>
    </fieldDefinition>
  </fieldDefinitionList>
</fieldDefinitionsResponse>

The following response is an example of a response returned for parentFieldId=1259943008 and parentFieldValue="Adverse Drug Report". In this variant of a fieldDefinitionsResponse, the parent custom field identified along with the associated child fields are returned.

<fieldDefinitionsResponse>
  <status>
      <code>200</code>
      <message>Request completed fine, no errors</message>
  </status>
  <fieldDefinitionList>
      <fieldDefinition>
          <childFieldDefinitionList>
              <fieldDefinition>
                  <customFieldPermissions>
                  ...
                  </customFieldPermissions>
                  <customFieldType>DOCUMENT</customFieldType>
                  <dataType>STRING</dataType>
                  <displayOrder>164</displayOrder>
                  <fieldId>1260106008</fieldId>
                  <id>1270255008</id>
                  <isActive>T</isActive>
                  <label>Assets / Compound Number</label>
                  <parentFieldId>1259943008</parentFieldId>
                  <parentFieldValue>Adverse Drug Report</parentFieldValue>
                  <permission>CONTROL</permission>
                  <readOnly>T</readOnly>
                  <required>F</required>
                  <templateId>36845008</templateId>
                  <workflowEnabled>F</workflowEnabled>
              </fieldDefinition>
              <fieldDefinition>
                  <customFieldPermissions>
                  ...
                  </customFieldPermissions>
                  <customFieldType>DOCUMENT</customFieldType>
                  <dataType>DATE</dataType>
                  <displayOrder>165</displayOrder>
                  <fieldId>1260107008</fieldId>
                  <id>1270256008</id>
                  <isActive>T</isActive>
                  <label>Date of Incident</label>
                  <parentFieldId>1259943008</parentFieldId>
                  <parentFieldValue>Adverse Drug Report</parentFieldValue>
                  <permission>CONTROL</permission>
                  <readOnly>T</readOnly>
                  <required>F</required>
                  <templateId>36846008</templateId>
                  <workflowEnabled>F</workflowEnabled>
              </fieldDefinition>               
          </childFieldDefinitionList>
          <customFieldPermissions>
          ...
          </customFieldPermissions>
          <customFieldType>DOCUMENT</customFieldType>
          <dataType>OPTIONS</dataType>
          <displayOrder>1</displayOrder>
          <fieldId>1259943008</fieldId>
          <id>1270092008</id>
          <isActive>T</isActive>
          <label>Document Type</label>
          <optionValues>
              <optionValue>
                  <id>2645979008</id>
                  <sortOrder>1</sortOrder>
                  <value>Adverse Drug Report</value>
              </optionValue>
              <optionValue>
                  <id>2645972008</id>
                 <sortOrder>2</sortOrder>
                  <value>Clinical Study Agreement</value>
              </optionValue>
              ...
          </optionValues>
          <permission>CONTROL</permission>
          <readOnly>T</readOnly>
          <required>T</required>
          <templateId>36682008</templateId>
          <workflowEnabled>T</workflowEnabled>
      </fieldDefinition>
  </fieldDefinitionList>
</fieldDefinitionsResponse>

 

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