Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Excerpt

Smart Filters (called Fingerprints in the API for legacy reasons) enable concept search over Items in a project.

Methods

Table of Contents
outlinetrue
excludeMethods

...

List Fingerprints

GET https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/fingerprints

...

Create Unnamed Fingerprint

POST https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/fingerprint/{string: type}/{string: type_id}

...

Get Fingerprint

GET https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/fingerprint/{string: type}/{string: type_id}/{string: name}

...

Create Named Fingerprint

POST https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/fingerprint/{string: type}/{string: type_id}/{string: name}

...

Update Fingerprint

PUT https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/fingerprint/{string: type}/{string: type_id}/{string: name}

...

Delete Fingerprint

DELETE https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/fingerprint/{string: type}/{string: type_id}/{string: name}

...

Copy Fingerprint

POST https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/fingerprint/{string: type}/{string: type_id}/{string: name}/copy

...

Move Fingerprint

POST https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/fingerprint/{string: type}/{string: type_id}/{string: name}/move

...

Change Fingerprint Locking

PUT https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/fingerprint/{string: type}/{string: type_id}/{string: name}/protection

...

Validate Fingerprint

POST https://topicsquirro-api.squirro.comendpoint/api/topic/v0/fingerprint/validate

Validates a fingerprint without saving. This is useful when providing an editing interface for the manual fingerprint to give the user some feedback.

...

Train from Text

POST https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/fingerprint/{string: type}/{string: type_id}/content

...

Update Training from Content

POST https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/fingerprint/{string: type}/{string: type_id}/content/{string: record_id}

...

Delete Training Content

DELETE https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/fingerprint/{string: type}/{string: type_id}/content/{string: record_id}

...

Train from Item

POST https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/fingerprint/{string: type}/{string: type_id}/items

...

Delete Training Item

DELETE https://topicsquirro-api.squirro.comendpoint/api/topic/v0/(string: tenant)/fingerprint/{string: type}/{string: type_id}/items/{string: record_id}

...