Dovetail Seeker Documentation

Document Specifications API

Document Specifications are used to define which Dovetail/Clarify CRM data gets indexed by the indexing applications. This API exposes details about the document specifications used to create the Seeker search index.

Suggested Usages:

Allow search user interfaces to construct a dynamic search domain filter.

Search user interfaces can detect which custom fields present and available for sorting search results.

Stored custom field values can be retrieved and displayed along side search results.

Simple Example

Request:

GET /seeker/specifications/index

Response:

[{
  "Domain":"case",
  "FieldSpecifications":[{
    "Name":"part",
    "IsSortable":false,
    "IsStored":true
  },{
    "Name":"site",
    "IsSortable":false,
    "IsStored":true
  },{
    "Name":"site_objid",
    "IsSortable":false,
    "IsStored":true
  },{
    "Name":"contact",
    "IsSortable":false,
    "IsStored":true
  },{
    "Name":"contact_objid",
    "IsSortable":false,
    "IsStored":true
  },{
    "Name":"created",
    "IsSortable":false,
    "IsStored":true
  }]
}]

One domain specification is returned for each domain present in the search index. In the example above show a single domain present that has 6 custom fields. Note that this is the default case domain specification included with Dovetail Seeker.