Intralinks Developer Portal

The General Search API can be used to create a general purpose search.


Resource Location

POST /services/searches


Authorization Type

HTTP Cookie ssoGlobalSessionID


Request Parameters

Name Description Required Example
method Intralinks call method. Must be set to CREATE Yes method=CREATE
xml XML Document that contains the parameters for the call. This must be provided as a URL-Encoded XML String YES
workspaceId Integer identifier of the target exchange. Specify the workspaceId if you want to restrict the search to an entered workspace. Yes &workspaceId=12345
includeCustomFields Applies only to document search. Set equal to T to have custom fields included in results. No &includeCustomFields=T
entityType The kind of entity for which to search.

Valid values are:
DOCUMENTFOLDER
GROUPUSERWORKINGSET
TASK
COMMUNITY
Yes
sortOrder/fieldName The name of the field by which to sort the API response output.
searchContents If set to T this will search file contents as well as file metadata. No <searchContents>T</searchContents>


Example Request

curl -k -X POST -b "ssoGlobalSessionID=SESSION_ID"
-d "xml=XML_REQUEST" 
"https://test-api.intralinks.com/services/searches?method=CREATE&client=YOUR_CLIENT_ID"”


Example XML request

<?xml version="1.0" encoding="UTF-8"?>
<searchRequest>
   <searchContents>T</searchContents>
   <entityType>DOCUMENTFOLDER</entityType>
   <searchSubType>DEFAULT</searchSubType>
   <resourceId>12345</resourceId>
   <!-- Not required for all entity types -->
   <resultTypes>
      <type>user</type>
   </resultTypes>
   <term>merger plans</term>
   <sortOrder>
      <fieldName>Title</fieldName>
      <direction>ASCENDING</direction>
   </sortOrder>
   <searchFields>
      <field>
         <name>title</name>
         <term>bob</term>
      </field>
      <field>
         <name>author</name>
         <term>bob</term>
      </field>
      <field>
         <name>text</name>
         <term>bob</term>
      </field>
      <field>
         <name>note</name>
         <term>bob</term>
      </field>
      <field>
         <name>tag</name>
         <term>smith</term>
      </field>
      <field>
         <name>effective_date</name>
         <term>*</term>
         <term>29023920923</term>
         <type>DATERANGE</type>
      </field>
      <field>
         <name>effective_date</name>
         <term>29023920923</term>
         <term>*</term>
         <type>DATERANGE</type>
      </field>
      <field>
         <name>effective_date</name>
         <term>29023920923</term>
         <term>29023920923</term>
         <type>DATERANGE</type>
      </field>
      <field>
         <name>file_size</name>
         <term>29023920923</term>
         <term>29023920923</term>
         <type>NUMBERRANGE</type>
      </field>
      <!-- Task Search Filter Criteria Start -->
      <field>
         <!-- Task_Assigned_To_User -->
         <name>user_id</name>
         <term>204001</term>
         <term>203991</term>
         <term>203981</term>
      </field>
      <field>
         <!-- Task_Assigned_To_Group -->
         <name>group_id</name>
         <term>231741</term>
         <term>232571</term>
         <term>232181</term>
      </field>
      <field>
         <!-- Task, BPI or RecommendUser for given workspaces-->
         <name>workspace_id</name>
         <term>118031</term>
         <term>117781</term>
      </field>
      <field>
         <!-- BPI initiator id -->
         <name>initiator_id</name>
         <term>203921</term>
         <term>203931</term>
      </field>
      <field>
         <!-- BPI initiator group id -->
         <name>initiator_group_id</name>
         <term>232151</term>
         <term>232141</term>
      </field>
      <field>
         <!-- BPI created date -->
         <name>created_date</name>
         <type>dateRange</type>
         <term>1259625600000</term>
         <term>1262217600000</term>
      </field>
      <!-- Main Search Term Start -->
      <field>
         <!-- Task, BPI or RecommendUser ws name -->
         <name>workspace_name</name>
         <term>ws name 1</term>
      </field>
      <field>
         <!-- BPI bus_proc_def_name -->
         <name>bus_proc_def_name</name>
         <term>bpd name1</term>
      </field>
      <field>
         <!-- BPI bus_proc_name -->
         <name>bus_proc_name</name>
         <term>bp name1</term>
      </field>
      <field>
         <!-- BPI bus_proc_inst_name -->
         <name>bus_proc_inst_name</name>
         <term>bpi name1</term>
      </field>
      <field>
         <!-- BPI initiator_full_name -->
         <name>initiator_full_name</name>
         <term>initiator full name1</term>
      </field>
      <field>
         <!-- BPI initiator_group_list -->
         <name>initiator_group_list</name>
         <term>group 1</term>
      </field>
      <field>
         <!-- owner user id -->
         <name>owner_user_id</name>
         <term>2876071</term>
         <!-- Should be only one user id
at a time-->
      </field>
      <field>
         <!-- owner group id -->
         <name>owner_group_id</name>
         <term>2655681</term>
         <term>345221</term>
         <!-- Multiple groups ids can be
passed at a time -->
      </field>
      <!-- Main Search Term End -->
      <!-- Task Search Filter Criteria End -->
   </searchFields>
   <checkWorkspacesFiltered>T</checkWorkspacesFiltered>
   <facets>
      <facet>
         <name>Organization</name>
         <term>Intralinks</term>
      </facet>
   </facets>
   <!-- Only used by saved searches to save meta data -->
   <metadata>
      <field>
         <id>12345</id>
         <name>arc workspace</name>
         <type>workspace</type>
      </field>
   </metadata>
</searchRequest>


Example Response

The response is a list of items matching the search criteria. If no match was found, a list with no items is returned.

<?xml version="1.0" encoding="UTF-8"?>
<searchResultItemList>
   <isMaxSearchResultReached>T</isMaxSearchResultReached>
   <itemList>
      <searchResultItem>
         <score>99</score>
         <excerpt>Mingus was born a happy boy in Mingus,OH</excerpt>
         <document>....</document>
      </searchResultItem>
      <searchResultItem>
         <score>75</score>
         <excerpt>well know to Mingus, and</excerpt>
         <folder>....</folder>
      </searchResultItem>
      <searchResultItem>
         <score>99</score>
         <user>....</user>
      </searchResultItem>
      <searchResultItem>
         <score>99</score>
         <workspaceGroup>....</workspaceGroup>
      </searchResultItem>
      <searchResultItem>
         <score>12</score>
         <binder>...</binder>
      </searchResultItem>
   </itemList>
   <facets>
      <facet>
         <name>Organization</name>
         <facetDetail>
            <label>Intralinks</label>
            <count>100</count>
         </facetDetail>
      </facet>
   </facets>
   <suggest>finance</suggest>
   <workspacesFiltered>T</workspacesFiltered>
   <workspacesFilteredCount>2</workspacesFilteredCount>
</searchResultItemList>